errose28 commented on code in PR #297: URL: https://github.com/apache/ozone-site/pull/297#discussion_r2819075885
########## CONTRIBUTING.md: ########## @@ -123,6 +123,10 @@ Docusaurus provides many options for laying out documentation pages and their me - Use relative file paths for all links between pages. - This keeps page links pointing to the current version of the documentation. - See [Markdown Links](https://docusaurus.io/docs/markdown-features/links) in Docusaurus for more information. + - **Link format requirements** (enforced by build validation): + - Do not include number prefixes in links. Use `./ozone-manager` instead of `./02-ozone-manager`. + - Do not include file extensions. Use `./ozone-manager` instead of `./ozone-manager.md`. + - Do not use absolute paths to docs (e.g., `/docs/...`). Use relative paths to maintain version compatibility. Review Comment: Suggestion to condense this explanation. It is already noted above that there is some CI enforcement. ```suggestion - Use [URL paths](https://docusaurus.io/docs/markdown-features/links) to link between pages. To use this format: - Do not include number prefixes in links. Use `./ozone-manager` instead of `./02-ozone-manager`. - Do not include file extensions. Use `./ozone-manager` instead of `./ozone-manager.md`. - Do not use absolute paths to docs (e.g., `/docs/...`). Use relative paths to keep page links pointing within the current version of the documentation. ``` -- 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]
