Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚀 Feature: Write start and stop instructions for production Backstage server #21916

Open
2 tasks done
Tracked by #21893 ...
dwelsch-esi opened this issue Dec 18, 2023 · 2 comments
Open
2 tasks done
Tracked by #21893 ...
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

Comments

@dwelsch-esi
Copy link
Contributor

🔖 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:

  • Include in each procedure, if applicable, "Prerequisites" and "What's next" sections.
  • Write as step-by-step instructions. In some cases these might be very short; that's OK.
  • A procedure might be fairly elaborate in some cases; for example, on a Kubernetes-based app. That's OK too.
  • Add procedures for any other server actions an Admin might need in administering the Backstage app.
  • Include links to the Admin troubleshooting section.
  • Add procedures to the table of contents in the (new) Admin Guide section.

👀 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?

Are you willing to submit PR?

None

@dwelsch-esi dwelsch-esi added the enhancement New feature or request label Dec 18, 2023
@jamieklassen jamieklassen added the documentation Improvements or additions to documentation label Dec 19, 2023
@vinzscam vinzscam added the microsite Changes to backstage.io label Dec 21, 2023
Copy link
Contributor

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.

Copy link
Contributor

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.

@github-actions github-actions bot added the stale label Apr 22, 2024
@camilaibs camilaibs added will-fix We will fix this at some point and removed stale labels Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

5 participants