Skip to content

Canonical CLI / moby 25 - #19045

Merged
dvdksn merged 6 commits into
docker:mainfrom
dvdksn:cli-canonical-reference-urls
Jan 19, 2024
Merged

Canonical CLI / moby 25#19045
dvdksn merged 6 commits into
docker:mainfrom
dvdksn:cli-canonical-reference-urls

Conversation

@dvdksn

@dvdksndvdksn commented Jan 5, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

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

netlifyBot commented Jan 5, 2024•
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for docsdocker ready!

NameLink
🔨 Latest commit3855262
🔍 Latest deploy loghttps://app.netlify.com/sites/docsdocker/deploys/65aa91acb76c6400086a6088
😎 Deploy Previewhttps://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-actionsgithub-actionsBot 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 hugo Updates related to hugo labels Jan 5, 2024
@dvdksn
dvdksnforce-pushed the cli-canonical-reference-urls branch from c7234cc to 88fc5dbCompareJanuary 5, 2024 16:42
@dvdksndvdksn changed the title cli canonical reference urls[WIP] Use canonical URLs for CLI referenceJan 5, 2024
dvdksn
dvdksn commented Jan 5, 2024
View reviewed changes
Comment threadhugo.yaml Outdated
title: Docker Docs
baseURL: https://docs.docker.com
refLinksErrorLevel: ERROR
refLinksErrorLevel: WARNING

@dvdksndvdksnJan 5, 2024

Copy link
Copy Markdown
ContributorAuthor

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

thaJeztah commented Jan 5, 2024

Copy link
Copy Markdown
Member

Also related;

@dvdksn
dvdksnforce-pushed the cli-canonical-reference-urls branch 3 times, most recently from d6c41f5 to daa4db4CompareJanuary 10, 2024 09:11
@dvdksndvdksn mentioned this pull request Jan 11, 2024
Merged
@dvdksn
dvdksnforce-pushed the cli-canonical-reference-urls branch from daa4db4 to 51a8f72CompareJanuary 11, 2024 11:36
neersighted
neersighted approved these changes Jan 11, 2024
View reviewed changes

@neersightedneersighted left a comment

Copy link
Copy Markdown
Contributor

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.

@dvdksndvdksn mentioned this pull request Jan 11, 2024
Merged
@dvdksn
dvdksnforce-pushed the cli-canonical-reference-urls branch from 51a8f72 to b941d32CompareJanuary 15, 2024 13:20
@dvdksndvdksn 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
dvdksnforce-pushed the cli-canonical-reference-urls branch from b941d32 to 3855262CompareJanuary 19, 2024 15:13
@github-actionsgithub-actionsBot added area/api Relates to Docker API docs dependencies Vendoring, packaging updates labels Jan 19, 2024
@dvdksndvdksn changed the title [WIP] Use canonical URLs for CLI reference[WIP] Canonical CLI / moby 25Jan 19, 2024
@dvdksn
dvdksn marked this pull request as ready for review January 19, 2024 15:14
@dvdksndvdksn self-assigned this Jan 19, 2024
@dvdksndvdksn changed the title [WIP] Canonical CLI / moby 25Canonical CLI / moby 25Jan 19, 2024
thaJeztah
thaJeztah approved these changes Jan 19, 2024
View reviewed changes

@thaJeztahthaJeztah left a comment

Copy link
Copy Markdown
Member

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:mainJan 19, 2024
@dvdksn
dvdksn deleted the cli-canonical-reference-urls branch January 19, 2024 15:30
@thaJeztahthaJeztah mentioned this pull request Apr 24, 2025
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thaJeztahthaJeztahthaJeztah approved these changes
@aevesdockeraevesdockerAwaiting requested review from aevesdocker
@craig-osterhoutcraig-osterhoutAwaiting requested review from craig-osterhout
@stephaureliostephaurelioAwaiting requested review from stephaurelio
@crazy-maxcrazy-maxAwaiting requested review from crazy-max
+3 more reviewers
@rumplrumplrumpl approved these changes
@neersightedneersightedneersighted approved these changes
@sam-thibaultsam-thibaultsam-thibault approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@dvdksndvdksn

Labels

area/apiRelates to Docker API docsarea/buildRelates to Dockerfiles or docker build commandarea/cliRelates to the CLI clientarea/composeRelates to docker-compose.yml spec or docker-compose binaryarea/desktopIssue affects a desktop edition of Docker. E.g docker for macarea/get-startedRelates to get started and onboarding docsarea/hubIssue affects Docker Hubarea/networkingRelates to anything around networkingdependenciesVendoring, packaging updateshugoUpdates related to hugo

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@dvdksn@thaJeztah@rumpl@neersighted@sam-thibault