a2b83df986
Merge pull request #3316 from backstage/orkohunter/add-techdocs-survey
...
TechDocs Survey: Add link to form on docs site
2020-11-17 13:46:54 +01:00
22f7755d29
docs: skip prettier for long metadata lines ( #3311 )
2020-11-17 13:26:24 +01:00
d1bfe7b71f
Docs: Add TechDocs survey on docs site
2020-11-17 13:19:28 +01:00
3ad6320029
docs: catalog - extending the model, and relations ( #3291 )
...
* docs: catalog - extending the model, and relations
* Address comments
2020-11-16 16:45:46 +01:00
39eef81349
fix: link to examples in Catalog docs ( #3271 )
...
Fix reference to artist-lookup-component.yaml path in Catalog docs, the new folder structure is missing
2020-11-10 12:12:17 +01:00
3b02444c12
Fix reference to Catalog path in overview docs ( #3255 )
...
While you do end up on the catalog if you visit `/`, the browser URL is actually `/catalog`.
2020-11-05 23:10:45 +01:00
85379551e0
Add CircleCI to the Well Known Annotations ( #3082 )
2020-11-05 22:48:28 +01:00
5dd4a338db
Docs update of techdocs-cli URL
2020-11-05 15:29:27 +01:00
47a611f115
TechDocs: Remove techdocs-container package from mono-repo ( #3230 )
...
* Move techdocs-container package to backstage/techdocs-container
* Clean up codeowners
* Remove unnecessary GitHub CI workflow
* Modify path in docs for techdocs-container
* Fix techdocs-cli URL
* Remove techdocs packages from docs/support/packages
2020-11-05 14:58:48 +01:00
596a3b8d14
docs: features/software-catalog/external-integrations ( #3231 )
2020-11-04 20:01:03 +01:00
bd0ae748c0
Merge pull request #3172 from backstage/orkohunter/update-techdocs-contrib-docs
2020-11-04 11:29:13 +01:00
d5c74f0415
Merge pull request #3216 from backstage/orkohunter/remove-techdocs-core-from-mono-repo
2020-11-03 15:51:22 +01:00
878eb60958
TechDocs: Update repo URL in documentation:
2020-11-03 11:49:01 +01:00
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
474bb5b57f
rewrite other references to spotify/backstage and sorrounding things
2020-11-03 11:39:27 +01:00
af141c0766
rewrite repo location urls
2020-11-03 11:03:49 +01:00
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
6018855f34
TechDocs: Add caveat around Markdown version
2020-10-30 10:28:31 +01:00
da0a79c3b8
feat: add sonarqube plugin ( #3160 )
2020-10-30 09:52:39 +01:00
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
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
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
7c28026ae0
docs: update scaffolder-backend installation docs
2020-10-26 23:34:25 +01:00
b173dacb46
Merge pull request #3087 from adamdmharvey/doc-clarifications
...
Clarifications in documentation
2020-10-26 14:56:08 +01:00
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
15ca9fe630
Clarify plural and product capitalization
2020-10-25 23:22:38 -04:00
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
06df0eba4c
Update V.2 in TechDocs Roadmap ( #3021 )
...
* Update V.2 in TechDocs Roadmap
* prettier
2020-10-22 16:10:37 +02:00
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
d4f221bee2
Update techdocs url to the new default
2020-10-14 19:26:58 +08:00
3727322ecd
Clarify catalog info YAML, TechDocs ( #2882 )
...
* Add note about catalog-info.yaml convention to format docs.
* Improve TechDocs Create & Publish Docs:
- Clarify the two paths to getting started
- Clarify `catalog-info.yaml` / component registration
- Minor grammar cleanup
* Correct link to software catalog overview
2020-10-14 09:58:21 +02:00
c6d1f4846f
Merge pull request #2803 from SDA-SE/feat/remove-api-annotation
...
feat: remove the backstage.io/definition-at-location annotation
2020-10-08 16:25:31 +02:00
e6b00e3af9
feat: remove the backstage.io/definition-at-location annotation
...
The annotation was superseded by the placeholder processor.
2020-10-08 15:50:16 +02:00
f05e4b9608
re: make consistent environment variables
...
GITHUB_PRIVATE_TOKEN & GITHUB_ACCESS_TOKEN => GITHUB_TOKEN
GITLAB_PRIVATE_TOKEN, GITLAB_ACCESS_TOKEN & SCAFFOLDER_GITLAB_PRIVATE_TOKEN => GITLAB_TOKEN
AZURE_PRIVATE_TOKEN => AZURE_TOKEN
GHE_PRIVATE_TOKEN => GHE_TOKEN
2020-10-08 10:34:06 +05:30
b9c8062c08
feat(catalog): add an ldap processor
2020-10-05 14:59:11 +02:00
34eb3a13c8
Merge pull request #2741 from spotify/rugvip/short
...
config-loader: add support for new short-form secret syntax
2020-10-05 13:30:04 +02:00
86e5c629de
Merge pull request #2665 from spotify/rugvip/reading
...
backend-common: add new common UrlReader to use for reading remote data
2020-10-05 11:23:29 +02:00
e986dffce6
fix: remove duplicate in docs ( #2744 )
...
* Update extending-the-model.md
* Prettier fix
2020-10-05 08:43:32 +02:00
6775deef9b
update docs and examples to use shorter config secret syntax
2020-10-04 16:51:00 +02:00
d0c8f72a66
docs/features/software-catalog: repurpose github processor docs as initial docs for integrations
2020-10-03 19:32:39 +02:00
238715aac2
config,docs: switch to using url location type
2020-10-03 11:55:23 +02:00
f816a54da2
docs: fix a minor typo ( #2718 )
2020-10-02 11:31:19 +02:00
5c6a0356c0
feat: TechDocs - Add vale linter to check words quality in md files. ( #2631 )
...
* fix(docs): typos which were reflacted from vale linter's command
* feat: Implement Vale linter (#2031 )
Initialize .vale.ini file
Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules
Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt
Add steps to github workflow 'master' to check docs quality
* chore: Separate workflow for quality checking
* chore: Added 'shx' dev dependency to support grep command in cross platform
* feat: Add script to operate same quality check process on different platform
* ignore: remove lint:docs from lint-stages which was added for experiment purpose
* fix: check-all-files on push event & check-changed-files on pull_request event
* chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request
* fix: use spawnSync to solve 'The command line is too long.' error
* fix: github workflow syntax
* fix: prettier error
* chore: add vale command directly to lint-staged
* chore: use shebang for easy access
* fix: windows script issue & remove shebang
* chore: Add shebang flag
* chore: better error message related to vale
* chore: mention vale linter in documentation
* fix: spelling errors & add keywords to vocab.txt
2020-10-02 07:20:47 +02:00
73440c7d9a
techdocs-milestones-update ( #2705 )
2020-10-01 17:39:05 +02:00
abd4119726
Update docs/features/techdocs/concepts.md
2020-10-01 11:49:59 +02:00
c8f8105c9c
prettier
2020-10-01 11:49:06 +02:00
4bb947137c
Update the publisher section
2020-10-01 11:45:44 +02:00
5dff92ca11
Run prettier on doc files
2020-10-01 08:54:14 +02:00
d0bfdf8ee5
techdocs: make some small improvements to faq
...
Made some small improvements to the FAQ. These include using the correct way to write RST and AsciiDoc, a link to the MKDocs Material Theme repo and some small style/grammar changes to the text about file formats.
2020-10-01 08:28:59 +02:00
4d61a10c98
chore: more tests and docs for github-org
2020-09-30 16:12:23 +02:00
Himanshu Mishra