Skip to content

Conversation

@crazy-max
Copy link
Member

@crazy-max crazy-max commented Jul 19, 2022

needs docker/docs#14905 or docker/docs#15194

adds a job to check if links are still valid with upstream docs repository.

Signed-off-by: CrazyMax crazy-max@users.noreply.github.com

@crazy-max crazy-max force-pushed the validate-docs-upstream branch from 7db4da9 to 2966018 Compare July 19, 2022 17:25
@crazy-max crazy-max marked this pull request as draft July 19, 2022 17:29
@crazy-max crazy-max force-pushed the validate-docs-upstream branch 4 times, most recently from d19ebd8 to e57937d Compare July 30, 2022 23:01
@crazy-max crazy-max requested review from jedevc and tonistiigi July 30, 2022 23:06
@crazy-max crazy-max marked this pull request as ready for review July 30, 2022 23:06
Copy link
Member

@tonistiigi tonistiigi left a comment

Choose a reason for hiding this comment

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

Does this tool actually pull down all the URLs (comments could help).

If it does could we filter this to only run on master or if *.md changes etc.

@crazy-max crazy-max force-pushed the validate-docs-upstream branch from e57937d to b39ada8 Compare August 2, 2022 00:49
@crazy-max
Copy link
Member Author

Does this tool actually pull down all the URLs (comments could help).

Yes it will run the validation for the whole docs repo as cross links could be broken outside our scope so we can take that into account and react accordingly (here or on docs repo).

If it does could we filter this to only run on master or if *.md changes etc.

Done


Also added reference yaml docs that was not covered in the validation and we have a dead link: https://github.com/docker/buildx/runs/7622740288?check_suite_focus=true#step:8:667

#23 166.5 - ./_site/engine/reference/commandline/buildx_build/index.html
#23 166.5   *  internally linking to /build/guides/color-output/, which does not exist (line 1040)
#23 166.5      <a href="/build/guides/color-output/">Color output controls guide</a>

Fixed with last commit.

@crazy-max crazy-max requested a review from tonistiigi August 2, 2022 09:19
@crazy-max crazy-max force-pushed the validate-docs-upstream branch 3 times, most recently from def27c3 to 69be01f Compare August 2, 2022 18:54
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max force-pushed the validate-docs-upstream branch from 69be01f to cceb1ac Compare August 2, 2022 19:22
@tonistiigi tonistiigi merged commit cf809ae into docker:master Aug 3, 2022
@crazy-max crazy-max deleted the validate-docs-upstream branch August 3, 2022 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants