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

Minor tweaks and highlights #149

Conversation

zerbitx
Copy link
Contributor

@zerbitx zerbitx commented Jun 13, 2024

No description provided.

Copy link

netlify bot commented Jun 13, 2024

Deploy Preview for vcluster-docs-site ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e82fee7
🔍 Latest deploy log https://app.netlify.com/sites/vcluster-docs-site/deploys/667964e9dd8f0d0008794ebe
😎 Deploy Preview https://deploy-preview-149--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.

@zerbitx zerbitx marked this pull request as draft June 14, 2024 15:47
@zerbitx zerbitx marked this pull request as ready for review June 19, 2024 12:49
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.

Any places in the doc where we reference the name of a resource (vcluster, namespace), can you put it into a code format?

On the rest of this page, there are some references to a vcluster, but it should be capitalized as vCluster


## Create the HA virtual cluster

To create a virtual cluster using the vcluster CLI, we run the vcluster create command. To enable HA, we’ll need to specify the distro and the values.yaml file to use:
To create a virtual cluster using the vcluster CLI, we run the `vcluster create` command. To enable HA, we’ll need to specify the distro and the vcluster.yaml file to use:
Copy link
Contributor

Choose a reason for hiding this comment

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

Put vcluster.yaml in a code formatting in this part as well as any other reference in the doc.

We’ve named the virtual cluster ha-tutorial. By default, the vcluster create command connects to the virtual cluster, but for the purposes of this tutorial, we’ve disabled that with the --connect=false flag. And we’ve specified the distro and the values.yaml file to use when creating the virtual cluster.
We’ve named the virtual cluster ha-tutorial. By default, the `vcluster create` command connects to the virtual cluster,
but for the purposes of this tutorial, we’ve disabled that with the `--connect=false flag`.
We’ve also specified the distro and the vcluster.yaml file to use when creating the virtual cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove this line We’ve also specified the distro and the vcluster.yaml file to use when creating the virtual cluster. as it's more specific to the old way of deploying.

Puts resources in code format
Replaces "virtual cluster" with vCluster instance
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.

In general, I don't think we have put vCluster into code formatting throughout the docs, so I would remove that, but consdiering how slow to review this PR, I'll update it as a quick follow-up PR.

@deniseschannon deniseschannon self-requested a review June 24, 2024 19:24
@deniseschannon deniseschannon merged commit 7588af1 into loft-sh:main Jun 24, 2024
5 checks passed
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