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 Helm README version phrasing #1028

Merged
merged 1 commit into from
Sep 1, 2023

Conversation

sjberman
Copy link
Contributor

@sjberman sjberman commented Sep 1, 2023

Problem: Users who visit our main branch intending to install Helm may not understand how to get the latest stable version, since we only mention how to install the edge version.

Solution: Omit the version field in the examples, which will install the latest stable version. Mention how a user can install the edge version. Also updated the release process doc to no longer require any updates to the Helm README, since it can apply to all releases now.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Problem: Users who visit our main branch intending to install Helm may not understand how to get the latest stable version, since we only mention how to install the edge version.

Solution: Omit the version field in the examples, which will install the latest stable version. Mention how a user can install the edge version. Also updated the release process doc to no longer require any updates to the Helm README, since it can apply to all releases now.
@sjberman sjberman requested a review from a team as a code owner September 1, 2023 14:45
@github-actions github-actions bot added chore Pull requests for routine tasks documentation Improvements or additions to documentation labels Sep 1, 2023
Copy link
Member

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😎

@sjberman sjberman merged commit ab3c6af into nginxinc:main Sep 1, 2023
23 checks passed
@sjberman sjberman deleted the chore/helm-readme branch September 1, 2023 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants