Promote per-chart READMEs

netbox-community / netbox-chart

A Helm chart for NetBox

https://netbox.readthedocs.io/

Apache License 2.0

261 stars 153 forks source link

Closed LeoColomb closed 1 month ago

LeoColomb commented 2 months ago

The goal of this PR is to improve readability of the repository.

Make clear the repository is about charts only, with more focused content.
Move the technical README into the chart, so it is shipped with it while bundled.
- Also helps to make it visible on tools like Artificat Hub.
Move the upgrade notes to the (coming) release, for now into the respective PR (#286).

It will also help if any additional chart is provided in the future.

LeoColomb commented 1 month ago

Updating with a merge on markdown content is risky 😅 Need to rebase