backstage / backstage

Backstage is an open framework for building developer portals
https://backstage.io/
Apache License 2.0
28.54k stars 6.06k forks source link

๐Ÿš€ Feature: Write instructions for installing and configuring plugins #21920

Open dwelsch-esi opened 11 months ago

dwelsch-esi commented 11 months ago

๐Ÿ”– 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:

๐Ÿ‘€ 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

github-actions[bot] commented 9 months ago

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.