🚀 Feature: Getting Started documentation #21828
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
microsite
Changes to backstage.io
will-fix
We will fix this at some point
🔖 Feature description
Rewrite Getting Started
Rewrite the Getting Started guides for Admin and Developer user roles:
In both cases, thoroughly document the procedure for installation. (In the case of a production environment, there's more than one way to do it. Document all of them.) The important point here is to give unambiguous step-by-step instructions in each case. Don't assume the reader knows anything.
In all cases add a What To Do Next section at the end of the installation procedure. Likely this will contain links to optional configuration and/or populating Backstage tasks.
The existing documentation might contain helpful source material that you can pull into this doc change. See this catalog of the existing (at the time of the CNCF tech doc analysis) Backstage technical documentation pages:
https://github.com/cncf/techdocs/blob/main/assessments/0008-backstage/backstage-doc-survey.csv
🎤 Context
This issue is a recommended change resulting from an analysis of the Backstage documentation commissioned by CNCF. The analysis and supporting documents are here:
https://github.com/cncf/techdocs/tree/main/assessments/0008-backstage
✌️ Possible Implementation
The Getting Started section of the table of contents will be modified to something like this, with links to the rewritten tasks:
👀 Have you spent some time to check if this feature request has been raised before?
🏢 Have you read the Code of Conduct?
Are you willing to submit PR?
None
The text was updated successfully, but these errors were encountered: