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.

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

Update docs and refactoring #85

Merged
merged 10 commits into from
Sep 20, 2024
Merged

Update docs and refactoring #85

merged 10 commits into from
Sep 20, 2024

Conversation

DrPsychick
Copy link
Member

@DrPsychick DrPsychick commented Sep 15, 2024

Motivation: triggered by #80 it became clear that documentation is in bad shape and needs to be improved.

  • generate readme from values.yaml and a template with helm-docs
  • while documenting, finding and fixing bugs and doing minimal refactoring (hence a minor version bump)

Some configuration still needs improved documentation and testing strategies specifically for this helm chart. Since those require more effort, they will be done in separate PRs.

@DrPsychick DrPsychick requested a review from a team as a code owner September 15, 2024 12:58
charts/athens-proxy/README.md Outdated Show resolved Hide resolved
charts/athens-proxy/README.md Show resolved Hide resolved
charts/athens-proxy/README.md Outdated Show resolved Hide resolved
charts/athens-proxy/README.md Show resolved Hide resolved
charts/athens-proxy/README.md.gotmpl Show resolved Hide resolved
@DrPsychick DrPsychick merged commit ee09531 into gomods:main Sep 20, 2024
1 check passed
@DrPsychick DrPsychick deleted the helm-docs branch September 21, 2024 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants