This is an in-depth overview of the Backstage product, probably in several web pages. Include a conceptual overview of the frontend, the backend, and plugin-based architecture. Briefly describe APIs (with links to API references, but no syntax reference here).
Audience: Integrators and contributors. Possibly admins and developers who need to configure plugins.
Write an architectural overview. Start with a high-level introduction, then systematically describe details of the system. Use diagrams as necessary. This is a conceptual description, so avoid such details as call syntax and code snippets unless they're needed to clarify a point. However, it's acceptable to link to references such as API and configuration documentation.
👀 Have you spent some time to check if this feature request has been raised before?
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
🔖 Feature description
Rewrite architectural overview
This is an in-depth overview of the Backstage product, probably in several web pages. Include a conceptual overview of the frontend, the backend, and plugin-based architecture. Briefly describe APIs (with links to API references, but no syntax reference here).
Audience: Integrators and contributors. Possibly admins and developers who need to configure plugins.
Type: Conceptual
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 material in the current doc:
Suggested changes:
Write an architectural overview. Start with a high-level introduction, then systematically describe details of the system. Use diagrams as necessary. This is a conceptual description, so avoid such details as call syntax and code snippets unless they're needed to clarify a point. However, it's acceptable to link to references such as API and configuration documentation.
👀 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