hazelcast / hz-docs

Source content for the Hazelcast Platform documentation
10 stars 92 forks source link

Improvements to UCN dynamic client docs #1086

Closed JamesHazelcast closed 1 month ago

JamesHazelcast commented 2 months ago

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

netlify[bot] commented 2 months ago

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
Latest commit 6cca0fe3c0a2ddda2238cfde1ef92738f2bd9d97
Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/66261b03151a32000818c1d7
Deploy Preview https://deploy-preview-1086--hardcore-allen-f5257d.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

JamesHazelcast commented 1 month ago

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.

rebekah-lawrence commented 1 month ago

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.

JamesHazelcast commented 1 month ago

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 👍