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

Issues in doc on importing a distribution from a Docker container #1640

Closed
NotTheDr01ds opened this issue Oct 20, 2022 · 0 comments · Fixed by #1985
Closed

Issues in doc on importing a distribution from a Docker container #1640

NotTheDr01ds opened this issue Oct 20, 2022 · 0 comments · Fixed by #1985

Comments

@NotTheDr01ds
Copy link
Contributor

NotTheDr01ds commented Oct 20, 2022

Documentation Issue

Several issues in this doc:

  1. The most serious is that the "Prerequisites" section says that Docker Desktop needs to be installed (good), but then Step 2 says that you need to run sudo service docker start (bad). If you have Docker Desktop installed, then that will result in the error start: unrecognized service. This is expected, since Docker Desktop does not install Docker Engine into the distribution itself, of course. Whoever wrote this (and captured the screenshot) was running Docker Engine rather than Docker Desktop.

  2. Step 4 is unnecessary and can be greatly simplified.

  3. There is no "cleanup" done for the resulting container, so it is left in an Exited state indefinitely (even after WSL and/or Docker restart).

  4. Minor, but the alt text for the image in Importing CentOS example is "Example of the above commands running in WSL" when these steps were all in PowerShell.

Link to documentation page

https://learn.microsoft.com/en-us/windows/wsl/use-custom-distro#obtaining-a-tar-file-for-centos-example

Suggested Improvements

  1. Recommended that Step 2 be removed completely, since Microsoft's recommended way of installing Docker is to use Docker Desktop (not Docker Engine).

  2. Recommend modifying Step 3 to use docker run -t --name wsl_export centos bash ls /. Step 5's $dockerContainerID could then be replaced by wsl_export. Step 4 can then be removed completely.

  3. Recommend a new final step to docker rm wsl_export

  4. Update image alt/description to "Example of the above commands running in PowerShell"

craigloewen-msft added a commit that referenced this issue Jul 16, 2024
mattwojo pushed a commit that referenced this issue Jul 16, 2024
mattwojo added a commit that referenced this issue Jul 16, 2024
* Update wsl-config.md (#1949)

* Add kernel requirement for connect-usb.md (#1950)

* Update networking.md (#1962)

Adding the OS requirements for networking features to make it clear when the features are available.

* Doc updates for dnsTunneling and autoProxy (#1970)

* dns and proxy doc updates

* add dnsTunnelingIpAddress setting

* mention generateHosts option

* move bullet point

* rephrase docker desktop point

---------

Co-authored-by: Catalin-Emil Fetoiu <cfetoiu@microsoft.com>

* Fix docker run command (#1956)

Current one will get error "/usr/bin/ls: /usr/bin/ls: cannot execute binary file"

* Updated production faq (#1954)

* Update wsl-config.md (#1959)

Matching the formatting of * near the Key column instead of the value column established lower in the table.

* Update about.md to fix small typo (#1983)

Closes #1973

* Update install-manual.md (#1981)

* Update filesystems.md to clarify Linux path (#1984)

* Update faq.yml to include note about setting username for moving distros (#1982)

* Update faq.yml to include note about setting username for moving distros

* Add set your default user account to faq

---------

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Update wsl-config.md (#1951)

* Update wsl-config.md

Add a description for defaultVhdSize option.

* Minor rewording

* Add note about max related to issue

---------

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Update use-custom-distro.md (#1985)

Fixes #1640

* Extensively clarify "Identify IP address" section. (#1978)

* Extensively clarify "Identify IP address" section.

* Move IP address scenario explanation to Networking doc

* Simplify commands and link to Networking page

* Fix warning typo

---------

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

---------

Co-authored-by: Craig Loewen <crloewen@microsoft.com>
Co-authored-by: Keith Horton <khorton@microsoft.com>
Co-authored-by: Cătălin Emil Fetoiu <fetoiucatalinemil@gmail.com>
Co-authored-by: Catalin-Emil Fetoiu <cfetoiu@microsoft.com>
Co-authored-by: FantasqueX <fantasquex@gmail.com>
Co-authored-by: Joshua Cooper <Cooperjoshua@gmail.com>
Co-authored-by: Ben Hillis <benhill@microsoft.com>
Co-authored-by: Jimm Chen <38829153+chjfth@users.noreply.github.com>
mattwojo added a commit that referenced this issue Jul 17, 2024
* Update wsl-config.md (#1949)

* Add kernel requirement for connect-usb.md (#1950)

* Update networking.md (#1962)

Adding the OS requirements for networking features to make it clear when the features are available.

* Doc updates for dnsTunneling and autoProxy (#1970)

* dns and proxy doc updates

* add dnsTunnelingIpAddress setting

* mention generateHosts option

* move bullet point

* rephrase docker desktop point

---------

Co-authored-by: Catalin-Emil Fetoiu <cfetoiu@microsoft.com>

* Fix docker run command (#1956)

Current one will get error "/usr/bin/ls: /usr/bin/ls: cannot execute binary file"

* Updated production faq (#1954)

* Update wsl-config.md (#1959)

Matching the formatting of * near the Key column instead of the value column established lower in the table.

* Update about.md to fix small typo (#1983)

Closes #1973

* Update install-manual.md (#1981)

* Update filesystems.md to clarify Linux path (#1984)

* Update faq.yml to include note about setting username for moving distros (#1982)

* Update faq.yml to include note about setting username for moving distros

* Add set your default user account to faq

---------

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Update wsl-config.md (#1951)

* Update wsl-config.md

Add a description for defaultVhdSize option.

* Minor rewording

* Add note about max related to issue

---------

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Update use-custom-distro.md (#1985)

Fixes #1640

* Extensively clarify "Identify IP address" section. (#1978)

* Extensively clarify "Identify IP address" section.

* Move IP address scenario explanation to Networking doc

* Simplify commands and link to Networking page

* Fix warning typo

---------

Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com>

* Remove postman example

Due to Postman security vulnerabilities

---------

Co-authored-by: Craig Loewen <crloewen@microsoft.com>
Co-authored-by: Keith Horton <khorton@microsoft.com>
Co-authored-by: Cătălin Emil Fetoiu <fetoiucatalinemil@gmail.com>
Co-authored-by: Catalin-Emil Fetoiu <cfetoiu@microsoft.com>
Co-authored-by: FantasqueX <fantasquex@gmail.com>
Co-authored-by: Joshua Cooper <Cooperjoshua@gmail.com>
Co-authored-by: Ben Hillis <benhill@microsoft.com>
Co-authored-by: Jimm Chen <38829153+chjfth@users.noreply.github.com>
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 a pull request may close this issue.

1 participant