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

Run LinkChecker only once per week #2319

Open
eshon opened this issue Sep 19, 2024 · 2 comments
Open

Run LinkChecker only once per week #2319

eshon opened this issue Sep 19, 2024 · 2 comments
Assignees

Comments

@eshon
Copy link
Collaborator

eshon commented Sep 19, 2024

Constant linkChecker issues from CI runs triggered by Docs PRs are problematic.

  • No PR should be merged if a CI run fails.
  • linkchecker issues sometimes prevent updates to the live Filecoin Docs site causing confusion among Contributors.
  • ecosystem project links get updated, come and go, and sometimes take a while to load
  • The linkChecker Github Action is here

Options:

Option 1. Run linkchecker via Github Actions only once per week if a PR is made that week

Option 2. People who know how to skip actions use that in their PRs and everyone else needs to held accountable for fixing broken linkchecker CI issues before merging PRs.

cc: @smagdali @robertagora @longfeiWan9 @xBalbinus

@BigLep
Copy link
Member

BigLep commented Oct 7, 2024

Per DM, it looks like I was a contributor here with #2323 when I moved certain URLs out of <code> blocks. I'm game to engage here to improve the situation.

My thoughts:

  1. Lets go with option 2 where we actually have branch protection rules that prevent pushing to the repo if the checks are failing. That way bad links don't build up. This way we have a mechanism rather than relying on best intentions.
  2. Lets document the way to work around the link checking if someone needs to.
  3. Lets get all links valid again.
  4. (bonus) Lets add a badge for our link status.

I'll take a stab on this and update where I get to.

BigLep added a commit that referenced this issue Oct 7, 2024
@BigLep
Copy link
Member

BigLep commented Oct 7, 2024

I think this can be resolved once #2327 is closed.

BigLep added a commit that referenced this issue Oct 10, 2024
* Fix broken links and update link checking docs

This is done in support of #2319

* Fixups after viewing on github and preview site

* Update README.md
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

No branches or pull requests

3 participants