Skip to content

Conversation

@dockertopia
Copy link
Contributor

@dockertopia dockertopia commented May 26, 2022

Proposed changes

Revisited the page to clarify and streamline different installation scenarios.
Presented options/methods in play more clearly at the top.
Made instructions in general less verbose and worded them in more certain terms.
Broke it into separated pages as content inside tabs could not be cross-referenced.

Related issues (optional)

Related to #14705/4

@netlify
Copy link

netlify bot commented May 26, 2022

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e41a667
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6298ecb3382c8000091bc4fb
😎 Deploy Preview https://deploy-preview-14838--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.

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.

Hey @dockertopia , I think this a major improvement to what is currently in the docs, having the information broken down across child pages makes a big difference.
I've not done a full style-guide review as I think there are some structural tweaks that could be made first. Let me know what you think.

Copy link
Member

@StefanScherer StefanScherer left a comment

Choose a reason for hiding this comment

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

Added suggestions for the CLI plugin installation on Windows Server.

@StefanScherer StefanScherer self-requested a review June 1, 2022 12:09
Copy link
Contributor

@glours glours left a comment

Choose a reason for hiding this comment

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

Sounds definitely better that what we currently have
Just 1 or 2 adjustments to do IMHO

Copy link
Member

@StefanScherer StefanScherer left a comment

Choose a reason for hiding this comment

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

Only tiny changes to re-order Linux before Windows as it's much more common for Linux users to install Compose manually than on a Windows Server.

@dockertopia
Copy link
Contributor Author

@aevesdocker I will only edit this section to accommodate the reordering that Guillaume and Stefan suggest and that makes total sense.
So you if you want you can take a final editorial look now or after that commit is fine.

Copy link
Contributor Author

@dockertopia dockertopia left a comment

Choose a reason for hiding this comment

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

Hey @StefanScherer and @glours included your suggestions via the last commit. Can you PTAL in order to merge the PR.

@StefanScherer StefanScherer self-requested a review June 2, 2022 14:09
Copy link
Member

@StefanScherer StefanScherer left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you.

dockertopia and others added 6 commits June 2, 2022 16:50
Changing windows server installation instructions to apply to installing Compose a CLI plugin.

Co-authored-by: Stefan Scherer <stefan.scherer@docker.com>
Changing windows server installation instructions to apply to installing Compose a CLI plugin.

Co-authored-by: Stefan Scherer <stefan.scherer@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@dockertopia dockertopia merged commit d49af6a into docker:master Jun 2, 2022
@mcrapts
Copy link

mcrapts commented Jun 4, 2022

This doesn't look good at all. The Compose plugin installation instructions are now a mess: it's a very long page with numbered lists, the numbering is sometimes even incorrect, subheaders are missing, the very easy tabs are suddenly gone, there is a code block where the instructions are suddenly in the code (clearly syntax error). I would suggest to revert this change and fix it first.

  • Numbering going from to 2. to 1. without a subheader:

image

  • Random capitalization:

image

  • Again numbering going from 3. to 1. without a subheader:

image

  • Navigation tabs are absent.
  • The landing page is very chatty and not informative at all:
    image
    A lot of random capitalization, which is inconsistent and confusing. Sometimes it's a "plug in", other times it's "plugin" and there's even "plugin,s". The actual installation instructions are buried two levels deep, and the listing is confusing. I have used Docker daily for years and I have no idea what the difference is between "convenience scripts", "other scenarios for Linux install" and "setting up a repository". I don't think a beginner has a clue what all of this means and what to do.

I'm just a user of the documentation, I have written documentation that refers to this documentation. Previously I could just refer to the Compose installation page and say "follow the instructions", that's not possible anymore. I'm not sure how I can help, but I really think this PR was merged when it shouldn't have been.

@StefanScherer
Copy link
Member

Thanks! We're looking into the formatting issues.

@dockertopia dockertopia deleted the ENGDOCS-711b branch June 7, 2022 14:43
@dockertopia
Copy link
Contributor Author

dockertopia commented Jun 7, 2022

Thanks for your feedback @mcrapts. An update is on the way to fix the typos and formatting issues you have identified. The change of the page was decided by the team in order to have installation sections across the documentation be more consistent. Removing the tabs was part of that effort. Also, using tabs was preventing us from from cross-referencing content they contained. Nevertheless, I'd be happy to collect your feedback on a separate call about what you think helps you in general in installation pages.

@mcrapts
Copy link

mcrapts commented Jun 7, 2022

I'm eager to help, reach out to me if you want to collect my further thoughts.

@mcrapts
Copy link

mcrapts commented Jun 25, 2022

It still needs work. My hypothesis: people on Linux either use docker compose or want to manually install docker-compose standalone. However the instructions for the the standalone installation are buried under the plugin installation instructions without its own subheader:
image

This looks very confusing. Already people are having difficulties finding the right installation instructions because it's super confusing.

I honestly don't understand the new installation instructions. It doesn't improve the old instructions in any way. It requires the user to so more reading, more interpretation and more scrolling.

@dockertopia
Copy link
Contributor Author

@mcrapts Is there an email where to reach you on?

@hyu hyu mentioned this pull request Oct 19, 2022
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.

6 participants