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

Revert "ci/docs: Add mdbook-linkcheck" #533

Merged
merged 1 commit into from
May 15, 2024

Conversation

cgwalters
Copy link
Collaborator

@cgwalters cgwalters commented May 15, 2024

This reverts commit 4f2a30c. It broke the main docs site.

Closes: #532

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 15, 2024
Copy link
Member

@vrothberg vrothberg left a comment

Choose a reason for hiding this comment

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

LGTM
Are the docs rebuilt for each PR so we can double-check?

This reverts commit 4f2a30c.
It broke the main docs site.

Signed-off-by: Colin Walters <walters@verbum.org>
@cgwalters cgwalters merged commit 122827a into containers:main May 15, 2024
6 checks passed
@cgwalters
Copy link
Collaborator Author

They're built on pushes to git main, yes.

BTW I tested this change by pushing to my fork and verified it works; anyone hacking on the docs should have this as a SOP.

@jeckersb
Copy link
Contributor

They're built on pushes to git main, yes.

BTW I tested this change by pushing to my fork and verified it works; anyone hacking on the docs should have this as a SOP.

I see what happened here. Previously, the html would land directly into docs/book, but since introducing linkcheck adds another backend, it goes into docs/book/html instead (and there's a docs/book/linkcheck where linkcheck does whatever it does). I did test this locally, but I didn't notice that the directory changed so I just followed the extra html subdir without thinking much about it.

I just enabled the docs workflow on my fork, and tested this with the old PR and confirmed the deployed docs gives a 404, but if you append /html the docs are there correctly. This is a one-line fix in the upload step to use the html subdir instead, which is now working correctly on my fork. I'll put in an updated PR with the fixed version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation site is unavailable
3 participants