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: Getting Started documentation #21828

Open
2 tasks done
Tracked by #21893 ...
dwelsch-esi opened this issue Dec 12, 2023 · 2 comments
Open
2 tasks done
Tracked by #21893 ...

🚀 Feature: Getting Started documentation #21828

dwelsch-esi opened this issue Dec 12, 2023 · 2 comments
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

Rewrite Getting Started

Rewrite the Getting Started guides for Admin and Developer user roles:

  • Developer Getting Started is installation instructions for a standalone Backstage instance.
  • Admin Getting Started is installation and setup instructions for a production Backstage instance.

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:

  • Getting Started
    • Installing a standalone server (Developer or Admin)
    • Deploying a production server (Admin)
      • Deploying with Docker
      • Deploying with Kubernetes
      • Deploying with AWS Lightsail
    • Configuring Backstage (Admin)
      • Database
      • Authentication
      • Plugins
    • Logging into Backstage (Developer)
    • Register a component (Developer)
    • Create a new component (Developer)

👀 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 12, 2023
@dwelsch-esi
Copy link
Contributor Author

dwelsch-esi commented Dec 12, 2023

/cc @nate-double-u please review.

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.

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

3 participants