Skip to content

Conversation

@Tejaskriya
Copy link
Contributor

@Tejaskriya Tejaskriya commented Jul 28, 2025

What changes were proposed in this pull request?

As a part of HDDS-11944 and other related jiras, many changes were made to the debug tools of ozoe. SOme new commands were added as well. This PR adds the documentation for the same under tools/debug/.
Each major subcommand has it's own page so that it is more user-friendly to read, instead of keeping all the command usages in 1 page which makes the documentation quite cluttered.

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-12197

How was this patch tested?

Checked the rendering through hugo serve.
Screenshot 2025-07-28 at 2 03 05 PM
Screenshot 2025-07-28 at 2 03 16 PM

@Tejaskriya Tejaskriya added documentation Improvements or additions to documentation tools Tools that helps with debugging labels Jul 28, 2025
@Tejaskriya Tejaskriya requested a review from dombizita July 28, 2025 08:34
@Tejaskriya
Copy link
Contributor Author

@sarvekshayr requesting your review on this

Copy link
Contributor

@dombizita dombizita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this documentation @Tejaskriya!

Copy link
Contributor

@sarvekshayr sarvekshayr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating. LGTM.

Copy link
Contributor

@dombizita dombizita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing the review comments @Tejaskriya!

@dombizita dombizita merged commit a59b573 into apache:master Aug 12, 2025
14 checks passed
@dombizita
Copy link
Contributor

Thank you for working on this @Tejaskriya! Thanks for the review @sarvekshayr!

errose28 added a commit to errose28/ozone that referenced this pull request Aug 18, 2025
* master:
  HDDS-13553. Recon Staging DB for OM full db reprocess (apache#8917)
  HDDS-13138. [Docs] Update Topology Awareness user doc. (apache#8528)
  HDDS-11944. Usability improvements for Ozone tools. (apache#7597)
  HDDS-12197. Update documentation for all ozone debug tools (apache#8868)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tools Tools that helps with debugging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants