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: add devenv and linkcheck to Makefile and misc details #1565

Merged
merged 12 commits into from Nov 2, 2022

Conversation

@consideRatio consideRatio marked this pull request as draft October 21, 2022 12:17
@consideRatio consideRatio added the maintenance Under the hood improvements and fixes label Oct 21, 2022
@consideRatio consideRatio force-pushed the pr/docs-maintenance branch 6 times, most recently from 7e23b0a to a8ca73a Compare October 22, 2022 09:49
@consideRatio consideRatio force-pushed the pr/docs-maintenance branch 2 times, most recently from 9a65773 to 886d65e Compare October 22, 2022 10:15
@consideRatio consideRatio added documentation and removed maintenance Under the hood improvements and fixes labels Oct 22, 2022
@consideRatio consideRatio marked this pull request as ready for review October 22, 2022 11:02
@consideRatio consideRatio changed the title docs maintenance: add devenv and linkcheck to Makefile and misc details docs: add devenv and linkcheck to Makefile and misc details Oct 22, 2022
With documentation in plain markdown and as built myst-markdown we got
warnings about the links referencing section headers by name in myst.
Like this, we ensure that the built documentation works great instead of
compromising on that and getting warnings about it when building the
documentation.
@minrk minrk merged commit 559edf4 into jupyterhub:main Nov 2, 2022
consideRatio pushed a commit to jupyterhub/helm-chart that referenced this pull request Nov 2, 2022
jupyterhub/binderhub#1565 Merge pull request #1565 from consideRatio/pr/docs-maintenance
@minrk
Copy link
Member

minrk commented Nov 2, 2022

Merging, since it's good to have these. But linkcheck's not run on CI, is it? Should that be a new workflow? Or is there a way to run linkcheck on RTD only on PRs (because real docs builds shouldn't be prevented if a link breaks)?

@consideRatio
Copy link
Member Author

I think having linkcheck in the ci system for push and prs is too much noise overall, having a weekly/monthly run via schedule and a badge for failing or not in the project readme could make sense i think.

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.

None yet

2 participants