Skip to content
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

Compose command doc #12433

Merged
merged 8 commits into from
Mar 9, 2021
Merged

Compose command doc #12433

merged 8 commits into from
Mar 9, 2021

Conversation

gtardif
Copy link
Collaborator

@gtardif gtardif commented Mar 3, 2021

Proposed changes

Add presentation of the compose in docker CLI command, and compatibility list with docker-compose
Does not yet include updates on the compose install part

Signed-off-by: Guillaume Tardif <[email protected]>
@gtardif gtardif marked this pull request as draft March 3, 2021 12:30
@netlify
Copy link

netlify bot commented Mar 3, 2021

Deploy preview for docsdocker ready!

Built with commit ffc980b

https://deploy-preview-12433--docsdocker.netlify.app

@gtardif gtardif requested a review from usha-mandya March 3, 2021 12:37
@gtardif gtardif force-pushed the compose_command_doc branch from c976f46 to cfd9066 Compare March 3, 2021 13:09
_data/toc.yaml Outdated Show resolved Hide resolved
compose/cli-command-compatibility.md Show resolved Hide resolved
ndeloof
ndeloof previously approved these changes Mar 5, 2021
_data/toc.yaml Outdated Show resolved Hide resolved
@@ -0,0 +1,49 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

This page appears as an orphan page - https://deploy-preview-12433--docsdocker.netlify.app/compose/cli-command-compatibility/. It must be linked from the toc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I thought linking it from the compose tech preview page was OK. Is it mandatory to make it appear in the TOC. (fine for me if we prefer to link everything in TOC)

Copy link
Member

Choose a reason for hiding this comment

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

Yes, we should ideally link it from the toc. If users land on this page, there's no context if they want to go back to a previous page, or select a different topic.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added Compose Tech preview compatibility section just next to Compose CLI Tech Preview

Choose a reason for hiding this comment

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

Should we make 'Compatibility' as a subsection of 'Compose CLI'? I am concerned that having two separate Tech Preview sections in TOC may make it seem like there are two separate Tech Previews...

Copy link
Member

Choose a reason for hiding this comment

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

Yea, agree. We can add that as a subsection.

@gtardif gtardif force-pushed the compose_command_doc branch from c99483c to 14121a0 Compare March 5, 2021 11:23
Co-authored-by: Usha Mandya <[email protected]>
@gtardif gtardif force-pushed the compose_command_doc branch from 14121a0 to 9e5cd1b Compare March 5, 2021 11:24
compose/cli-command.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
Co-authored-by: Usha Mandya <[email protected]>
@gtardif gtardif force-pushed the compose_command_doc branch 2 times, most recently from 0f30a88 to d4628b9 Compare March 5, 2021 14:42
Signed-off-by: Guillaume Tardif <[email protected]>
@gtardif gtardif force-pushed the compose_command_doc branch from d4628b9 to 937e7cd Compare March 5, 2021 14:46
compose/cli-command.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
@usha-mandya usha-mandya requested a review from mkvitnitsky March 5, 2021 15:34
Signed-off-by: Guillaume Tardif <[email protected]>
@gtardif gtardif force-pushed the compose_command_doc branch from 661b0f9 to a5b1f25 Compare March 5, 2021 16:12
@gtardif gtardif marked this pull request as ready for review March 5, 2021 16:14
@ndeloof
Copy link
Contributor

ndeloof commented Mar 8, 2021

As suggested on https://github.com/docker/docker.github.io/issues/12454, CLI reference should include a compose subcommand

compose/cli-command-compatibility.md Show resolved Hide resolved
compose/cli-command-compatibility.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
compose/cli-command.md Outdated Show resolved Hide resolved
@@ -0,0 +1,49 @@
---

Choose a reason for hiding this comment

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

Should we make 'Compatibility' as a subsection of 'Compose CLI'? I am concerned that having two separate Tech Preview sections in TOC may make it seem like there are two separate Tech Previews...

Signed-off-by: Guillaume Tardif <[email protected]>
@gtardif
Copy link
Collaborator Author

gtardif commented Mar 9, 2021

Should we make 'Compatibility' as a subsection of 'Compose CLI'? I am concerned that having two separate Tech Preview sections in TOC may make it seem like there are two separate Tech Previews...

I rephrased it Compose CLI compatibility, so that the 2 sections are

Compose CLI Tech Preview
Compose CLI compatibility

(having a subsection on a real page is a bit cumbersome)

@gtardif
Copy link
Collaborator Author

gtardif commented Mar 9, 2021

As suggested on https://github.com/docker/docker.github.io/issues/12454, CLI reference should include a compose subcommand

Agreed, but can be done as a separate PR on top of this one.
I tried to simply link the cli-command page from a single compose entry in the reference list, the navigation between reference and product section is too weird, we need to have a proper compose cli reference, like docker-archive/compose-cli#1407

@gtardif
Copy link
Collaborator Author

gtardif commented Mar 9, 2021

Added a subsection:
Screenshot 2021-03-09 at 11 38 15

Copy link
Member

@usha-mandya usha-mandya left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @gtardif

@usha-mandya usha-mandya merged commit fd6a291 into docker:master Mar 9, 2021
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