search

hazelcast / hz-docs

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

Update java.adoc around client routing #1179

Closed jgardiner68 closed 1 day ago

jgardiner68 commented 2 months ago

Updated the headings to include "Client" as a prefix and "Routing" so that customers can read the announcement and find it in the documentation

netlify[bot] commented 2 months ago

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
Latest commit b80519fc22fe4b5e5d4dcdfd7245decec2531977
Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/6695228840d8760009569401
Deploy Preview https://deploy-preview-1179--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.

rebekah-lawrence commented 2 months ago

Have to say I am not totally on board with this for the following reasons:

Questions: a) Why does the announcement use different naming from the docs (which were written to match the extensive renaming exercise)? b) Can't the announcement just link directly to https://docs.hazelcast.com/hazelcast/latest/clients/java#java-client-operation-modes so customers don't have to "find" the information? c) Did you expect me to suddenly become easier to deal with in my last week ;-)

jgardiner68 commented 2 months ago

Two reasons to do so: 1) Feedback via PSB members is some of them thought this feature relates cluster member routing. 2) improves search

Point (c) -- yes always surprising :-)

rebekah-lawrence commented 2 months ago

The potential for this confusion was discussed during the renaming rounds. Disappointing it still remains. This is really not a docs issue (whistles innocently)

I winced and used "Java client cluster routing mode" after the discussions in a desperate and unsatisfying attempt to cover this.

Tell you what I'll do, I'll skulk round the corner, and @oliverhowell can approve while I'm not looking - don't say I'm not good to you - but use this wisely; I still have more days to go and you won't get another pass 🤓

oliverhowell commented 1 day ago

I've updated some of the references to include the suggested text so we have both sides covered: https://github.com/hazelcast/hz-docs/pull/1289

Closing this PR...