Skip to content

Improving visibility/clarity or repo status: using badge and better docs #271

Closed
@leogr

Description

@leogr

Motivation

We have received feedback indicating that the current status of each repository (official, incubating, sandbox, etc.) needs to be sufficiently visible and clearly understood. So, there is a need to convey better the maturity level of each repository to enhance clarity for our users and contributors.

Feature

My proposal in this regard is to implement the following:

  • Revise our documentation to ensure these definitions and statuses are clearly described and consistently applied. Documentation should be adequately interlinked for easier navigation.

  • Add a badge to each repository, indicating its status (Stable, Incubating, Sandbox). This badge should link to a description of what each status means. (someone proposed this idea to me a couple of weeks ago - I would like to give credit to this person, but unfortunately, I can't recall who 😓 )

Alternatives

Doing nothing is always an alternative 😅 However, if we do not make these changes, there could be ongoing confusion about the purpose and status of our repositories.

Additional context

The purpose is to ensure that our repository adoption model (that demonstrated to work fine) is not only transparent but also readily perceivable to all stakeholders.
On top of that, we may also want to revise some statuses or create new ones to reflect the level of some particular repositories better. For example, I may argue that test-infra should not be considered "incubating" anymore. At the same time, it does not match the "core" definition.

Note: while revising the above points, other improvements come up. See #273 for full details.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions