Install page improvement based on feedback #15487

dockertopia · 2022-08-25T14:01:36Z

Included workshop w/ PM feedback
Remove Docker Desktop page and renamed instructions page and added redirects
Adjusted TOC
Made pages less wordy when possible and other multiple minor enhancements.

Related issues (optional)

netlify · 2022-08-25T14:04:35Z

✅ Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`593283a`
🔍 Latest deploy log	https://app.netlify.com/sites/docsdocker/deploys/630787b62992650009cd1fa6
😎 Deploy Preview	https://deploy-preview-15487--docsdocker.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

hyu

I really like this approach with the table! I added a bunch of specific feedback on the index page. I will go through the Linux install page when I have a chance.

hyu · 2022-08-25T14:37:37Z

_data/toc.yaml

-      - path: /compose/install/uninstall/ 
+        title: Install Docker Compose
+      - path: /compose/install/compose-linux/
+        title: Install on Linux


Suggested change

title: Install on Linux

title: Install Docker Compose on Linux

Is there a SEO benefit to titling the page with the word "Docker Compose" as well? So when people search for "install docker compose linux" they will get this page?

(But, I know the word "Docker Compose" is in the description too. I'm open to the argument that this is sufficient. Since I too like it when we can use a shorter title.)

I'm not sure how this affects SEO, the keywords in the front matter are there to optimize searched. I just thought there was a lot of context repetition and, since, there is not a lot of real-estate in the TOC (panel on the left) and the titles wrap after a couple of words I thought the TOC looked cleaner that way. I am also fine either way. Your call.

Sure, let's go with the shorter title.

hyu · 2022-08-25T15:14:49Z

compose/install/index.md


-## Compose installation scenarios
-You can run Compose on macOS, Windows, and 64-bit Linux. Check what installation scenario fits your needs. 
+* If you have Docker Desktop, you've got a full Docker installation, including Compose.


Suggested change

* If you have Docker Desktop, you've got a full Docker installation, including Compose.

If you've previously installed Docker Desktop, then you already have a full Docker installation that includes Compose. (If not, download links for Docker Desktop by OS are in the table below.)

I edited this sentence to be a little more explicit about the fact that Compose is included in Docker Desktop. I also included the "if not" case that was previously in the bullet below.

The idea is to fully cover the DD case right away, since I suspect that not everyone is aware that Compose is bundled in Docker Desktop. (e.g., there's no mention of Compose in the Install page for Mac / Windows / etc)

@dockertopia, is there a simple check the user can do to confirm they have docker compose? They should just be able to run docker compose right?

See closing comment.

hyu · 2022-08-25T15:15:28Z

compose/install/index.md

 ---

-On this page you can find a summary of the available options for installing Docker Compose. 
+On this page you can find information on how to get and install Compose.


Suggested change

On this page you can find information on how to get and install Compose.

I think this page is short and self-evident enough not to require this explanation.

Agree. Just keeping what we're doing as a standard in the docs. Usually it helps with the weirdness of having content start right after the page's title (from a visual perspective).

See closing comment.

hyu · 2022-08-25T15:23:39Z

compose/install/index.md


-* Docker Compose requires Docker Engine.
-* Docker Compose plugin requires Docker CLI.
+**To get Compose:**


Suggested change

**To get Compose:**

This seems redundant with the header, but doesn't add much additional info.

See closing comment.

hyu · 2022-08-25T15:29:13Z

compose/install/index.md

+* If you have Docker Desktop, you've got a full Docker installation, including Compose.

-Are you looking to:
+* If you don't have Docker yet installed, or just need to install Compose, check the options below:


Suggested change

* If you don't have Docker yet installed, or just need to install Compose, check the options below:

I think the "If you don't have Docker yet installed" should be included with the prior sentence about Docker Desktop. So that way, we address DD entirely with the first point:

If you've previously installed Docker Desktop, then you already have a full Docker installation that includes Compose. (If not, download links for Docker Desktop by OS are in the table below.)

Then, that leaves the statement:

If you…just need to install Compose, check the options below:

This could be more helpful. Under what circumstances would the user need to install Compose outside Docker Desktop? And how do they tell the difference between whether they should install it as a plugin, or standalone?

(I address this point a bit in the "Table Description" feedback below)

See closing comment.

hyu · 2022-08-25T15:35:43Z

compose/install/index.md

+**Table description:**
+* **Linux(64bit):** *option1)* Install [Docker Desktop for Linux](../../desktop/install/linux-install.md) or, *option2)* [Install Docker Engine and the CLI](../../engine/install/#server) and then [install Compose](compose-linux.md).
+* **macOS:** [Install Docker Desktop](../../desktop/install/mac-install/).
+* **Windows:** [Install Docker Desktop](../../desktop/install/windows-install/).
+* **Windows Server:** [Install Docker Engine and the CLI](../../engine/install/binaries/#install-server-and-client-binaries-on-windows) and then [install Compose](#install-compose-on-windows-server).
+


This "table description" seems redundant with the information that's already in the table.

Is this intended for accessibility, though? If so, that is unfortunately inconsistent with other instances of table usage. (e.g., on the DD Linux Install page). 😞

I would suggest that we remove from this section the repeated Docker Desktop download links, since it detracts from the simplicity and clarity of the links already in the table.

Without those links, it leaves the instructions for Linux and Windows Server. How about including them as clear sections?

Note on Linux

Suggested change

**Table description:**

* **Linux(64bit):** *option1)* Install [Docker Desktop for Linux](../../desktop/install/linux-install.md) or, *option2)* [Install Docker Engine and the CLI](../../engine/install/#server) and then [install Compose](compose-linux.md).

* **macOS:** [Install Docker Desktop](../../desktop/install/mac-install/).

* **Windows:** [Install Docker Desktop](../../desktop/install/windows-install/).

* **Windows Server:** [Install Docker Engine and the CLI](../../engine/install/binaries/#install-server-and-client-binaries-on-windows) and then [install Compose](#install-compose-on-windows-server).

### Note on Linux

On Linux(64bit), you may want to install Docker Engine separately from Compose, instead of the approach of installing everything with Docker Desktop. [This gives you more control over your install location and version of Compose.]

1. [Install Docker Engine and the CLI](../../engine/install/#server)

2. [install Compose](compose-linux.md).

Alternately, you may want to [install Compose standalone], without the pre-requisite of installing the Docker Engine.

### Note on Windows Server

(This then replaces "Install Compose on Windows Server")

[This gives you more control over your install location and version of Compose.]

I just put this here as a placeholder for trying to explain a common use case for bypassing the Docker Desktop install.

Is there more we can say here to address "Under what circumstances would the user need to install Compose outside Docker Desktop? And how do they tell the difference between whether they should install it as a plugin, or standalone?"

See closing comment.

dockertopia · 2022-08-26T16:35:14Z

To clarify I thought checking if there's anything of interest to pick up from here #15494 or to go with this scenario instead, it would not make sense to address each individual review comment in this PR. If the goal is to dismiss the other scenario and just fine tune this one, then I and can address all your feedback in reply comments/commits. Let me know how you want to proceed.

dockertopia · 2022-08-29T13:08:08Z

So we're continuing the work in #15494, so all comments and feedback from everyone is addressed in the mentioned PR.

Install page improvement based on feedack

861df38

dockertopia requested a review from hyu August 25, 2022 14:04

dockertopia changed the title ~~Install page improvement based on feedack~~ Install page improvement based on feedback Aug 25, 2022

Fixing links

97ae5cd

dockertopia marked this pull request as ready for review August 25, 2022 14:26

dockertopia requested a review from usha-mandya as a code owner August 25, 2022 14:26

Merge branch 'docker:master' into ENGDOCS-906

593283a

hyu reviewed Aug 25, 2022

View reviewed changes

dockertopia closed this Aug 29, 2022

dockertopia mentioned this pull request Aug 29, 2022

Install page improvement based on feedback (scenario2) #15494

Merged

	title: Install on Linux
	title: Install Docker Compose on Linux

	* If you have Docker Desktop, you've got a full Docker installation, including Compose.
	If you've previously installed Docker Desktop, then you already have a full Docker installation that includes Compose. (If not, download links for Docker Desktop by OS are in the table below.)

-**Table description:**
-* **Linux(64bit):** *option1)* Install [Docker Desktop for Linux](../../desktop/install/linux-install.md) or, *option2)* [Install Docker Engine and the CLI](../../engine/install/#server) and then [install Compose](compose-linux.md).
-* **macOS:** [Install Docker Desktop](../../desktop/install/mac-install/).
-* **Windows:** [Install Docker Desktop](../../desktop/install/windows-install/).
-* **Windows Server:** [Install Docker Engine and the CLI](../../engine/install/binaries/#install-server-and-client-binaries-on-windows) and then [install Compose](#install-compose-on-windows-server).
+### Note on Linux
+On Linux(64bit), you may want to install Docker Engine separately from Compose, instead of the approach of installing everything with Docker Desktop. [This gives you more control over your install location and version of Compose.]
+. [Install Docker Engine and the CLI](../../engine/install/#server)
+. [install Compose](compose-linux.md).
+Alternately, you may want to [install Compose standalone], without the pre-requisite of installing the Docker Engine.
+###  Note on Windows Server
+(This then replaces "Install Compose on Windows Server")

Install page improvement based on feedback #15487

Install page improvement based on feedback #15487

Uh oh!

Conversation

dockertopia commented Aug 25, 2022

Related issues (optional)

Uh oh!

netlify bot commented Aug 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docsdocker ready!

Uh oh!

hyu left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Note on Linux

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dockertopia commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dockertopia commented Aug 29, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Aug 25, 2022 •

edited

Loading

dockertopia commented Aug 26, 2022 •

edited

Loading