🚀 Feature: Write start and stop instructions for production Backstage server #21916
Open
2 tasks done
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
Write start, stop, and other instructions for production Backstage server
Write step-by-step instructions to start, restart, check status, and stop a production Backstage server. Include a procedure for every install configuration (Kubernetes, standalone, etc.). Add procedures for any other server-related actions needed by the admin. Can also include sections on tuning server performance in each case. Organize under Admin Guide in the doc TOC.
Audience: Admin
Type: Task
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 goal here is to create a run book that an Admin can refer to quickly as part of an Admin guide that also includes troubleshooting, performance, upgrading, and so on.
Suggested changes:
👀 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: