Client doc 294 #1464
Client doc 294 #1464
Conversation
amandalindsay
requested review from
ihsandemir,
fawazghali,
oliverhowell and
avtarraikmo
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
I've went over on other comments and requested changes. Agreed @yuce and @ihsandemir. I think there is a misunderstanding about some concepts. I'm confused here what we are aiming. Instead of putting induvial comments, I prefer to clarify the cores first. I think having a meeting would be good idea to discuss the goal and cores.
There was a problem hiding this comment.
Some minor suggestions and quite a few questions where we might need @yuce perspective
|
|
||
| If you are interested in using a standalone or lightweight Java client, you can try the {java-client-new}. This client is currently available as Beta functionality but can interact with a Hazelcast cluster without being a full member. Please note that the {java-client-new} doesn't have full feature parity with the {java-client} yet and is not recommended for production environments. For more info, see xref:java#java-client-standalone-beta[]. | ||
| Hazelcast provides a {java-client} which you can use to connect to a Hazelcast cluster. `hazelcast-<VERSION>.jar` is bundled in the Hazelcast standard package, so you simply add this file to your classpath to begin using the client as if you are using the Hazelcast API. |
There was a problem hiding this comment.
Think these changes are going to collide with the other in flight Java PR - the Java 17 version being available as Beta and the Java 8 version accelerating past as GA, which complicates things. Might be worth reverting the changes on these pages and I'll fold any suggestions in to my PR e.g. line 20.
There was a problem hiding this comment.
Just looking at my changes and I've really only tweaked the wording, rather than changed the meaning, so I think we are okay. I have, however, amended the first sentence, as we are no longer comparing Java clients. LMKWYT but hopefully no clashes
There was a problem hiding this comment.
I think this one you have to revert for now due to above e.g. until I hear otherwise the {java-client-new} is still in Beta and line 12 is still needed
| NOTE: *Clients* refer to the Hazelcast _libraries_ used to connect to a Hazelcast cluster and exchange data. Clients use a binary protocol for communication with the cluster and encode the data in various formats such as Compact, JSON, etc. Clients are available in various programming languages, and are typically embedded as libraries in customer applications. | ||
| *APIs*, by comparison, are the _interfaces_ with the Hazelcast platform. These do not require the use of specific libraries to connect and are generally text based — for example, the REST interface. | ||
|
|
||
| === Clients (for client/server mode) |
There was a problem hiding this comment.
If embedded mode is only available for Java, are we over complicating things by detailing these differences here (rather than on that page) and giving the illusion of choice where there isn't one?
There was a problem hiding this comment.
I've tweaked it. LMKWYT
Co-authored-by: Oliver Howell <[email protected]>
Co-authored-by: Oliver Howell <[email protected]>
Co-authored-by: Oliver Howell <[email protected]>
Co-authored-by: Oliver Howell <[email protected]>
See Docs ticket for details and SOW: https://hazelcast.atlassian.net/browse/DOC-294
In summary, this docs work involves:
This PR is now ready for review now that a decision has been made on how to refer to Clients & APIs (see docs ticket).
Note that the client features graphic on the main HZC website may change but, in the meantime, we will continue to link to it until a decision is made about what to do with it.