Improvements to UCN dynamic client docs #1086
Conversation
Following discussion on Slack, we identified some improvements that can be made to this page to clarify functionality to users. Relevant slack thread: https://hazelcast.slack.com/archives/C035HQET5/p1713272907972899
JamesHazelcast
added
the
documentation
JamesHazelcast
requested review from
Serdaro,
rebekah-lawrence and
oliverhowell
as code owners
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: rebekah-lawrence <142301480+rebekah-lawrence@users.noreply.github.com>
There was a problem hiding this comment.
LGTM
Nice to know you enjoy my reviews; over the years they have been called many things (pedantic, picky, a pain in the ***), but not often enjoyable ;-)
And, yes, I edited my own original text - reading it with fresh eyes, the note interrupted my flow; this one was to tie the paragraphs together - and probably pedantic!
Great work and thanks for picking it up.
Co-authored-by: Serdar Ozmen <serdar@hazelcast.com>
|
Hi @oliverhowell @rebekah-lawrence do you know what the situation is with this PR? Is it intentionally left open? In the past I have left PR merging to docs team, but I see other 5.5 PRs have been merged recently, so wanted to check in about this one. |
|
Hey @JamesHazelcast I generally leave the originator to merge the PR once they have all reviews/approvals required. Only question on this one is whether it needs to be backported to 5.4. Let me know and I'm happy to merge or add the label and merge. @oliverhowell I have never merged someone else's PR, but this might be something for consideration in our processes so it is clear to all parties what the expected flow of a PR is to be as we get all our stuff properly documented. |
|
Thanks for the info @rebekah-lawrence, I'm happy to merge myself, just didn't want to impact any process that may have been in place. I think this is worth backporting to 5.4, so I've added the label and will merge this PR 👍 |
Improvements to UCN dynamic client docs Following discussion on Slack, we identified some improvements that can be made to this page to clarify functionality to users. Relevant slack thread: https://hazelcast.slack.com/archives/C035HQET5/p1713272907972899 (cherry picked from commit c464fff)
Following discussion on Slack, we identified some improvements that can be made to this page to clarify functionality to users.
More specifically I have split the page into 2 parts, 1 focusing on creating a new UCN from clients, and 1 focusing on updating an existing UCN. I've also adjusted some wording to make this difference clearer.
Relevant slack thread: https://hazelcast.slack.com/archives/C035HQET5/p1713272907972899