Skip to content

Conversation

@dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Oct 18, 2022

Documentation review of the Ubuntu installation guide.

This is a part of the effort of keeping our most popular content up to date and useful. The Ubuntu installation page is in the list of our top 20 most visited pages.

Also updating the corresponding Debian page as a result of these two being near-identical.

@dvdksn dvdksn requested a review from usha-mandya as a code owner October 18, 2022 16:06
@netlify
Copy link

netlify bot commented Oct 18, 2022

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 8db22fb
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6352658deae152000973aa86
😎 Deploy Preview https://deploy-preview-15902--docsdocker.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 settings.

>
> ```console
> $ curl -fsSL https://get.docker.com -o get-docker.sh
> $ DRY_RUN=1 sh ./get-docker.sh
Copy link
Contributor

Choose a reason for hiding this comment

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

Should the DRY_RUN example include sudo? It is required and shown in non-dry-run call below.

$ sudo docker run hello-world
```
```console
$ sudo service docker start
Copy link
Contributor

Choose a reason for hiding this comment

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

docker starts automatically on Debian

`hello-world` image:

```console
$ sudo service docker start
Copy link
Contributor

Choose a reason for hiding this comment

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

docker starts automatically on Ubuntu

Copy link
Contributor

@sam-thibault sam-thibault left a comment

Choose a reason for hiding this comment

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

Thanks for these updates! Just a couple small notes from me.

sam-thibault
sam-thibault previously approved these changes Oct 21, 2022
Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

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

Soooo much clearer and efficient. Just some tiny tweaks/comments

I also wonder, and this is certainly beyond the scope of this PR, if it is worth pulling out all the 'Uninstall' sections into one page? Similar to how it is in Desktop. It's never made sense to me to include the uninstall content on the install pages.

- In testing and development environments, some users choose to use automated
[convenience scripts](#install-using-the-convenience-script) to install Docker.
This is currently the only approach for Raspbian.
- [Install it manually](#install-from-a-package) and manage upgrades completely
Copy link
Contributor

Choose a reason for hiding this comment

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

I know this was written before you edited this page, but wonder if we can take this opportunity to remove 'completely'?

- [Install it manually](#install-from-a-package) and manage upgrades completely
manually.

- Using a [convenience scripts](#install-using-the-convenience-script) (only
Copy link
Contributor

Choose a reason for hiding this comment

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

😱 brackets???!?!

Docker from the repository.

> **Raspbian users cannot use this method!**
> **Raspbian users can't use this method!**
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, I know this was here already, but can we remove the '!' ?


3. Verify that Docker Engine is installed correctly by running the `hello-world`
image.
3. Verify that the Docker Engine installation was successful by running the
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
3. Verify that the Docker Engine installation was successful by running the
3. Verify that the Docker Engine installation is successful by running the


The Docker daemon starts automatically.

6. Verify that the Docker Engine installation was successful by running the
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
6. Verify that the Docker Engine installation was successful by running the
6. Verify that the Docker Engine installation is successful by running the


3. Verify that Docker Engine is installed correctly by running the `hello-world`
image.
3. Verify that the Docker Engine installation was successful by running the
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
3. Verify that the Docker Engine installation was successful by running the
3. Verify that the Docker Engine installation is successful by running the

@dvdksn
Copy link
Contributor Author

dvdksn commented Oct 21, 2022

I also wonder, and this is certainly beyond the scope of this PR, if it is worth pulling out all the 'Uninstall' sections into one page? Similar to how it is in Desktop. It's never made sense to me to include the uninstall content on the install pages.

Yes, totally. Let me make this a follow-up PR to weed out the uninstall steps (and maybe update too) from here. Needs to take all OS/distro instructions into consideration.

@dvdksn dvdksn requested a review from aevesdocker October 21, 2022 09:25
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