Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Promote per-chart READMEs #331

Merged
merged 1 commit into from
Oct 3, 2024
Merged

Promote per-chart READMEs #331

merged 1 commit into from
Oct 3, 2024

Conversation

LeoColomb
Copy link
Member

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 (Release chart v5.0.0 #286).

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

@LeoColomb LeoColomb mentioned this pull request Sep 9, 2024
Merged
@LeoColomb LeoColomb marked this pull request as ready for review September 18, 2024 20:39
@LeoColomb LeoColomb force-pushed the leo/feat/readme branch 4 times, most recently from 353f12f to fe78dc3 Compare September 18, 2024 21:37
@LeoColomb LeoColomb enabled auto-merge (squash) September 18, 2024 21:39
@LeoColomb
Copy link
Member Author

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

@LeoColomb LeoColomb enabled auto-merge (rebase) October 3, 2024 11:26
@LeoColomb LeoColomb merged commit 97fc9a6 into develop Oct 3, 2024
17 checks passed
@LeoColomb LeoColomb deleted the leo/feat/readme branch October 3, 2024 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RangerRick RangerRick RangerRick approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LeoColomb @RangerRick