Skip to content

ENGDOCS-1020 #15857

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

Merged
merged 4 commits into from
Oct 21, 2022
Merged

ENGDOCS-1020 #15857

merged 4 commits into from
Oct 21, 2022

Conversation

aevesdocker
Copy link
Contributor

@aevesdocker aevesdocker commented Oct 12, 2022

No new content added, just moving it around

@netlify
Copy link

netlify bot commented Oct 12, 2022

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 9c403f3
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/635290d6e20112000acc592d
😎 Deploy Preview https://deploy-preview-15857--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.

@hyu
Copy link
Contributor

hyu commented Oct 19, 2022

Looks good! Here are the changes I noticed:

  • Simplified and standardized titles in header (nice!)
  • Removed "About Docker Desktop" screenshot from overview, since its size was giving it undue importance.
  • In Overview, frame install options as 3 scenarios. (I like that this explicit hierarchy directs most users to 1.)
  • Removed "where to go next" from plugin install page, making it more consistent with the standalone install page.

All of these seem like solid improvements to me. Let me know if I missed anything, though!

 

Reference

(I found myself wondering what had changed in the recent iterations. Hope this is useful to you too!)

Merged 7/2 Merged 8/26 Current PR
ENGDOCS 711 PR 15494
image image image

@hyu
Copy link
Contributor

hyu commented Oct 19, 2022

This is a nit that's possibly out of scope!

...

When a tip box immediately follows a heading, there doesn't seem to be enough vertical space. For example, in this plugin install section:

image

 
The spacing is better elsewhere in docs, where there's a line between the header and the tip. Like on Install Docker Desktop:
image

@hyu
Copy link
Contributor

hyu commented Oct 19, 2022

Not blocking, but I do wonder whether it's possible to offer a bit more context on why a user would choose to install Compose standalone?

For Scenario two, we do imply that you might want the plugin if you already have Docker Engine and CLI, and don't want to install DD for whatever reason. Is there some extra bit of info we can similarly offer for Scenario three?

(I apologize that I myself don't actually know how to contextualize this! My vague understanding is that we don't much support this install route, but offer it nonetheless for legacy reasons? CCing @StefanScherer in case he might have more context.)

image

@StefanScherer
Copy link
Member

Yes, installing compose v2 standalone is only for legacy reasons, maybe users have lots of scripts that use docker-compose instead of docker compose and don't want to migrate or just don't know that there now is the plugin. The Windows Server use case is also probably a very rare one, that's probably only for test purposes.
Another use case might be to have the cli and compose installed on Mac or Windows to use them with a manually local VM or a remote Docker Engine.

Looking at package managers that help installing docker-compose show at least some interest on Mac via homebrew, but on Windows I was never asked to update the docker-compose chocolatey package beyond v1.

@aevesdocker
Copy link
Contributor Author

aevesdocker commented Oct 21, 2022

Thank you for the feedback @hyu and extra context @StefanScherer.

Re: adding extra context for scenario three.
Seeing as we no longer support this option, and there are simply edge cases as to why someone would choose this option, I wonder if it's better simply to add just a warning note saying we no longer support it and make this scenario as unappealing as possible? Users who still decide this is the option for them surely know what they're doing and are advanced users.

Re: tip box formatting
@hyu, yes unfortunately out of scope for this PR as it involves mucking around with the CSS. I have a weekly working session with Shadi to fix these kinds of issues throughout the docs, so shall add it to the agenda

@hyu
Copy link
Contributor

hyu commented Oct 21, 2022

This seems like the right approach!

Seeing as we no longer support this option, and there are simply edge cases as to why someone would choose this option, I wonder if it's better simply to add just a warning note saying we no longer support it and make this scenario as unappealing as possible? Users who still decide this is the option for them surely know what they're doing and are advanced users.

@aevesdocker aevesdocker marked this pull request as ready for review October 21, 2022 13:41
@aevesdocker aevesdocker requested review from dvdksn and removed request for usha-mandya October 21, 2022 13:42
Copy link
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

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

LGTM!

@aevesdocker aevesdocker merged commit f5a7485 into docker:master Oct 21, 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.

4 participants