From 96bc61aeb2b1ff8757c18269001c4486814dccf1 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Mon, 10 Aug 2020 14:25:26 +0200 Subject: [PATCH 1/2] Add use cases connected to TechDocs versions in project roadmap --- docs/features/techdocs/README.md | 43 ++++++++++++++++++++++++++++---- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index b6a4d82b92..124b042231 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -22,16 +22,49 @@ Spotify’s developer experience offering with 2,400+ documentation sites and ## Project roadmap -| Version | Description | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| [TechDocs V.0 ✅][v0] | Read docs in Backstage - Enable anyone to get a reader experience working in Backstage. | -| [TechDocs V.1 🚧][v1] | TechDocs end to end - First and minimum release of TechDocs that you can use end to end - and contribute to. | -| [TechDocs V.2 🔮⌛][v2] | Widget Architecture - TechDocs widget architecture available, so the community can create their own customized features. | +| Version | Description | +| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| [TechDocs V.0 ✅][v0] | Read docs in Backstage - Enable anyone to get a reader experience working in Backstage. [See V.0 Use Cases.](./#techdocs-v0) | +| [TechDocs V.1 🚧][v1] | TechDocs end to end (alpha) - Alpha of TechDocs that you can use end to end - and contribute to. [See V.1 Use Cases.](./#techdocs-v1) | +| [TechDocs V.2 🔮⌛][v2] | Widget Architecture - TechDocs widget architecture available, so the community can create their own customized features. | [v0]: https://github.com/spotify/backstage/milestone/15 [v1]: https://github.com/spotify/backstage/milestone/16 [v2]: https://github.com/spotify/backstage/milestone/17 +## Use Cases + +#### TechDocs V.0 + +**Running locally** + +- As a user I can navigate to a manually curated docs explore page. +- As a user I can navigte to and read mock documentation that is manually + uploaded by the TechDocs core team. + +#### TechDocs V.1 + +**Running locally** + +- As a user I can run TechDocs locally and read documentation. +- As a user I can create a docs folder in my entity project and add a reference + in the entity configuration file (of the owning entity) to my documentation. + - Backstage will automatically build my documentation and serve it in + TechDocs. + - Documentation will be displayed under the docs tab in the service catalog. +- As a user I can create a docs only repository that will be standalone from any + other service. + +**Running at company in production** + +- As a user I can choose my own storage solution for the documentation (as + example GCS/AWS/Azure etc) +- As a user I can define my own API to interface my own documentation solution. + +#### TechDocs V.2 + +more to come... + ## Structure - [Getting Started] From 7462a1d5a1f3958240a34ee5a27b5c6af485614a Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Mon, 10 Aug 2020 14:29:59 +0200 Subject: [PATCH 2/2] fixup --- docs/features/techdocs/README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index 124b042231..d054483482 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -36,16 +36,12 @@ Spotify’s developer experience offering with 2,400+ documentation sites and #### TechDocs V.0 -**Running locally** - - As a user I can navigate to a manually curated docs explore page. - As a user I can navigte to and read mock documentation that is manually uploaded by the TechDocs core team. #### TechDocs V.1 -**Running locally** - - As a user I can run TechDocs locally and read documentation. - As a user I can create a docs folder in my entity project and add a reference in the entity configuration file (of the owning entity) to my documentation. @@ -54,9 +50,6 @@ Spotify’s developer experience offering with 2,400+ documentation sites and - Documentation will be displayed under the docs tab in the service catalog. - As a user I can create a docs only repository that will be standalone from any other service. - -**Running at company in production** - - As a user I can choose my own storage solution for the documentation (as example GCS/AWS/Azure etc) - As a user I can define my own API to interface my own documentation solution.