Skip to content

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
@netlify
Copy link

netlify bot commented Apr 12, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit b9ca733
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6684002e2a54ef00089e9af7
😎 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 requested review from crazy-max and thaJeztah April 12, 2024 13:50
@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.

@dvdksn dvdksn force-pushed the cli-reference-base-command-improvements branch from 5c82454 to 258a8dc Compare April 12, 2024 14:15
dvdksn added 2 commits July 2, 2024 15:25
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 258a8dc to b9ca733 Compare July 2, 2024 13:27
@dvdksn
Copy link
Contributor Author

dvdksn commented Aug 14, 2024

Already merged via #20573

@dvdksn dvdksn closed this Aug 14, 2024
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.

1 participant