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

feat: improve helm installation process #285

Merged
merged 6 commits into from
Oct 11, 2024

Conversation

Piotr1215
Copy link
Contributor

@Piotr1215 Piotr1215 commented Oct 4, 2024

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

Copy link

netlify bot commented Oct 4, 2024

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit 88ee152
🔍 Latest deploy log https://app.netlify.com/sites/vcluster-docs-site/deploys/6707fa4f23f94900088f21fe
😎 Deploy Preview https://deploy-preview-285--vcluster-docs-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

platform/install/helm.mdx Outdated Show resolved Hide resolved
platform/install/helm.mdx Outdated Show resolved Hide resolved
platform/install/helm.mdx Outdated Show resolved Hide resolved
platform/install/helm.mdx Outdated Show resolved Hide resolved
platform/install/helm.mdx Outdated Show resolved Hide resolved
platform/install/helm.mdx Outdated Show resolved Hide resolved
@Piotr1215 Piotr1215 force-pushed the doc-268/improve-helm-install branch 6 times, most recently from 9d4f9cb to eac4902 Compare October 7, 2024 12:13
- add login instructions partial

Signed-off-by: Piotr Zaniewski <[email protected]>
Copy link
Contributor

@deniseschannon deniseschannon left a 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.

  1. Update any reference of "vCluster Platform" to use "the platform".
  2. We should only refer to the configuration file as the platform configuration file. I see references using vcluster.yaml and values.yaml to indicate the same file. I totally misunderstood the differences, but cleaned it up as there was some confusion in here.

There are other areas that I might nitpick on, but I think it's more of a user preference than anything else.

@deniseschannon
Copy link
Contributor

@deniseschannon
Copy link
Contributor

@sowmyav27 As a new user, could you also read through the most recent deploy preview to see if this makes sense?

platform/install/helm.mdx Show resolved Hide resolved
platform/install/helm.mdx Outdated Show resolved Hide resolved
Co-authored-by: Piotr Zaniewski <[email protected]>
Copy link
Contributor

@deniseschannon deniseschannon left a 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]>
Copy link
Contributor

@deniseschannon deniseschannon left a 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.

@deniseschannon deniseschannon merged commit b420777 into main Oct 11, 2024
8 checks passed
@Piotr1215 Piotr1215 deleted the doc-268/improve-helm-install branch October 24, 2024 10:06
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.

3 participants