-
-
Notifications
You must be signed in to change notification settings - Fork 400
[skip changelog] Add task and workflow to check for dead links in docs #878
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
Conversation
d1634a0
to
dbde021
Compare
Markdown links checks are failing cause of this:
That link is not visible by everyone, should we remove it or find another solution? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Silvano! This is really great.
18 links checked.
[✖] https://github.com/arduino/arduino-cli/deployments?environment=github-pages#activity-log → Status: 404should we remove it or find another solution?
I recommend removing it. Even for the few who have the required permissions and will visit that link, I don't think it adds much value. For all the other contributors, the 404 link is only a waste of time.
I looked for general documentation from GitHub on this subject, but I didn't find anything that is directly relevant to the deployment to GitHub Pages (it's all about deployments in general).
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
fetch-depth: 0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the reason for using the fetch-depth: 0
setting?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fetch-depth: 0
fetches the whole history, branches and tags. Should have been set at 1
really, there's no need to fetch everything, I'll change it.
dbde021
to
0f3738e
Compare
before creating one)
Adds a task and a workflow to verify that links in the documentations are still working.
See how to contribute