Adez017 commented on issue #16840: URL: https://github.com/apache/datafusion/issues/16840#issuecomment-3111606238
> [@Adez017](https://github.com/Adez017) Thank you for working on this! > > The standard practice is to introduce a check like this to validate new PRs. For rollout I think it involves two steps. First, we can fix all the existing broken links currently on the `main` branch in a separate PR. Then we have a clean `main` on which can activate the workflow. > > I reviewed the [workflow file](https://github.com/Adez017/datafusion/blob/d36b815751b99adada69dec9ce628011ea703e30/.github/workflows/dead_links_check.yml#L35-L37) and have a suggestion. > > We can check the final output of the generated docs instead of directly scanning the source files. I think this is a better approach because it allows `lychee` to verify the internal links that `rustdoc` creates in HTML. > > There are two places where the docs are built: > > 1. Cargo docs: > > > [datafusion/ci/scripts/rust_docs.sh](https://github.com/apache/datafusion/blob/518fb4b53697eec1562b9061d4f47f9f2f348325/ci/scripts/rust_docs.sh#L21-L22) > > > Lines 21 to 22 > in > [518fb4b](/apache/datafusion/commit/518fb4b53697eec1562b9061d4f47f9f2f348325) > > > > > > > > export RUSTDOCFLAGS="-D warnings" > > > > > cargo doc --document-private-items --no-deps --workspace > 2. Website docs: https://github.com/apache/datafusion/tree/main/docs#build--preview Hi @jcsherin thanks for the suggestion okay so as of my understanding we have to first find all the broken links that exist and fix them manually , then we can steup a CI like `lychee` to run for new PR's and push -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
