Commit Graph

233 Commits

Author SHA1 Message Date
Jesse Alan Johnson 314eeb31d7 documentation update (#2147) 2020-08-28 17:57:04 +02:00
Fredrik Adelöw 9a64135bf7 move docs to the microsite 2020-08-28 14:36:13 +02:00
Emma Indal cd3dde5af6 add techdocs big picture to docs (#2153) 2020-08-28 11:56:22 +02:00
Stefan Ålund a8edb19f61 [Docs] Various fixes (#2136)
* [Docs] Various fixes

* More fixes

* Fix ADRs

* Typo
2020-08-27 13:27:22 +02:00
Emma Indal 2bb585f4fe TechDocs: add note to docs about limitations to the scaffolder (#2134)
* add warning to docs about limitations to the scaffolder

* Update docs/features/techdocs/creating-and-publishing.md
2020-08-27 13:15:09 +02:00
Sebastian Qvarfordt 0b2f787699 Updated docs for techdocs plugin (#2127)
* Updated docs for techdocs plugin

* Error in example comment

* Update plugins/techdocs/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update plugins/techdocs/src/reader/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update plugins/techdocs/src/reader/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update plugins/techdocs/src/reader/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update link to transformers doc to point to reader doc for now

Co-authored-by: Emma Indal <emmai@spotify.com>
2020-08-27 09:52:49 +02:00
Stefan Ålund 9cda29cd13 [microsite] Add edit button to docs (#2126) 2020-08-26 16:17:40 +02:00
Emma Indal 40de8e03d4 TechDocs: update techdocs docs (#2105)
* docs(techdocs): update getting started docs

* docs(techdocs): update text and link to version

* fix docs link

* fix docs link

* Update docs/features/techdocs/getting-started.md

* update creating and publishing docs
2020-08-25 16:43:14 +02:00
Emma Indal edab8b2ad8 fix(template tags): fixes issues with tags specified with uppercase (#2049)
* fix(template tags): fixes issues with tags specified with uppercase

* adds new validator for metadata tags

* fix(template tags): change tags to be lowercase

* fix(template tags docs): update docs to include lowercased tags

* fix(validator): change back to using isValidDnsLabel for tags

* fix(software catalog docs): use lowercase tags in docs
2020-08-24 17:01:27 +02:00
Stefan Ålund 889e1fd4bb Docs: strategies for adopting Backstage (#2092)
* Adopting guidelines

* More updates

* Tactics

* Add metrics

* Add MTTR
2020-08-24 16:37:51 +02:00
Marc Bruggmann 9bacbf14cb Update the system model to focus more on the core entities. (#2011)
* Update the system model to focus more on the core entities.

Now that we have a way of labeling and annotating catalogue
entities, we can focus the system model more on the entities
themselves. I believe that also makes more sense as a model that
is shared across many companies - it's easier to standardize on
the core entities, and leave some room to implement further
abstraction or categories to individual implementations.

* Re-add system and domain conepts.
2020-08-24 15:12:33 +02:00
Paul Pacheco 9414db5ee7 show how to use config when setting up api (#2075)
Most API will require some configuration.

So it would be more useful to show an example where the config is available when the API's are being wired up
2020-08-21 22:38:12 +02:00
Stefan Ålund c6c3c94c18 Camelcase GitHub and GitLab (#2034)
* Camelcase GitHub and GitLab

* GitLab

* Code GitLab

* GitHub in code

* Fix auth naming

* Update docs/features/software-templates/adding-templates.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

* Update docs/features/software-templates/extending/create-your-own-preparer.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>
2020-08-21 14:48:16 +02:00
Kat Zhou 27fedbc0d7 Merge pull request #2060 from spotify/katz95-patch-2
Update design.md with new header and some text edits
2020-08-21 10:16:11 +02:00
Kat Zhou a291f2972c Update design.md 2020-08-21 09:47:50 +02:00
Kat Zhou d63f777ee0 new design header for design documentation 2020-08-21 09:46:02 +02:00
Fredrik Adelöw 89a0a2fc7b docs: write call-existing-api.md 2020-08-20 21:21:30 +02:00
Stefan Ålund 07bc5db026 Tweak roadmap (#2035)
* Tweak roadmap

* Update roadmap.md

* Review comments
2020-08-20 08:34:05 +02:00
Stefan Ålund 9568848b54 Link to marketplace issue from roadmap (#2010)
* Link to marketplace issue from roadmap

* Update roadmap.md

* Update roadmap.md

* Update roadmap.md
2020-08-19 12:23:42 +02:00
Oliver Sand 86eac5b458 feat(catalog): add tags to entity metadata
This add a field tags to the entity metadata to specifiy a user defined classifications.

Closes #1997
2020-08-18 22:14:36 +02:00
Fredrik Adelöw 38e185b2be docs(auth-backend): some minor tweaks (#1989) 2020-08-18 15:50:43 +02:00
Stefan Ålund 3a6f4415eb [Docs] Detailed roadmap and vision (#1991)
* [Docs] Update roadmap and vision

* Add shield to roadmap

* Update roadmap.md

* Link to .io in main README

* Fix verify links?
2020-08-18 10:52:56 +02:00
Govind 1aac6f1fb3 Add documentation explaining authentication in the backend (#1963)
* Add documentation explaining authentication in the backend

* Link newly added document to mkdocs and app documentation

Co-authored-by: Govindarajan Nagarajan <govindarajan.nagarajan@zalando.de>
2020-08-17 12:39:51 +02:00
Emma Indal 8d4e14e1c5 Update versions in upcoming features 2020-08-14 15:07:03 +02:00
Patrik Oldsberg 7c4307d1ee docs: update storybook url 2020-08-14 09:20:09 +02:00
Patrik Oldsberg b4959667af docs: fix broken links 2020-08-13 18:51:23 +02:00
Patrik Oldsberg 8ac58ad988 docs/verify-links: update to disallow path-absolute doc links 2020-08-13 18:49:31 +02:00
Patrik Oldsberg d0ce78e0f4 Merge pull request #1944 from spotify/Rugvip-patch-2
CHANGELOG: add changes up until 52a3c6
2020-08-13 17:21:06 +02:00
Ivan Shmidt c6655b1e73 fix: remove old link 2020-08-13 15:21:08 +02:00
Ivan Shmidt 6e8cf4651e Merge branch 'master' of github.com:spotify/backstage into mob/docusaurus-structure 2020-08-13 14:55:25 +02:00
Patrik Oldsberg ec25fbdcdd Merge pull request #1907 from spotify/mob/installation
docs/features: add installation docs for software-catalog and software-templates
2020-08-13 14:19:07 +02:00
Fredrik Adelöw 638526bad8 Merge pull request #1941 from Fox32/patch-5
Fix typo in documentation
2020-08-13 13:58:49 +02:00
Oliver Sand 61f913f119 Fix heading 2020-08-13 13:40:44 +02:00
Oliver Sand 6bb4cf95fa Fix button description 2020-08-13 13:36:21 +02:00
Oliver Sand 75a316459f Fix typo in documentation 2020-08-13 13:34:22 +02:00
Patrik Oldsberg 388df8c3bb docs/features: fix static location entires not being list of objects 2020-08-13 13:32:48 +02:00
Dominik Henneke 356643416d Merge branch 'master' into feat/api-catalog 2020-08-13 11:32:00 +02:00
Patrik Oldsberg f24efbda66 Merge pull request #1933 from spotify/rugvip/noabs
docs: avoid absolute links to docs + verify with script
2020-08-13 11:04:27 +02:00
Ivan Shmidt 045d796667 Merge branch 'master' of github.com:spotify/backstage into mob/docusaurus-structure 2020-08-13 10:15:01 +02:00
Paul Pacheco 88d4e1adf7 This is supposed to be optional 2020-08-12 17:10:51 -05:00
Patrik Oldsberg 2da62ba511 docs: use relative links to docs/ 2020-08-12 18:45:51 +02:00
Patrik Oldsberg 94db137153 docs/verify-links: avoid absolute links within docs 2020-08-12 18:44:28 +02:00
Patrik Oldsberg 1991dfdfce docs/features/software-templates/installation: update TODO link 2020-08-12 17:10:33 +02:00
Patrik Oldsberg 173a752855 docs/features/software-catalog: added installation guide
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 17:10:31 +02:00
Patrik Oldsberg edf46c80f2 docs/features/software-templates/installation: fix strange inline code blocks 2020-08-12 16:18:03 +02:00
Patrik Oldsberg 63d1bd80cc docs/features/software-templates: review fixes
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 16:18:03 +02:00
Patrik Oldsberg 42f949b465 docs/features/software-templates: add installation docs
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 16:18:02 +02:00
Ivan Shmidt e79102cee7 Merge branch 'master' of github.com:spotify/backstage into mob/docusaurus-structure 2020-08-12 16:17:25 +02:00
Stefan Ålund ec13744b36 Document the service catalog (#1922) 2020-08-12 16:14:45 +02:00
Ivan Shmidt ba72f0e652 fix: review 2020-08-12 15:33:11 +02:00