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 instructions for installing and configuring plugins #21920

Open
2 tasks done
Tracked by #21893 ...
dwelsch-esi opened this issue Dec 18, 2023 · 1 comment
Open
2 tasks done
Tracked by #21893 ...
Labels
documentation Improvements or additions to documentation enhancement New feature or request will-fix We will fix this at some point

Comments

@dwelsch-esi
Copy link
Contributor

🔖 Feature description

Write instructions for installing and configuring plugins

Write step-by-step instructions for installing and configuring a plugin. Include how to test the plugin if there's a generic way to do that. Organize under Admin Guide in the doc TOC. This is just one more set of procedures for an Admin, but it's so central to Backstage that it should have its own section.

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 is to continue setup of a production Backstage server by installing existing plugins needed by the organization.

Related material in the current doc:

Suggested changes:

  • Consolidate the above information (and more) in step-by-step instructions for installing and configuring plugins.
  • Include the instructions in the Admin Guide.
  • Include this section in the "What's next?" section of the production server installation instructions.
  • The instructions can be applicable to stand-alone servers as well, but should be primarily aimed at production servers.

👀 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
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 Feb 17, 2024
@freben freben added the will-fix We will fix this at some point label Feb 17, 2024
@camilaibs camilaibs removed the stale label Feb 19, 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 will-fix We will fix this at some point
Projects
None yet
Development

No branches or pull requests

4 participants