Comments (7)
yes and this is partially done (missing opening an issue if scheduled check fails)
See https://github.com/EGI-Federation/documentation/blob/main/.github/workflows/check-links.yml
from documentation.
Hi! I might be able to look at this as a quick exercise to get myself familiar. Are you thinking about a cron trigger here to run one of the actions included in the existing workflow, or an outside agent which monitors the pages for missing links and opens issues against them?
from documentation.
There is already some regular checks of the links, but the result is an email that gets ignored in my inbox. See last execution https://github.com/EGI-Federation/documentation/actions/runs/7948069227. It would be good to open an issue indeed instead of just getting the notification about broke execution
from documentation.
Hm. 14 minutes for a run. Sound like something you want to do asynch. I don't suppose we deploy this to a staging environment perhaps?
from documentation.
15 minutes is checking every link on the repo. For PRs, only links within the changed files are checked, so it goes rather fast. Fixing the broken links will also reduce greatly the run (you just avoid hitting the timeouts for the broken links).
from documentation.
As I understood, there are links outside of this repo, which we do not control -- just plain dead links -- which we need to monitor for right?
So we can have the fast checks run only on the page that has changed -- we can parametrise this and it will run in seconds. But we don't have a trigger for changes which happen outside of the repo, so we need to schedule regular crawls for that (once a week, e.g.).
graph LR
subgraph PR
direction TB
page[page changes] --> check_page[Check links in page]
end
subgraph Cron
direction TB
cron[Scheduled check] --> check_all[Check all links in all pages]
end
Failures on the cron
path can open issues. Failures on the PR path break the build.
Sound right?
from documentation.
nice. So, todo is:
- Open issue if cron fails
- only check links in changed file which has changed in PR (Looks like that goes in
.github/workflows/build_pr_preview.yml
?).. that sounds like a job for a pre-commit hook -- see #635
from documentation.
Related Issues (20)
- Document how to republish accounting records for cloud sites HOT 1
- Document the configurations involved to set up an SSH connection with a VM in OpenStack
- Document APEL accounting for HTCondor-CE
- Document some security guidelines for VM deployed on Cloud Compute HOT 3
- Stop existing workflow run when a PR is updated
- Resize support for left-side navigation sidebar
- Scroll progress for the right-side page summary/headings
- Update GPU information for IISAS-FedCloud site HOT 2
- link to the new version of usage records specs concerning the cloud usage records
- Update HTC doc for using lcg-infosites instead of lcg-info which has been archived.
- Enable link checking for all files, not only for changed ones
- HOWTO01 Using IGTF CA distribution: EGI-trustanchors vs egi-trustanchors HOT 1
- Contributing pre-commit hooks HOT 5
- Re-organise contributor page for development environment HOT 2
- Error: error building site: render: failed to render pages HOT 7
- Prettier should be declared as pre-commit dependency
- documentation for creating pool accounts on WNs HOT 1
- Secrets Store Web Interface - link to origin in documentation HOT 1
- Site info system deployment is not documented
- Create a page with an inventory of artifacts
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from documentation.