Skip to content
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

Update java.adoc around client routing #1179

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jgardiner68
Copy link

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

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

netlify bot commented Jul 15, 2024

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit b80519f
🔍 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
Copy link
Contributor

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

  • These are not headings; this is the list of the options; the options are ALL_MEMBERS, SINGLE_MEMBER, and MULTI_MEMBER
  • The heading is Java Client Cluster Routing Modes to try and bridge the gap (in the best way James Holgate and I could come up with, but still a terrible noun beast kind of way) - but the code is cluster-routing, so it is difficult to avoid using cluster routing when documenting it
  • There is explanatory text, and a tie in with the previous client operation mode settings

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
Copy link
Author

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
Copy link
Contributor

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 🤓

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants