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.

Sign up for GitHub

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

Jump to bottom

Docs links in READMEs are broken #3232

Closed
GCHQDeveloper314 opened this issue Jun 6, 2024 · 0 comments · Fixed by #3233
Closed

Docs links in READMEs are broken #3232

GCHQDeveloper314 opened this issue Jun 6, 2024 · 0 comments · Fixed by #3233
Assignees
@GCHQDeveloper314
Labels
bug Confirmed or suspected bug
Milestone
v2.2.2

Comments

@GCHQDeveloper314
Copy link
Member

Describe the bug
Links from README files (e.g. develop/library/sketches-library) are not working. This is because of page structure changes in the docs.

Expected behaviour
There should be no broken links in markdown files in this repo.

Additional context
We could add a stage to the CI to check for broken links to prevent this happening in future.
@GCHQDeveloper314 GCHQDeveloper314 added the bug Confirmed or suspected bug label Jun 6, 2024
@GCHQDeveloper314 GCHQDeveloper314 added this to the v2.3.0 milestone Jun 6, 2024
@github-actions github-actions bot mentioned this issue Jun 7, 2024
Merged
@GCHQDeveloper314 GCHQDeveloper314 self-assigned this Jun 7, 2024
GCHQDeveloper314 added a commit that referenced this issue Jun 7, 2024
@GCHQDeveloper314
Gh-3232: Fix broken links in READMEs (#3233)
e4b5e15 
* Fix broken links

* Add Action CI step to check Markdown links
This should prevent problems going unnoticed in future

* Fix spark library README

* Remove direct link to road traffic data
This link seems to be a sort of redirect which doesn't resolve for the link checker
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GCHQDeveloper314 GCHQDeveloper314

Labels
bug Confirmed or suspected bug
Projects
None yet
Milestone
v2.2.2
Development

Successfully merging a pull request may close this issue.

Gh-3232: Fix broken links in READMEs gchq/Gaffer
1 participant
@GCHQDeveloper314