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

Add local link checking to read the docs #3793

Closed
Ldcabansay opened this issue Sep 4, 2020 · 2 comments
Closed

Add local link checking to read the docs #3793

Ldcabansay opened this issue Sep 4, 2020 · 2 comments

Comments

@Ldcabansay
Copy link
Contributor

Ldcabansay commented Sep 4, 2020

Is your feature request related to a problem? Please describe.
We currently only test for broken external links when doing link checks on read the docs. We should add local link checks so errors/warnings pop up when references to internal links are broken.

Describe the solution you'd like
make linkcheck should also check for broken internal links and give errors when found. Consider how link checks will relate to re-directs (if necessary).

Describe alternatives you've considered
We also can enforce an SOP that uses preferred way to refer to local links (ie only absolute paths, only certain types of referencing styles, etc)

Additional context
This is part of the documentation overhaul, should probably be completed before/during adding re-directs.

┆Issue is synchronized with this Jira Story
┆Issue Number: DOCK-1570
┆Sprint: Backlog
┆Issue Type: Story

@melainalegaspi
Copy link

@Richard-Hansen completed this

@coverbeck
Copy link
Contributor

Fixed via dockstore/dockstore-documentation#85

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

No branches or pull requests

3 participants