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

Fix broken links [#1133] #1137

Merged
merged 14 commits into from
Aug 15, 2024
Merged

Fix broken links [#1133] #1137

merged 14 commits into from
Aug 15, 2024

Conversation

genehack
Copy link
Contributor

@genehack genehack commented Aug 9, 2024

Description of proposed changes

Adds linkchecking config, fixes almost all the broken links, and temporarily ignores 2 internal URLs where I need further guidance on the correct fix.

Related issue(s)

Closes #1133
#1135
#1136
nextstrain/.github#29

Copy link
Member

@victorlin victorlin left a comment

Choose a reason for hiding this comment

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

Added a non-blocking comment, a clarifying question, and a requested change. Everything else looks good.

docs/src/guides/data-prep/local-data.rst Outdated Show resolved Hide resolved
docs/src/reference/change_log.md Outdated Show resolved Hide resolved
docs/src/reference/workflow-config-file.rst Show resolved Hide resolved
@genehack genehack force-pushed the fix-broken-links-1133 branch 4 times, most recently from 3fd1204 to c9f7cfa Compare August 13, 2024 20:05
Note: this contains 2 URLs in the `linkcheck_ignore` section that need
to be fixed; each has an associated FIXME comment linking to a Github
issue.

I'm ignoring those temporarily so that after this PR is merged, `make
linkcheck` will exit without error in this repo, which will unblock
activating linkchecking in _all_ the CI doc builds.
…1133]

The linkchecker doesn't recognize the text fragment thing as a real
anchor, so just exclude that from the full anchor check.
Known-good URL is failing for technical reasons related to how
nextstrain.org handles routing datasets without a default.

[Slack context](https://bedfordlab.slack.com/archives/C0K3GS3J8/p1723571470133649)
GISAID is returning 301 on `www.gisaid.org` links, so let's respect it
and update our URLs.

Also correct some URLs to where they ultimately redirect.
* switch `tree` to `blob`, because they 301 that way
* swap `master` for `-`, for future-proofing
@genehack genehack merged commit 8e33e22 into master Aug 15, 2024
7 checks passed
@genehack genehack deleted the fix-broken-links-1133 branch August 15, 2024 15: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.

Fix broken links in docs
2 participants