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
| = Overview | ||
| :description: Overview of the main Hazelcast clients and APIs | ||
|
|
||
| Hazelcast clients and programming language APIs allow you to extend the benefits of operational in-memory computing to applications in these languages. These clients and APIs are open source and supported by Hazelcast. |
There was a problem hiding this comment.
| Hazelcast clients and programming language APIs allow you to extend the benefits of operational in-memory computing to applications in these languages. These clients and APIs are open source and supported by Hazelcast. | |
| Hazelcast clients and APIs enable you to extend the benefits of operational in-memory computing to applications in several programming languages. The Hazelcast clients documented here are open source and supported by Hazelcast. |
Are the APIs still open source? Think this might have been true when hazelcast itself was o/s but not sure it is now...
Do we will have any community clients that are not officially supported? See Redis page for example of how they treat this: https://redis.io/docs/latest/develop/clients/
| NOTE: Not all features are available in every client. For an overview of what each client offers, | ||
| see the link:https://hazelcast.com/developers/clients/?utm_source=docs-website[clients page]. | ||
|
|
||
| == Client versus API |
There was a problem hiding this comment.
I wonder about this section title - I wasn't at the original meetings so maybe missing some context but, Java aside, it seems to come down to what language you're using i.e. if there is a client library for your language then you would use this. e.g. is there actually an option to not use the Go client and directly use an API instead? I think this needs clarification and will affect the following content in this section.
There was a problem hiding this comment.
Perhaps "Use a Client or API?"
|
|
||
| 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.
| 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?
|
|
||
| === APIs (for embedded mode) | ||
|
|
||
| If you do not want to use a client to configure the cluster, you can use APIs to configure Hazelcast in embedded mode, where Hazelcast members run in the same Java process as your application. |
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.