Commit Graph

523 Commits

Author SHA1 Message Date
Patrik Oldsberg 9bf610b109 docs/api: fix link in utility APIs 2020-11-03 17:41:03 +01:00
Himanshu Mishra d5c74f0415 Merge pull request #3216 from backstage/orkohunter/remove-techdocs-core-from-mono-repo 2020-11-03 15:51:22 +01:00
Himanshu Mishra 878eb60958 TechDocs: Update repo URL in documentation: 2020-11-03 11:49:01 +01:00
Himanshu Mishra b8e67816c9 Remove mkdocs-techdocs-core from backstage mono-repo
New home: https://github.com/backstage/mkdocs-techdocs-core
2020-11-03 11:45:43 +01:00
Patrik Oldsberg 474bb5b57f rewrite other references to spotify/backstage and sorrounding things 2020-11-03 11:39:27 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Adam Harvey 9a3786309f Remove extraneous footer 2020-11-02 12:29:47 -05:00
Adam Harvey 8a49798341 Link to baking, update chapter header, remove old footer 2020-11-02 12:29:34 -05:00
Adam Harvey 4a5fcc0e01 Fix wording 2020-11-02 12:28:28 -05:00
Patrik Oldsberg 9e269db39b Merge pull request #3150 from spotify/rugvip/docs
docgen: add support for picking up the type from the declaration instead of initialization
2020-11-02 16:57:32 +01:00
Patrik Oldsberg bb400beea0 docs: regenerate api reference docs 2020-11-02 16:34:02 +01:00
Patrik Oldsberg ed3ff8f8e3 docs: moved verify-links to scripts 2020-11-01 13:25:38 +01:00
Patrik Oldsberg 743cc1f352 docs/verify-links: validate links to docs from other parts of the microsite 2020-11-01 13:24:22 +01:00
Oliver Sand 678f0309dd Merge pull request #3013 from SDA-SE/dry-run-experiment
Allow to dry run the register component operation
2020-10-30 16:50:08 +01:00
Himanshu Mishra 6018855f34 TechDocs: Add caveat around Markdown version 2020-10-30 10:28:31 +01:00
Dominik Henneke da0a79c3b8 feat: add sonarqube plugin (#3160) 2020-10-30 09:52:39 +01:00
Himanshu Mishra efff67c205 TechDocs: Update docs around docker-in-docker installation
Fix python package name to mkdocs-techdocs-core
Refer to the original Dockerfile where users can seek inspiration from
2020-10-30 09:49:53 +01:00
Adam Harvey 21ba4d38a0 (docs) Clarifications to documentation & UI chapter rename (#3159)
* Minor wording tweaks

* Rename section
2020-10-29 23:00:56 +01:00
Oliver Sand 948052cbb4 feat: add ability to dry run adding a new location
The location is now added in a transaction and afterwards rolled back. This allows users to dry run this operation to see if there entity has issues. This is probably done my automated tools.
2020-10-29 20:11:38 +01:00
Patrik Oldsberg bda622c223 Merge pull request #3149 from spotify/rugvip/ff
core-api: refactor and slim down the FeatureFlagsApi
2020-10-29 16:58:52 +01:00
Vividh Chandna fa56f46158 fix: Update tags validation message & documentation (#3145)
* Update dns label validation message to match regex pattern

* Update documentation for tags validation & examples

* Add changeset
2020-10-29 16:58:18 +01:00
Patrik Oldsberg b1b3f094f1 docs: tweak feature-flags docs 2020-10-29 15:51:54 +01:00
Patrik Oldsberg 471b15aa18 docs: update feature flag docs 2020-10-28 22:10:23 +01:00
Patrik Oldsberg e64fc519b8 core-api: remove FeatureFlagName type 2020-10-28 16:49:09 +01:00
Patrik Oldsberg 7c28026ae0 docs: update scaffolder-backend installation docs 2020-10-26 23:34:25 +01:00
Ben Lambert b173dacb46 Merge pull request #3087 from adamdmharvey/doc-clarifications
Clarifications in documentation
2020-10-26 14:56:08 +01:00
Harvey 2e04225056 Prettier fix for line length 2020-10-26 09:49:54 -04:00
Adrian Ke Chongyang 31ba976ea8 edit techdocs documentation (#3058)
* edit techdocs documentation

* Update docs/features/techdocs/creating-and-publishing.md

Co-authored-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
Co-authored-by: Emma Indal <emma.indahl@gmail.com>
2020-10-26 08:56:55 +01:00
Harvey 5010bf5fe0 Clarify sidebars editing 2020-10-26 00:07:12 -04:00
Harvey ac8307c987 Fix typo 2020-10-26 00:03:59 -04:00
Harvey f2318f0c70 Proper case app name 2020-10-26 00:03:43 -04:00
Harvey dd63af176f Standardize bullets 2020-10-26 00:03:24 -04:00
Harvey fc3e1118c8 Fix API Filenames in Examples 2020-10-26 00:03:05 -04:00
Harvey 914111bb87 Hyphenate 2020-10-26 00:02:41 -04:00
Harvey 600dfe79d9 Product names, bullets, wording 2020-10-26 00:02:22 -04:00
Harvey 2e48d035ff Capitlize product name 2020-10-25 23:27:03 -04:00
Harvey 8e2f88e965 Capitalize Docker 2020-10-25 23:26:15 -04:00
Harvey 024173b0ce Reword and code type 2020-10-25 23:25:52 -04:00
Harvey 608236d0bb Align 2020-10-25 23:25:02 -04:00
Harvey 15ca9fe630 Clarify plural and product capitalization 2020-10-25 23:22:38 -04:00
Adam Harvey c6c54b1b3a Clarifications to software template documentation (#3070)
* Clarify scaffolders

* Tweak preparer

* Template clarifications

* Minor wording for clarity

* Change wording
2020-10-23 23:20:30 +02:00
Adam Harvey a06164da24 Documentation editorial review (#3055)
* Fix case and link

* Align product/vendor case

* Reword for readability

* YAML Case

* Align product names

* Align product and acronym case

* Remove here link and product naming

* Align Node.js naming

* Align product names

* Fix wording
2020-10-23 08:01:07 +02:00
Patrik Oldsberg bc9f536545 Merge pull request #2994 from spotify/rugvip/conflagrate
config-loader: switch to using --config options to load in config
2020-10-22 18:01:21 +02:00
Emma Indal 06df0eba4c Update V.2 in TechDocs Roadmap (#3021)
* Update V.2 in TechDocs Roadmap

* prettier
2020-10-22 16:10:37 +02:00
Patrik Oldsberg c2ea3cd26a docs: updated to reflect new --config flags 2020-10-22 10:52:07 +02:00
Patrik Oldsberg 3dda28f908 Merge pull request #2954 from mplesec/issue/2935/update-docs-re-npm-config-flag
docs: update docs regarding npm config ignore-scripts flag
2020-10-18 19:24:15 +02:00
Matic Plešec edeb5e45a3 Update docs regarding npm config ignore-scripts flag 2020-10-18 18:36:05 +02:00
Eduardo Apolinario c3113d1d39 Fix Core Features configuration id (#2948)
The current configuration id is pointing to an inexistent place. This PR fixes the name of the configuration node in sidebars.json.
2020-10-18 08:13:06 +02:00
Stefan Ålund 4df45e0083 (docs) Add Helm charts, cleanup (#2944)
* (docs) Add Helm charts, cleanup

* (docs) Add Helm charts, cleanup
2020-10-17 20:54:47 +02:00
Patrik Oldsberg 2d15cfb1a4 docs/getting-started: added some minimal docs for k8s deployment, referencing contrib example 2020-10-17 15:23:17 +02:00