-
Notifications
You must be signed in to change notification settings - Fork 27
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
feat: improve helm installation process #285
Conversation
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
2a1555e
to
b750333
Compare
9d4f9cb
to
eac4902
Compare
- add login instructions partial Signed-off-by: Piotr Zaniewski <[email protected]>
eac4902
to
95edbfb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Piotr1215 I've read through this and there are little things that would improve the overall clarity of this document.
- Update any reference of "vCluster Platform" to use "the platform".
We should only refer to the configuration file as theI totally misunderstood the differences, but cleaned it up as there was some confusion in here.platform configuration file
. I see references usingvcluster.yaml
andvalues.yaml
to indicate the same file.
There are other areas that I might nitpick on, but I think it's more of a user preference than anything else.
@sowmyav27 As a new user, could you also read through the most recent deploy preview to see if this makes sense? |
Co-authored-by: Piotr Zaniewski <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add bash titles throughout this doc like you did in the Install vCluster CLI section? I really like them for the people who are going to skim and just read /copy the commands.
Signed-off-by: Piotr Zaniewski <[email protected]>
Signed-off-by: Piotr Zaniewski <[email protected]>
Signed-off-by: Piotr Zaniewski <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, this is looking great. The only addition would be adding how to create vclusters (like in here: https://deploy-preview-291--vcluster-docs-site.netlify.app/docs/platform/install/quick-start-guide/#create-virtual-clusters)
I don't want to hold up the approval for that last change.
Summary
Improve clarity and usability of the
helm
installation documentation instructions.Docs Link: https://deploy-preview-285--vcluster-docs-site.netlify.app/docs/platform/install/helm
Closes DOC-268, DOC-274