Feature: Write a database guide for Backstage
Feature description
Write a database guide for Backstage
Write procedures for setting up and maintaining a database for Backstage. Include a separate procedure for every DBMS that can be used. 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
Related instructions in the current doc:
- https://backstage.io/docs/tutorials/switching-sqlite-postgres/#install-postgresql
- https://backstage.io/docs/tutorials/configuring-plugin-databases/
Suggested changes:
- Write an introduction that explains what the default database is, why you would want to replace (or keep) it, and what the alternatives are.
- If plugins require a separate database or require configuration to use the main database, explain.
- Write any procedures that are needed for the Admin to replace, maintain, restore, or upgrade the database.
- Include these procedures in the Admin Guide section of the TOC.
Have you spent some time to check if this feature request has been raised before?
- I checked and didn't find similar issue
Have you read the Code of Conduct?
- I have read the Code of Conduct
Are you willing to submit PR?
None
Source: backstage/backstage