bearomorphism opened a new pull request, #1305:
URL: https://github.com/apache/mahout/pull/1305

   ## What
   
   Fix the three stale links on the **How to Contribute** pages (issue #1301). 
The originals all returned `404 Not Found`:
   
   | Link text | Old target |
   |---|---|
   | `guide for making website updates` | 
`http://mahout.apache.org/documentation/developers/how-to-update-the-website.html`
 |
   | `wide variety of books and slides` | 
`http://mahout.apache.org/general/books-tutorials-and-talks.html` |
   | `Handling GitHub PRs` | 
`http://mahout.apache.org/documentation/developers/github` |
   
   ## Why
   
   These are contributor-facing pages on `mahout.apache.org`. Broken links here 
send new contributors to dead pages from `/docs/`, `/docs/next/`, and 
`/docs/0.4/` — making the contribution workflow harder than it needs to be.
   
   ## How
   
   - **`guide for making website updates`** → now points at the in-repo 
[`website/README.md`](https://github.com/apache/mahout/blob/main/website/README.md),
 which is the current Docusaurus development guide.
   - **`Handling GitHub PRs`** → renamed to **`PR policy and review 
guidelines`** and pointed at 
[`docs/community/pr-policy-and-review-guidelines.md`](https://github.com/apache/mahout/blob/main/docs/community/pr-policy-and-review-guidelines.md).
 Live (`next`) docs use a Docusaurus-relative link; v0.4 and v0.5 snapshots use 
an absolute GitHub URL because that page only exists in the current docs.
   - **`wide variety of books and slides`** → sentence removed. No equivalent 
page exists on the current site, and the issue explicitly allows removal in 
that case.
   - **`lychee.toml`** → drop the `./docs/about/how-to-contribute.md` exclusion 
(with its `TODO: fix the links in this file` comment) now that the file is 
clean. The link checker will cover it again.
   - Fix is applied consistently across all three affected routes:
     - `docs/about/how-to-contribute.md` (current / `next`)
     - `website/versioned_docs/version-0.5/about/how-to-contribute.md`
     - `website/versioned_docs/version-0.4/about/how-to-contribute.md`
   
   ## Verification
   
   Reproduced the bug and verified the fix locally with `lychee 0.24.2`.
   
   **Before:**
   
   ``````
   $ lychee docs/about/how-to-contribute.md
   [404] http://mahout.apache.org/documentation/developers/github (at 146:26)
   [404] 
http://mahout.apache.org/documentation/developers/how-to-update-the-website.html
 (at 49:32)
   [404] http://mahout.apache.org/general/books-tutorials-and-talks.html (at 
50:16)
   🔍 15 Total ✅ 12 OK 🚫 3 Errors
   ``````
   
   **After:**
   
   ``````
   $ lychee --config lychee.toml docs/about/how-to-contribute.md
   🔍 14 Total ✅ 14 OK 🚫 0 Errors
   ``````
   
   Pre-commit (`end-of-file-fixer`, `trailing-whitespace`) passes on the 
changed files.
   
   Closes #1301
   


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to