chihsuan opened a new pull request, #433: URL: https://github.com/apache/ozone-site/pull/433
## What changes were proposed in this pull request? Extends the page at *Developer Guide → Project → JavaDoc* to include other code-reference tools, starting with [Code Wiki](https://codewiki.google/github.com/apache/ozone). The page is generalized into "Code References" with JavaDoc and Code Wiki as sub-sections. - Sidebar label changes from `JavaDoc` to `Code References`; H1 changes to `Ozone Code References`. - The filename (`03-javadoc.md`) and URL slug (`…/javadoc`) are intentionally **not** changed, matching the repo's convention for sidebar-only renames (e.g. `FairCallQueue → Fairness` in HDDS-14494 kept the `fair-call-queue` slug). ~45 other pages in this repo already have a sidebar label that differs from their slug (`release-guide` / "Release Manager Guide" right next door, `python` / "Accessing Apache Ozone from Python", etc.), so the slug stays as a stable identifier. See the inline comment on the frontmatter for the plan to revisit this when the page grows. - The Code Wiki paragraph notes inline that it is third-party and AI-generated, following the prose style in `docs/03-core-concepts/06-comparison.md` and `docs/04-user-guide/01-client-interfaces/07-python.md` — no `:::note` admonition, matching house style for third-party references. - `versioned_docs/version-2.1.0/` is not touched — matches HDDS-15097 (the Cloudera EC benchmark link), which made the same kind of "link an external reference" change to `docs/` only. ## What is the link to the Apache Jira? https://issues.apache.org/jira/browse/HDDS-15226 ## How was this patch tested? - `npx cspell docs/08-developer-guide/04-project/03-javadoc.md` — 0 issues. - `npx markdownlint docs/08-developer-guide/04-project/03-javadoc.md` — clean. - `npm run build` — succeeds with `onBrokenLinks: 'throw'` and `onBrokenAnchors: 'throw'`. The generated page at `build/docs/next/developer-guide/project/javadoc/index.html` renders the new H1 "Ozone Code References", both `## JavaDoc` and `## Code Wiki` sub-sections, and preserves the 2.1.0+ admonition. - `npm run start` — verified locally at `http://localhost:3001/docs/next/developer-guide/project/javadoc`: sidebar shows "Code References" in the third slot under Project (same position the old "JavaDoc" entry held), both external links resolve correctly. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
