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

cli: move config etc to base command #19794

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Apr 12, 2024

Description

Moves information about config, env vars, and other how-tos about the Docker CLI to the base command reference page.

https://deploy-preview-19794--docsdocker.netlify.app/reference/cli/docker/

Related issues or tickets

Needs:

Reviews

  • Technical review
  • Editorial review
  • Product review

@github-actions github-actions bot added area/engine Issue affects Docker engine/daemon area/compose Relates to docker-compose.yml spec or docker-compose binary area/networking Relates to anything around networking area/hub Issue affects Docker Hub area/cli Relates to the CLI client area/api Relates to Docker API docs hugo Updates related to hugo dependencies Vendoring, packaging updates labels Apr 12, 2024
Copy link

netlify bot commented Apr 12, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 258a8dc
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/661941ef1522320008a7ab0f
😎 Deploy Preview https://deploy-preview-19794--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 configuration.

@dvdksn dvdksn marked this pull request as ready for review April 12, 2024 13:51
Copy link
Contributor Author

@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.

The description section for the base command becomes very long in this solution. While that's not incorrect in any way, it's unusual. Most of the time, it's the examples section that's overloaded. This means the Options section gets pushed way down. This might not be a blocker, but it's worth acknowledging.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn dvdksn force-pushed the cli-reference-base-command-improvements branch from 5c82454 to 258a8dc Compare April 12, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Relates to Docker API docs area/cli Relates to the CLI client area/compose Relates to docker-compose.yml spec or docker-compose binary area/engine Issue affects Docker engine/daemon area/hub Issue affects Docker Hub area/networking Relates to anything around networking dependencies Vendoring, packaging updates hugo Updates related to hugo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant