Comments (14)
Broken link checker works a treat!
Sample extract of output:
blc http://localhost:3000/ -roe
Getting links from: http://localhost:3000/docs/how-prysm-works/bls-cryptography
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#proof-of-stake-pos (HTTP_404)
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#validator (HTTP_404)
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#proof-of-stake-pos (HTTP_404)
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#validator (HTTP_404)
Finished! 77 links found. 73 excluded. 4 broken.
Finished! 3774 links found. 3719 excluded. 4 broken.```
from documentation.
Docusaurus' already print out a list of unresolved links on static build
from documentation.
Can we add this to our CI pipeline?
Let me know it works and I can add something to fail PRs if they break links
from documentation.
Reopening as we've experienced issues with docusaurus link debugging feature
from documentation.
How does the link debugging work? Can we add it to CI pipeline?
from documentation.
Ping @har00ga
from documentation.
Another broken link: #94
from documentation.
Oh sorry, didnt see this notification. From what I gather it's something that can be run on a live site or hard coded into the docs themselves to have the checks performed, not sure which is ultimately simpler but if I had to guess, the live scan. It can likely be run against the live server and links can be checked before every revision push
from documentation.
Relevant issue: facebook/docusaurus#1111
The idea would be that we run this check on a new PR and fail that PR if it is breaking links. Running a live server doesn't seem viable in CI unless there is some example of it already.
from documentation.
@prestonvanloon Works for me, would be awesome to implement that if possible. Seeing as it works on the live server as well it would be good to make a note in the README that contributors should use the link tool before submitting a PR to reduce friction at merge time
from documentation.
#101 Link checking to be included as a step in this
from documentation.
If someone can help implement this as a github action, we could add it as a PR requirement.
from documentation.
@prestonvanloon Haven't worked with GH Actions before but will read into it this week
from documentation.
from documentation.
Related Issues (20)
- Sk
- Grafana dashboards do not work out of the box
- A lot of `Missing data` on the beaconcha.in app.
- Docs update request: /docs/how-prysm-works/keymanager-api
- Docs update request: /docs/execution-node/authentication
- Deneb Docs
- Docs update request: /docs/prysm-usage/parameters HOT 1
- Docs update request: /docs/prysm-usage/prysmctl HOT 1
- Docs update request: /docs/advanced/proof-of-stake-devnet
- update validator list info
- Docs update request: /docs/wallet/exiting-a-validator
- Update prysm docs to v5 HOT 1
- Docs update request: /docs/contribute/required-reading
- Docs update request: /docs/contribute/required-reading..
- Docs update request: /docs/install/install-with-bazel
- Docs update request: /docs/advanced/proof-of-stake-devnet
- Docs update request: /docs/advanced/proof-of-stake-devnet
- add jwt generation for validator client
- Beacon Chain API data is not available /eth/v1/beacon/blob_sidecars/{block_id} HOT 1
- Docs update request: /docs/how-prysm-works/ethereum-public-api
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.