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

github workflow to validate internal and external links #22

Open
Tracked by #5
negin513 opened this issue Oct 13, 2023 · 0 comments
Open
Tracked by #5

github workflow to validate internal and external links #22

negin513 opened this issue Oct 13, 2023 · 0 comments
Labels
enhancement For improvements to existing documentation. (Expanding upon existing docs). help wanted Extra attention is needed.

Comments

@negin513
Copy link
Collaborator

negin513 commented Oct 13, 2023

Our repo, which includes hpc docs is undergoing rapid development and frequent updates and addition.
In this stage of development, ensuring that all internal and external links within docs files are valid and not leading to 404 (or other error) pages is critical to (1) streamline the PR reviews and (2) maintaining the reliability and quality of the docs.

I would suggest:

  • Implement a GitHub workflow that automatically validates all internal and external links in the markdown (.md) or other documentation files.

The workflow should be triggered:

  1. Every PR and push
  2. Nightly in case links changes...

Here is an example for reference.

@negin513 negin513 changed the title Implement CI to validate all links within a Pull Request (PR) and display their status. github workflow to validate internal and external links Oct 13, 2023
@negin513 negin513 added the enhancement For improvements to existing documentation. (Expanding upon existing docs). label Oct 13, 2023
@benkirk benkirk added the help wanted Extra attention is needed. label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement For improvements to existing documentation. (Expanding upon existing docs). help wanted Extra attention is needed.
Projects
None yet
Development

No branches or pull requests

2 participants