Skip to content

[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

Merged
merged 3 commits into from
Jul 30, 2020

Conversation

silvanocerza
Copy link
Contributor

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Adds a task and a workflow to verify that links in the documentations are still working.


See how to contribute

@silvanocerza silvanocerza requested a review from a team July 28, 2020 14:55
@silvanocerza silvanocerza self-assigned this Jul 28, 2020
@silvanocerza silvanocerza force-pushed the scerza/docs-links-check branch 9 times, most recently from d1634a0 to dbde021 Compare July 29, 2020 10:30
@silvanocerza
Copy link
Contributor Author

Markdown links checks are failing cause of this:

FILE: ./docs/CONTRIBUTING.md
[✖] https://github.com/arduino/arduino-cli/deployments?environment=github-pages#activity-log

ERROR: 1 dead links found!

18 links checked.
[✖] https://github.com/arduino/arduino-cli/deployments?environment=github-pages#activity-log → Status: 404

That link is not visible by everyone, should we remove it or find another solution?

Copy link
Contributor

@per1234 per1234 left a 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: 404

should 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
Copy link
Contributor

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?

Copy link
Contributor Author

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.

@silvanocerza silvanocerza force-pushed the scerza/docs-links-check branch from dbde021 to 0f3738e Compare July 30, 2020 08:42
@silvanocerza silvanocerza merged commit 0483882 into master Jul 30, 2020
@silvanocerza silvanocerza deleted the scerza/docs-links-check branch July 30, 2020 09:14
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.

2 participants