docs: update README references from v1beta1 to v1 #227
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ndrscodes
requested review from
rbren,
Azahorscak and
TheCubicleJockey
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes #
Checklist
Description
What's the goal of this PR?
The README is potentially confusing when running the latest version of the project. Since the recommendation is to upgrade to
v2, theapiVersionto use isgemini.fairwinds.com/v1instead ofgemini.fairwinds.com/v1beta1. IMHO, the README should describe the installation process for new installations instead of documenting how old versions were installed.What changes did you make?
changes examples in
README.mdto referenceapiVersion: gemini.fairwinds.com/v1instead ofgemini.fairwinds.com/v1beta1asv1seems to be the officially supported version for the latest Helm release.What alternative solution should we consider, if any?