paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 22 Packages Projects Releases Wiki Activity

techdocs-milestones-update (#2705)

Browse Source
This commit is contained in:
Gary Niemen
2020-10-01 17:39:05 +02:00
committed by GitHub
parent 10052e0d7f
commit 73440c7d9a
1 changed files with 28 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/README.md
+28 -14
View File
@@ -33,16 +33,17 @@ about TechDocs and the philosophy in its
## Project roadmap
| 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] | Platform stability and compatibility improvements. [See V.2 Use Cases.](#techdocs-v2) |
| TechDocs V.3 🔮⌛ | 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] | Easy adoption of TechDocs (whatever environment you have) [See V.2 Use Cases.](#techdocs-v2) |
| [TechDocs V.3 🔮⌛][v3] | Build a widget (plugin) framework so that contributors can easily contribute features to TechDocs - that others can use. [See V.3 Use Cases.](#techdocs-v3) |
[v0]: https://github.com/spotify/backstage/milestone/15
[v1]: https://github.com/spotify/backstage/milestone/16
[v2]: https://github.com/spotify/backstage/milestone/17
[v2]: https://github.com/spotify/backstage/milestone/22
[v3]: https://github.com/spotify/backstage/milestone/17
<!-- TODO: Add link to milestone for v3 -->
@@ -59,26 +60,39 @@ about TechDocs and the philosophy in its
- 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.
- 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.
- 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
Platform stability and compatibility improvements
Extra platform stability and compatibility improvements:
- As a user I can define the metadata generated for my documentation.
- As a user I will be able to browse metadata from within my documentation in
Backstage.
#### TechDocs V.2
We have a TechDocs that works end-to-end. The next step is to make it super easy
for companies to adopt. This involves (something like) the following work items.
- “Solidify” work and “Mkdocs stabilization” work that has come out of our Q3
end-to-end work.
- Improve/simplify the get up and running process.
- Introduce doc template Software Templates.
- Enable companies to choose their own storage (S3 for example).
- Enable companies to choose their own source code hosting provider (GitHub,
GitLab, and so).
- Share how to plug in TechDocs to your own CI.
#### TechDocs V.3
more to come...
Build a widget (plugin) framework so that contributors can easily contribute
features to TechDocs - that others can use. And, also, so that we can easily
migrate Spotify's existing TechDocs features to open source.
## Structure