Commit Graph

492 Commits

Author SHA1 Message Date
Himanshu Mishra 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
Fredrik Adelöw 22f7755d29 docs: skip prettier for long metadata lines (#3311) 2020-11-17 13:26:24 +01:00
Himanshu Mishra d1bfe7b71f Docs: Add TechDocs survey on docs site 2020-11-17 13:19:28 +01:00
Fredrik Adelöw 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
Patrik Oldsberg 0b2ad28532 microsite: new email 2020-11-16 11:00:19 +01:00
Adam Harvey 1b11e7b708 Fix broken link from Docs site to Code of Conduct (#3284)
* Fix link

* Add clarifications
2020-11-13 08:52:27 +01:00
Adam Harvey a51d475899 Standarize code fence and wording tweaks (#3285) 2020-11-13 08:51:11 +01:00
Andrés Torres 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
David Tuite eecf08e3f7 Update Node LTS in Getting Started docs (#3254)
I've tested and the v14 [Fermium LTS](https://nodejs.org/en/about/releases/) works fine.
2020-11-06 00:32:13 +01:00
David Tuite 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
David Tuite 85379551e0 Add CircleCI to the Well Known Annotations (#3082) 2020-11-05 22:48:28 +01:00
Fredrik Adelöw e1a92d0b5d docs: clarify current state of databases (#3250) 2020-11-05 22:41:55 +01:00
Himanshu Mishra 5dd4a338db Docs update of techdocs-cli URL 2020-11-05 15:29:27 +01:00
Himanshu Mishra 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
Abhishek Jakhar 8683b1af38 fix: tutorials markdown (#3244) 2020-11-05 13:04:42 +01:00
Fredrik Adelöw 596a3b8d14 docs: features/software-catalog/external-integrations (#3231) 2020-11-04 20:01:03 +01:00
Patrik Oldsberg faf47e8f91 Merge pull request #3203 from adamdmharvey/doc-updates-2nov
chore(docs): Minor documentation updates
2020-11-04 18:53:33 +01:00
Himanshu Mishra bd0ae748c0 Merge pull request #3172 from backstage/orkohunter/update-techdocs-contrib-docs 2020-11-04 11:29:13 +01:00
Adam Harvey 1fddc73322 Additional folder rename fix 2020-11-03 22:03:53 -05:00
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