errose28 commented on code in PR #341: URL: https://github.com/apache/ozone-site/pull/341#discussion_r2818597944
########## docs/03-core-concepts/01-architecture/06-recon.md: ########## @@ -50,9 +50,10 @@ An example `ReconScmTask` is `ContainerHealthTask` that runs in configurable int Recon can integrate with any Prometheus instance configured to collected metrics and can display useful information in Recon UI in Datanodes and Pipelines pages. Recon also exposes a proxy endpoint ([/metrics](https://ozone.apache.org/docs/edge/interface/reconapi.html#metrics)) to query Prometheus. This integration can be enabled by setting this configuration `ozone.recon.prometheus.http.endpoint` to the Prometheus endpoint like `ozone.recon.prometheus.http.endpoint=http://prometheus:9090`. -## API Reference +[//]: # (## API Reference) -[Link to complete API Reference](../../05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.md) +[//]: # () +[//]: # ([Link to complete API Reference](../../05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.md)) Review Comment: It looks like standard HTML comments are supported, which are much easier to interpret than the markdown link workaround currently being used. Can we update all the comments to use this format? ```suggestion <!-- ## API Reference - [Link to complete API Reference](../../05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.md) --> ``` ########## docs/06-troubleshooting/01-startup.md: ########## @@ -1,9 +1,11 @@ --- +draft: true sidebar_label: Startup --- # Troubleshooting Startup **TODO:** File a subtask under [HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this page or section. +**TODO:** Allow inclusion of the troubleshooting folder by updating the excludes list in `docusaurus.config.js`. Review Comment: Let's move this comment to the `06-troubleshooting/README.mdx` file, which is the entry point for this section. ########## docusaurus.config.js: ########## @@ -135,6 +135,10 @@ const config = { sidebarPath: undefined, editUrl: 'https://github.com/apache/ozone-site/tree/master', + exclude: [ Review Comment: Let's add comments to this config and the FAQ exclude as well to indicate that these are intentionally excluded until their content is finished. ########## docs/08-developer-guide/03-test/01-unit-tests.md: ########## @@ -1,6 +1,11 @@ +--- +draft: true +--- + # Unit Tests **TODO:** File a subtask under [HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this page or section. +**TODO:** Uncomment link to this page in docs/08-developer-guide/01-build/01-Maven.md Review Comment: Should we hide this whole `test` subsection for now? Without docs on unit and integration tests it is missing the most commonly used content. ########## docs/07-system-internals/01-components/01-ozone-manager/01-disk-layout.md: ########## @@ -1,8 +1,11 @@ --- +draft: true sidebar_label: Disk Layout --- # Ozone Manager Disk Layout +**TODO:** Allow inclusion of the system internals folder by updating the excludes list in `docusaurus.config.js`. Review Comment: Same comment as above. We can move this comment to the `07-system-internals/README.mdx` file, which is the entry point for this section. ########## docs/07-system-internals/01-components/01-ozone-manager/01-disk-layout.md: ########## @@ -1,8 +1,11 @@ --- +draft: true Review Comment: Is there any benefit to labeling all these pages as draft if they are globally excluded in the Docusaurus config? Seems like if would be easier to leave them as is and use the global config to enable this section all at once when it is ready. -- 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]
