docs: add user guide documentation for dynamic plugins overlay repository #1872
Conversation
…tory - README.md: Overview and navigation - 01-getting-started.md: Core concepts, repository structure, adding plugins - 02-export-tools.md: CLI arguments, workflow inputs, frontend config - 03-plugin-owner-responsibilities.md: Ownership model, maintenance checklists - 04-metadata-synchronization.md: Sync procedures, validation checklist - 05-version-updates.md: Backstage version update cadence and procedures - 06-patch-management.md: Creating, maintaining, and retiring patches
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
/publish |
|
PR action ( |
|
|
|
| - **Commented lines** (prefixed with `#`) indicate plugins intentionally excluded | ||
| - **CLI arguments** after the colon customize the export behavior | ||
|
|
||
| #### The `--embed-package` Flag |
There was a problem hiding this comment.
Would it make sense to just link to the details on the CLI arguments and effects that are documented here?
| plugins/my-plugin-backend: --embed-package @backstage/some-dependency --suppress-native-package cpu-features | ||
| ``` | ||
|
|
||
| ### Common CLI Arguments |
There was a problem hiding this comment.
It's really convenient to have this here but again this does duplicate information in here. But maybe this format is better in this location and you could just link off to the other doc for more information.
github-actions
bot
added
the
non-workspace-changes
2 participants
https://issues.redhat.com/browse/RHIDP-7093
Summary
This PR adds comprehensive user guide documentation for the dynamic plugins overlay repository.
Documentation Structure
user-guide/README.mduser-guide/01-getting-started.mduser-guide/02-export-tools.mduser-guide/03-plugin-owner-responsibilities.mduser-guide/04-metadata-synchronization.mduser-guide/05-version-updates.mduser-guide/06-patch-management.mdTopics Covered
For Plugin Owners
For Export Tools
--embed-package,--suppress-native-package, etc.)/publishand/test)For Patch Management