Conversation
dombizita
reviewed
Sep 29, 2026
dombizita
left a comment
There was a problem hiding this comment.
Thanks for working on this @errose28! Few nits and small comments inline, also asked Claude to check for missed out ideas, these two make sense:
- No general protobuf-compatibility principle up front. Several sections repeat "additive optional fields are safe / unknown field vs unknown method." A short shared paragraph in Background (unknown field is tolerated, unknown method/enum-required-semantics is not) would reduce repetition and give a single reference point.
- Config / ozone-site.xml compatibility during mixed versions isn't mentioned. New config keys or changed defaults that alter persisted/wire behavior mid-upgrade are a real compatibility surface — worth at least a sentence, even if only to declare it out of scope.
I don't insist to add these, just wanted to highlight them.
Contributor
Author
|
Thanks for the review @dombizita. All comments should be resolved now. A general protobuf section and config handling section are good additions as well. Let me put some thought into it and update the doc accordingly. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Developsection to the developer guide to cover developer documentation about writing code.Developsection.Note that
pnpm buildwill fail until the user doc link is committed, and the design doc linked here is also not yet committed. The PR will remain as draft until both of those are merged.What is the link to the Apache Jira?
HDDS-14776
How was this patch tested?
Local preview of the page using
pnpm start.