-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DBZ-6835 Documentation for Timezone SMT #4819
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added a few suggestions.
A general suggestion, however, is that we should strive only to have a single sentence per line in the documentation. We haven't been consistent with this universally, but it is the dominant style we've used, and I'd prefer to stick to that.
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
@ani-sha I added my review. To reduce the confusion that might result in trying to integrate possibly divergent suggestions, before submitting my review, I first went through the comments that @Naros added and made a few in-place edits to those (So if anything looks different, Chris, that's why). I then added any additional feedback that I had. Let me know if you have any questions, particularly around my proposed reformatting of the examples. Thanks! |
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
Appreciate your review, @roldanbob. I've incorporated Chris's revisions initially and then integrated your suggested changes. If anything is unclear, please let me know. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few further suggestions, @ani-sha
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
@ani-sha LGTM, this can safely be merged when the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ani-sha One more set of suggestions. After this, I think you're good to go. Let me know if you have questions.
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/ROOT/pages/transformations/timezone-converter.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I responded to your comments and made one further change to the title of the first example in Effect of applying the TZ converter SMT. Beyond that I don't have any further changes to suggest.
I am OOO for the next 10 days. If you have further questions that can wait until after I return, I'll respond when I'm back.
Thanks a lot @roldanbob! I have added all the suggestions. Looks good now! |
@jpechane the docs are ready to be merged! |
Thanks @ani-sha and @roldanbob for the work on this, applied to main (=2.4). |
https://issues.redhat.com/browse/DBZ-6835