Skip to content

docs: update link targets - #4866

Merged
thaJeztah merged 2 commits into
docker:masterfrom
dvdksn:docs-cli-reference-urlscheme
Feb 21, 2024
Merged

docs: update link targets#4866
thaJeztah merged 2 commits into
docker:masterfrom
dvdksn:docs-cli-reference-urlscheme

Conversation

@dvdksn

@dvdksndvdksn commented Feb 9, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

- 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 marked this pull request as draft February 9, 2024 12:44
@dvdksn
dvdksnforce-pushed the docs-cli-reference-urlscheme branch from ec5c8e2 to 98492a6CompareFebruary 9, 2024 12:45
@codecov-commenter

codecov-commenter commented Feb 9, 2024•
edited
Loading

Copy link
Copy Markdown

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
dvdksnforce-pushed the docs-cli-reference-urlscheme branch from 98492a6 to 379b93aCompareFebruary 9, 2024 14:41
thaJeztah
thaJeztah requested changes Feb 9, 2024
View reviewed changes
Comment threaddocs/reference/commandline/cli.md Outdated
Comment threaddocs/reference/commandline/cli.md Outdated
Comment threaddocs/reference/commandline/cli.md
@dvdksn
dvdksnforce-pushed the docs-cli-reference-urlscheme branch from 379b93a to 4fc5b65CompareFebruary 9, 2024 15:59
@dvdksndvdksn mentioned this pull request Feb 9, 2024
Merged
@dvdksndvdksn changed the title docs: use absolute links for urlsdocs: use absolute links and update link targetsFeb 9, 2024
@dvdksn
dvdksn marked this pull request as ready for review February 9, 2024 16:52
@dvdksn
dvdksn requested a review from thaJeztahFebruary 9, 2024 16:53
@dvdksndvdksn added this to the 25.0.4 milestone Feb 9, 2024
@dvdksndvdksn self-assigned this Feb 9, 2024
@dvdksndvdksn mentioned this pull request Feb 11, 2024
Merged
@thaJeztahthaJeztah mentioned this pull request Feb 12, 2024
Merged
@dvdksn
dvdksnforce-pushed the docs-cli-reference-urlscheme branch 4 times, most recently from 6a67639 to 175799cCompareFebruary 13, 2024 16:51
@dvdksndvdksn changed the title docs: use absolute links and update link targetsdocs: update link targetsFeb 13, 2024
@dvdksn

dvdksn commented Feb 13, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@dvdksndvdksn mentioned this pull request Feb 15, 2024
Merged
@laurazard

laurazard commented Feb 16, 2024

Copy link
Copy Markdown
Member

Re-ran the tests ✅

@laurazard

laurazard commented Feb 16, 2024

Copy link
Copy Markdown
Member

@thaJeztah can you TAL since you left some comments?

@laurazard

laurazard commented Feb 16, 2024

Copy link
Copy Markdown
Member

Weird failures, can you rebase @dvdksn?

@dvdksn
deps: update cli-docs-tool version (v0.7.0)
e244044
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
dvdksnforce-pushed the docs-cli-reference-urlscheme branch from 175799c to 08b2e13CompareFebruary 20, 2024 07:32
@dvdksn

dvdksn commented Feb 20, 2024

Copy link
Copy Markdown
ContributorAuthor

@laurazard rebased, looks OK now

thaJeztah
thaJeztah reviewed Feb 20, 2024
View reviewed changes
Comment threaddocs/reference/commandline/plugin_create.md
thaJeztah
thaJeztah reviewed Feb 20, 2024
View reviewed changes
Comment threaddocs/reference/commandline/plugin_inspect.md
### Inspect a plugin

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

@thaJeztahthaJeztahFeb 20, 2024

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.

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

thaJeztah
thaJeztah reviewed Feb 20, 2024
View reviewed changes
Comment threaddocs/reference/dockerd.md
thaJeztah
thaJeztah reviewed Feb 20, 2024
View reviewed changes
Comment threaddocs/reference/dockerd.md
@dvdksn
docs: update url scheme for reference docs
caf7265
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
dvdksnforce-pushed the docs-cli-reference-urlscheme branch from 08b2e13 to caf7265CompareFebruary 20, 2024 20:39
thaJeztah
thaJeztah approved these changes Feb 21, 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

@thaJeztah
thaJeztah merged commit f6b7a11 into docker:masterFeb 21, 2024
@dvdksn
dvdksn deleted the docs-cli-reference-urlscheme branch February 21, 2024 08:19
@dvdksndvdksn mentioned this pull request Feb 21, 2024
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thaJeztahthaJeztahthaJeztah approved these changes

Assignees

@dvdksndvdksn

Labels

kind/docsprocess/cherry-picked

Projects

None yet

Milestone

25.0.4

Development

Successfully merging this pull request may close these issues.

5 participants

@dvdksn@codecov-commenter@laurazard@thaJeztah@vvoland