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

docs: fix broken links to alias pages #4800

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Jan 19, 2024

Alias pages redirect to the canonical names, but these pages still
linked to the aliases, causing broken links when building the docs site.

Also moved the CLI reference for the docker base command from cli.md to docker.md and disabled workaround for regenerating the CLI reference to the non-canonical page.

Signed-off-by: David Karlsson 35727626+dvdksn@users.noreply.github.com

- What I did

- How I did it

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

Alias pages redirect to the canonical names, but these pages still
linked to the aliases, causing broken links when building the docs site.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@codecov-commenter
Copy link

codecov-commenter commented Jan 19, 2024

Codecov Report

Merging #4800 (d633890) into master (e758fe5) will not change coverage.
Report is 2 commits behind head on master.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4800   +/-   ##
=======================================
  Coverage   59.63%   59.63%           
=======================================
  Files         287      287           
  Lines       24777    24777           
=======================================
  Hits        14775    14775           
  Misses       9114     9114           
  Partials      888      888           

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

CLI reference for the base command was generated to cli.md

Changed it to docker.md to handle broken links.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn dvdksn force-pushed the docs-fix-broken-alias-links branch from 9610e21 to d633890 Compare January 19, 2024 13:44
@dvdksn dvdksn requested a review from thaJeztah January 19, 2024 13:52
@thaJeztah thaJeztah merged commit 1c73abb into docker:master Jan 19, 2024
77 checks passed
@dvdksn dvdksn deleted the docs-fix-broken-alias-links branch January 19, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants