Skip to content

htmlproofer: add temporary exclusion rules to help with migration to new anchor links in reference #16461

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
Merged
thaJeztah merged 2 commits into from
Jan 7, 2023
Merged

htmlproofer: add temporary exclusion rules to help with migration to new anchor links in reference #16461

thaJeztah merged 2 commits into from
Jan 7, 2023

Conversation

@thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented Jan 7, 2023

@thaJeztah
htmlproofer: temporarily exclude buildx build
1af8b42 
The buildx build docs refers to anchors that are being updated,
but are maintained in a separate repository; exclude that page
from the validator until the anchor changes are live and the
buildx docs updated.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
htmlproofer: temporarily exclude engine/commandline/cli
e19b56d 
This page will be updated once the associated PR in docker/cli is merged.
Excluding it until then.

    Running ["LinkCheck", "ImageCheck", "ScriptCheck"] on ["./_site"] on *.html...

    Ran on 2173 files!

    - ./_site/engine/reference/commandline/cli/index.html
      *  linking to internal hash #format-the-output that does not exist (line 314)
         <a href="/engine/reference/commandline/config_ls/#format-the-output"><strong>format the output</strong> section in the  documentation</a>
      *  linking to internal hash #format-the-output that does not exist (line 318)
         <a href="/engine/reference/commandline/images/#format-the-output"><strong>format the output</strong> section in the  documentation</a>
      *  linking to internal hash #format-the-output that does not exist (line 334)
         <a href="/engine/reference/commandline/secret_ls/#format-the-output"><strong>format the output</strong> section in the  documentation</a>
      *  linking to internal hash #formatting that does not exist (line 326)
         <a href="/engine/reference/commandline/plugin_ls/#formatting"><strong>formatting</strong> section in the  documentation</a>
      *  linking to internal hash #formatting that does not exist (line 322)
         <a href="/engine/reference/commandline/node_ls/#formatting"><strong>formatting</strong> section in the  documentation</a>
      *  linking to internal hash #formatting that does not exist (line 330)
         <a href="/engine/reference/commandline/ps/#formatting"><strong>formatting</strong> section in the  documentation</a>
      *  linking to internal hash #formatting that does not exist (line 338)
         <a href="/engine/reference/commandline/service_inspect/#formatting"><strong>formatting</strong> section in the  documentation</a>
      *  linking to internal hash #formatting that does not exist (line 342)
         <a href="/engine/reference/commandline/service_ls/#formatting"><strong>formatting</strong> section in the  documentation</a>
      *  linking to internal hash #formatting that does not exist (line 346)
         <a href="/engine/reference/commandline/stats/#formatting"><strong>formatting</strong> section in the  documentation</a>

    HTML-Proofer found 9 failures!

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah thaJeztah added area/engine Issue affects Docker engine/daemon area/build Relates to Dockerfiles or docker build command labels Jan 7, 2023
@netlify
Copy link

netlify bot commented Jan 7, 2023 •
edited
Loading

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit e19b56d
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/63b969f72506080008dd0410
😎 Deploy Preview https://deploy-preview-16461--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 settings.

@thaJeztah
Copy link
Member Author

thaJeztah commented Jan 7, 2023

Not sure what the best moment is for this one; I guess it’s okay to already get it in, and (temporarily) have no coverage for those two pages; meanwhile we can fix the anchors in buildx, and remove the one from engine once docker/cli#3525 is merged.

If we don’t exclude them, CI will be broken once we merge docker/cli#3525

This was referenced Jan 7, 2023
Merged
Merged
@thaJeztah
Copy link
Member Author

thaJeztah commented Jan 7, 2023

Opened docker/buildx#1493 to fix the anchors for validation. I should add that the old anchors actually work, but that the html validation will fail on them (as there's two anchors for headings)

@thaJeztah thaJeztah marked this pull request as ready for review January 7, 2023 14:21
@thaJeztah thaJeztah requested a review from crazy-max January 7, 2023 14:22
@thaJeztah thaJeztah mentioned this pull request Jan 7, 2023
Merged
@thaJeztah
Copy link
Member Author

thaJeztah commented Jan 7, 2023

Thx! Let me bring this one in, and cleanup some of the other PRs 👍

@thaJeztah thaJeztah merged commit 5adc36d into docker:main Jan 7, 2023
@thaJeztah thaJeztah deleted the htmlproofer_temporary_excludes branch January 7, 2023 15:26
@thaJeztah thaJeztah mentioned this pull request Jan 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@crazy-max crazy-max crazy-max approved these changes

Assignees

No one assigned

Labels

area/build Relates to Dockerfiles or docker build command area/engine Issue affects Docker engine/daemon

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@thaJeztah @crazy-max