backstage icon indicating copy to clipboard operation
backstage copied to clipboard

🚀 Feature: Write instructions for installing and configuring plugins

Open dwelsch-esi opened this issue 2 years ago • 1 comments

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

  • https://backstage.io/docs/getting-started/configure-app-with-plugins
  • https://backstage.io/docs/integrations/
  • https://backstage.io/docs/plugins/existing-plugins
  • https://backstage.io/docs/conf/defining

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?

  • [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

None

dwelsch-esi avatar Dec 18 '23 20:12 dwelsch-esi

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[bot] avatar Feb 17 '24 00:02 github-actions[bot]