Skip to content

[Control Center] Add steps to install Control Center in WSL #4280

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

Open
wants to merge 6 commits into
base: latest
Choose a base branch
from

Conversation

tamasmak
Copy link
Contributor

@tamasmak tamasmak commented Apr 30, 2025

Copy link

github-actions bot commented Apr 30, 2025

AI Language Review

In the file "Getting Started in a Local Environment":

  1. Ensure that the section "Install Control Center in WSL" maintains consistent spelling and grammar. For example, "First you need to install the WSL" could be rephrased for clarity, such as "First, you need to install WSL."

  2. In the command "wsl.exe -d Ubuntu," the use of lowercase "e" in ".exe" may lead to confusion, as it is generally uppercase in Windows contexts.

  3. The phrase "After you need to use the WSL terminal to install Helm and Control Center" is missing a comma: "After, you need to use the WSL terminal..." Also, consider rephrasing for better clarity, such as "Next, use the WSL terminal to install Helm and Control Center."

Overall, ensure there is consistency in instructional tone and grammatical construction across the new section, in comparison to existing content.

@tamasmak tamasmak requested a review from MatthewVaadin May 6, 2025 10:27
@jouni
Copy link
Member

jouni commented May 8, 2025

Ensure that the section "Install Control Center in WSL" maintains consistent spelling and grammar. For example, "First you need to install the WSL" could be rephrased for clarity, such as "First, you need to install WSL."

Do I understand this correctly, that this review is only pointing out just one example of spelling and grammar issues that should be fixed, instead of all issues?

Comment on lines +126 to +137
One of the possible solutions to install Control Center on Windows in a local environment is to use https://www.docker.com/products/docker-desktop[Docker Desktop] and https://learn.microsoft.com/en-us/windows/wsl[WSL] (Windows Subsystem for Linux). First you need to https://learn.microsoft.com/en-us/windows/wsl/install[install] the WSL. It is important you choose a distribution during the installation where you can install Helm:

[source,shell]
----
wsl --install -d <Distribution Name>
----

One option is to use the Ubuntu distribution:
[source,shell]
----
wsl --install -d Ubuntu
----
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's shorten this section. It's fairly obvious which part can be changed from the second example. Also slightly improved grammar for readability.

Suggested change
One of the possible solutions to install Control Center on Windows in a local environment is to use https://www.docker.com/products/docker-desktop[Docker Desktop] and https://learn.microsoft.com/en-us/windows/wsl[WSL] (Windows Subsystem for Linux). First you need to https://learn.microsoft.com/en-us/windows/wsl/install[install] the WSL. It is important you choose a distribution during the installation where you can install Helm:
[source,shell]
----
wsl --install -d <Distribution Name>
----
One option is to use the Ubuntu distribution:
[source,shell]
----
wsl --install -d Ubuntu
----
One solution to install Control Center on Windows in a local environment is to use https://www.docker.com/products/docker-desktop[Docker Desktop] and https://learn.microsoft.com/en-us/windows/wsl[WSL] (Windows Subsystem for Linux).
First, you need to https://learn.microsoft.com/en-us/windows/wsl/install[install] WSL. It is important to choose a distribution that allows installation of Helm, for example Ubuntu:
[source,shell]
----
wsl --install -d Ubuntu
----

wsl --install -d Ubuntu
----

Then you need to enable the Kubernetes and WSL built-in engines in Docker Desktop:
Copy link
Contributor

Choose a reason for hiding this comment

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

Simplify.

Suggested change
Then you need to enable the Kubernetes and WSL built-in engines in Docker Desktop:
Then, you need to enable Kubernetes and WSL in Docker Desktop:


image::images/enable_wsl.png[Enable WSL]

You also need to enable the integration with the Ubuntu distribution in Docker Desktop:
Copy link
Contributor

Choose a reason for hiding this comment

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

Simplify.

Suggested change
You also need to enable the integration with the Ubuntu distribution in Docker Desktop:
You also need to enable integration with the Ubuntu distribution in Docker Desktop:


image::images/enable_ubuntu_distribution.png[Enable Ubuntu Distribution]

Then you can start the WSL with the following command using the distribution you chose before, in this case the Ubuntu:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Then you can start the WSL with the following command using the distribution you chose before, in this case the Ubuntu:
Then, you can start the WSL with the following command, using the distribution you chose before (in this case Ubuntu):

wsl.exe -d Ubuntu
----

After you need to use the WSL terminal to install Helm and Control Center. First, you need to https://helm.sh/docs/intro/install/#from-apt-debianubuntu[install] Helm before you can start to xref:../getting-started/local-environment#deploying_control_center[install] Control Center in the local environment with the command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After you need to use the WSL terminal to install Helm and Control Center. First, you need to https://helm.sh/docs/intro/install/#from-apt-debianubuntu[install] Helm before you can start to xref:../getting-started/local-environment#deploying_control_center[install] Control Center in the local environment with the command:
After this, you need to use the WSL terminal to install Helm and Control Center. First, you need to https://helm.sh/docs/intro/install/#from-apt-debianubuntu[install] Helm before you can xref:../getting-started/local-environment#deploying_control_center[install] Control Center in the local environment with the command:

wsl.exe -d Ubuntu
----

After you need to use the WSL terminal to install Helm and Control Center. First, you need to https://helm.sh/docs/intro/install/#from-apt-debianubuntu[install] Helm before you can start to xref:../getting-started/local-environment#deploying_control_center[install] Control Center in the local environment with the command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to reiterate the install command and adding entries to host files? This is covered in the linked installation guide. Also, it gives us another place to change when updating these processes (e.g. with local.gd we can skip editing the hosts file).

@MatthewVaadin
Copy link
Contributor

AI Language Review

In the file "Getting Started in a Local Environment":
...
2. In the command "wsl.exe -d Ubuntu," the use of lowercase "e" in ".exe" may lead to confusion, as it is generally uppercase in Windows contexts.

I would ignore this advice. As far as I have experienced, ".exe" is always written in lowercase. This could be changing in the operating system (although not that I have noticed), but in the context of the command line, lowercase is fine.

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.

4 participants