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.

Sign up for GitHub

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

Jump to bottom

Canonical CLI / moby 25 #19045

Merged
merged 6 commits into from Jan 19, 2024
Merged

Canonical CLI / moby 25 #19045

merged 6 commits into from Jan 19, 2024

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Jan 5, 2024 •
edited

Proposed changes

  • Remove page stubs for legacy aliases
  • Consolidate the CLI reference on canonical commands and add redirects
  • Show command aliases on the CLI reference pages
  • Fix broken links
  • Update dependencies for moby, compose, cli, and regenerate docker/cli and docker/buildx yaml

Related issues (optional)

@netlify Netlify
Copy link

netlify bot commented Jan 5, 2024 •
edited

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 3855262
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/65aa91acb76c6400086a6088
😎 Deploy Preview https://deploy-preview-19045--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.

@github-actions github-actions bot added 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/build Relates to Dockerfiles or docker build command area/desktop Issue affects a desktop edition of Docker. E.g docker for mac area/cli Relates to the CLI client area/get-started Relates to get started and onboarding docs area/configuration Relates to configuring containers hugo Updates related to hugo labels Jan 5, 2024
@dvdksn dvdksn force-pushed the cli-canonical-reference-urls branch from c7234cc to 88fc5db Compare January 5, 2024 16:42
@dvdksn dvdksn changed the title cli canonical reference urls [WIP] Use canonical URLs for CLI reference Jan 5, 2024
dvdksn
dvdksn commented Jan 5, 2024
View reviewed changes
hugo.yaml Outdated
@@ -1,6 +1,6 @@
title: Docker Docs
baseURL: https://docs.docker.com
refLinksErrorLevel: ERROR
refLinksErrorLevel: WARNING
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a temporary change to make the site build until we can vendor the latest version of docker/cli which contains a fix

@thaJeztah
Copy link
Member

Also related;

@dvdksn dvdksn force-pushed the cli-canonical-reference-urls branch 3 times, most recently from d6c41f5 to daa4db4 Compare January 10, 2024 09:11
@dvdksn dvdksn mentioned this pull request Jan 11, 2024
Merged
@dvdksn dvdksn force-pushed the cli-canonical-reference-urls branch from daa4db4 to 51a8f72 Compare January 11, 2024 11:36
neersighted
neersighted approved these changes Jan 11, 2024
View reviewed changes
Copy link
Member

@neersighted neersighted left a comment

Choose a reason for hiding this comment

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

Not a docs-reviewer and haven't reviewed the implementation, but the preview looks like an excellent across-the-board improvement to me. The nav is much more usable and the concerns regarding user confusion due to canonicalization of commands are mostly addressed by the parenthetical titles for well-known commands.

@dvdksn dvdksn mentioned this pull request Jan 11, 2024
Merged
@dvdksn dvdksn force-pushed the cli-canonical-reference-urls branch from 51a8f72 to b941d32 Compare January 15, 2024 13:20
@dvdksn dvdksn mentioned this pull request Jan 16, 2024
Merged
@dvdksn
cli: remove alias stubs
04de43a 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
hugo: display command aliases
f0260db 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
vendor: github.com/docker/cli 01f933261885
5ff4adf 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
vendor: github.com/moby/moby v25.0.0
61d4f18 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
vendor: github.com/docker/compose 3881690
368f2f2 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
build: regen buildx cli 68c3ac4
3855262 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn dvdksn force-pushed the cli-canonical-reference-urls branch from b941d32 to 3855262 Compare January 19, 2024 15:13
@github-actions github-actions bot added area/api Relates to Docker API docs dependencies Vendoring, packaging updates labels Jan 19, 2024
@dvdksn dvdksn changed the title [WIP] Use canonical URLs for CLI reference [WIP] Canonical CLI / moby 25 Jan 19, 2024
@dvdksn dvdksn marked this pull request as ready for review January 19, 2024 15:14
@dvdksn dvdksn self-assigned this Jan 19, 2024
@dvdksn dvdksn changed the title [WIP] Canonical CLI / moby 25 Canonical CLI / moby 25 Jan 19, 2024
thaJeztah
thaJeztah approved these changes Jan 19, 2024
View reviewed changes
Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

@dvdksn dvdksn merged commit ade4ebd into docker:main Jan 19, 2024
9 checks passed
@dvdksn dvdksn deleted the cli-canonical-reference-urls branch January 19, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rumpl rumpl rumpl approved these changes

@neersighted neersighted neersighted approved these changes

@thaJeztah thaJeztah thaJeztah approved these changes

@sam-thibault sam-thibault sam-thibault approved these changes

@aevesdocker aevesdocker Awaiting requested review from aevesdocker aevesdocker is a code owner

@craig-osterhout craig-osterhout Awaiting requested review from craig-osterhout craig-osterhout is a code owner

@stephaurelio stephaurelio Awaiting requested review from stephaurelio stephaurelio is a code owner

@crazy-max crazy-max Awaiting requested review from crazy-max crazy-max is a code owner

Assignees

@dvdksn dvdksn

Labels
area/api Relates to Docker API docs area/build Relates to Dockerfiles or docker build command area/cli Relates to the CLI client area/compose Relates to docker-compose.yml spec or docker-compose binary area/configuration Relates to configuring containers area/desktop Issue affects a desktop edition of Docker. E.g docker for mac area/get-started Relates to get started and onboarding docs 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@dvdksn @thaJeztah @rumpl @neersighted @sam-thibault