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: update link targets #4866

Merged
merged 2 commits into from
Feb 21, 2024
Merged

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Feb 9, 2024

- What I did

Moving the files to a different URL scheme on docs.docker.com breaks some of the links in this repository. docker/docs#19370

I've updated the affected links, and also patched the yaml generation in cli-docs-tool to handle the URL path discrepancy that now exists between this repository and the website. docker/cli-docs-tool#49

- How I did it

- How to verify it

- Description for the changelog

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

@dvdksn dvdksn requested a review from thaJeztah as a code owner February 9, 2024 12:44
@dvdksn dvdksn marked this pull request as draft February 9, 2024 12:44
@dvdksn dvdksn force-pushed the docs-cli-reference-urlscheme branch from ec5c8e2 to 98492a6 Compare February 9, 2024 12:45
@codecov-commenter
Copy link

codecov-commenter commented Feb 9, 2024

Codecov Report

Merging #4866 (caf7265) into master (20b9d48) will not change coverage.
Report is 1 commits behind head on master.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4866   +/-   ##
=======================================
  Coverage   61.32%   61.32%           
=======================================
  Files         287      287           
  Lines       20063    20063           
=======================================
  Hits        12303    12303           
  Misses       6867     6867           
  Partials      893      893           

@dvdksn dvdksn force-pushed the docs-cli-reference-urlscheme branch from 98492a6 to 379b93a Compare February 9, 2024 14:41
@dvdksn dvdksn force-pushed the docs-cli-reference-urlscheme branch from 379b93a to 4fc5b65 Compare February 9, 2024 15:59
@dvdksn dvdksn changed the title docs: use absolute links for urls docs: use absolute links and update link targets Feb 9, 2024
@dvdksn dvdksn marked this pull request as ready for review February 9, 2024 16:52
@dvdksn dvdksn requested a review from thaJeztah February 9, 2024 16:53
@dvdksn dvdksn added this to the 25.0.4 milestone Feb 9, 2024
@dvdksn dvdksn self-assigned this Feb 9, 2024
@dvdksn dvdksn force-pushed the docs-cli-reference-urlscheme branch 4 times, most recently from 6a67639 to 175799c Compare February 13, 2024 16:51
@dvdksn dvdksn changed the title docs: use absolute links and update link targets docs: update link targets Feb 13, 2024
@dvdksn
Copy link
Contributor Author

dvdksn commented Feb 13, 2024

not sure what the failing tests are here but probably not related? @thaJeztah

@laurazard
Copy link
Collaborator

Re-ran the tests ✅

@laurazard
Copy link
Collaborator

@thaJeztah can you TAL since you left some comments?

@laurazard
Copy link
Collaborator

Weird failures, can you rebase @dvdksn?

@dvdksn dvdksn force-pushed the docs-cli-reference-urlscheme branch from 175799c to 08b2e13 Compare February 20, 2024 07:32
@dvdksn
Copy link
Contributor Author

dvdksn commented Feb 20, 2024

@laurazard rebased, looks OK now

The following example example inspects the `tiborvass/sample-volume-plugin` plugin:
The following example inspects the `tiborvass/sample-volume-plugin` plugin:
Copy link
Member

Choose a reason for hiding this comment

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

Hm... we need to enable the "dupwords" linter. But perhaps it only checks Go code, and not markdown files 🤔

@dvdksn dvdksn requested a review from thaJeztah February 20, 2024 09:46
@dvdksn dvdksn force-pushed the docs-cli-reference-urlscheme branch from 08b2e13 to caf7265 Compare February 20, 2024 20:39
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

@thaJeztah thaJeztah merged commit f6b7a11 into docker:master Feb 21, 2024
88 checks passed
@dvdksn dvdksn deleted the docs-cli-reference-urlscheme branch February 21, 2024 08:19
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.

5 participants