-
Notifications
You must be signed in to change notification settings - Fork 8k
ENGDOCS 711 Revisited Compose Install Page #14838
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
Conversation
✅ Deploy Preview for docsdocker ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this 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.
There was a problem hiding this 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.
There was a problem hiding this 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
There was a problem hiding this 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.
|
@aevesdocker I will only edit this section to accommodate the reordering that Guillaume and Stefan suggest and that makes total sense. |
There was a problem hiding this 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.
There was a problem hiding this 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.
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>
|
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.
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. |
|
Thanks! We're looking into the formatting issues. |
|
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. |
|
I'm eager to help, reach out to me if you want to collect my further thoughts. |
|
It still needs work. My hypothesis: people on Linux either use 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. |
|
@mcrapts Is there an email where to reach you on? |





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