8000 Add top-level-overview READMEs for whole repo and each plugin · Issue #4 · coder/backstage-plugins · GitHub
[go: up one dir, main page]

Skip to content
Add top-level-overview READMEs for whole repo and each plugin #4
Closed as not planned
@Parkreiner

Description

@Parkreiner

Working on documenting the various issues I'd been collecting ad-hoc.

We need a set of READMEs for each plugin that:

  1. Provide a top-level overview for what the purpose of the plugin is
  2. Has a "quick start" section for getting someone up and running with the plugin as soon as possible
  3. Has a link to more in-depth API docs (which will each be separate READMEs)
  4. Has info for how to contribute

On top of that, we'd also want a README for the entire monorepo

@bpmct feel free to edit in more info for this issue if you think we need anything else

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0