Doc 355 - client doc updates #1497
Draft
+78
−32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
oliverhowell
requested changes
Jan 23, 2025
There was a problem hiding this comment.
Thanks @amandalindsay it's looking good - left some specific suggestions that affect a few of the pages
Comment on lines
+7
to
+15
| * Distributed Data Structures: The client offers access to various distributed data structures such as Map, Queue, Set, List, MultiMap, and RingBuffer. It also gives access to transactional distributed data structures such as transactional_map, transactional_queue, etc. | ||
| * Near Cache Support: The Near Cache feature allows frequently read data to be stored for faster read speeds compared to traditional caches | ||
| * Enterprise-Level Security: The client provides SSL support for enhanced security requirements | ||
| * Distributed synchronization: The client offers distributed synchronization mechanisms through the CP Subsystem, including fenced_lock, counting_semaphore and latch | ||
| * Smart Client Functionality: By default, it operates as a smart client, meaning it knows the data location within the cluster and can directly request the correct member (note that you can disable this feature using the `client_config::set_smart_routing` method if you do not want the clients to connect to every member) | ||
| * Listeners: Ability to add cluster listeners to a cluster and entry/item listeners to distributed data structures | ||
| * Cloud Integration: It offers the ability to discover existing Hazelcast clusters in an AWS environment | ||
| * Asynchronous Operations: The client supports asynchronous execution of tasks in the cluster and non-blocking asynchronous methods for improved performance | ||
| * Flexible Installation: It can be installed using package managers like Vcpkg or Conan, or built from source using CMake |
There was a problem hiding this comment.
Suggested change
| * Distributed Data Structures: The client offers access to various distributed data structures such as Map, Queue, Set, List, MultiMap, and RingBuffer. It also gives access to transactional distributed data structures such as transactional_map, transactional_queue, etc. | |
| * Near Cache Support: The Near Cache feature allows frequently read data to be stored for faster read speeds compared to traditional caches | |
| * Enterprise-Level Security: The client provides SSL support for enhanced security requirements | |
| * Distributed synchronization: The client offers distributed synchronization mechanisms through the CP Subsystem, including fenced_lock, counting_semaphore and latch | |
| * Smart Client Functionality: By default, it operates as a smart client, meaning it knows the data location within the cluster and can directly request the correct member (note that you can disable this feature using the `client_config::set_smart_routing` method if you do not want the clients to connect to every member) | |
| * Listeners: Ability to add cluster listeners to a cluster and entry/item listeners to distributed data structures | |
| * Cloud Integration: It offers the ability to discover existing Hazelcast clusters in an AWS environment | |
| * Asynchronous Operations: The client supports asynchronous execution of tasks in the cluster and non-blocking asynchronous methods for improved performance | |
| * Flexible Installation: It can be installed using package managers like Vcpkg or Conan, or built from source using CMake | |
| * Distributed Data Structures: The client offers access to various distributed data structures such as Map, Queue, Set, List, MultiMap, and RingBuffer. It also gives access to transactional distributed data structures such as transactional_map, transactional_queue, etc. | |
| * Near Cache Support: The Near Cache feature allows frequently read data to be stored for faster read speeds compared to traditional caches | |
| * Enterprise-Level security: the client provides SSL support for enhanced security requirements | |
| * Distributed synchronization: the client offers distributed synchronization mechanisms through the CP Subsystem, including fenced_lock, counting_semaphore and latch | |
| * Smart Client functionality: by default, it operates as a smart client, meaning it knows the data location within the cluster and can directly request the correct member (note that you can disable this feature using the `client_config::set_smart_routing` method if you do not want the clients to connect to every member) | |
| * Listeners: ability to add cluster listeners to a cluster and entry/item listeners to distributed data structures | |
| * Cloud integration: it offers the ability to discover existing Hazelcast clusters in an AWS environment | |
| * Asynchronous operations: the client supports asynchronous execution of tasks in the cluster and non-blocking asynchronous methods for improved performance | |
| * Flexible installation: it can be installed using package managers like Vcpkg or Conan, or built from source using CMake |
|
|
||
| See Hazelcast C++ client's own GitHub https://github.com/hazelcast/hazelcast-cpp-client[repo^] | ||
| for information on setting the client up, installing and compiling it, its serialization, query support and available APIs. | ||
| For the latest C{plus}{plus} API documentation, see http://hazelcast.github.io/hazelcast-cpp-client/{page-latest-supported-cplusplus-client}/index.html[Hazelcast C++ Client docs]. |
There was a problem hiding this comment.
Suggested change
| For the latest C{plus}{plus} API documentation, see http://hazelcast.github.io/hazelcast-cpp-client/{page-latest-supported-cplusplus-client}/index.html[Hazelcast C++ Client docs]. | |
| For the latest {cpp} API documentation, see http://hazelcast.github.io/hazelcast-cpp-client/{page-latest-supported-cplusplus-client}/index.html[Hazelcast {cpp} Client docs]. |
| for information on setting the client up, installing and compiling it, its serialization, query support and available APIs. | ||
| For the latest C{plus}{plus} API documentation, see http://hazelcast.github.io/hazelcast-cpp-client/{page-latest-supported-cplusplus-client}/index.html[Hazelcast C++ Client docs]. | ||
|
|
||
| For information on setting up, installing and compiling the client, and about its serialization, query support and available APIs, see the Hazelcast {cpp} client GitHub https://github.com/hazelcast/hazelcast-cpp-client[repo^]. |
There was a problem hiding this comment.
Suggested change
| For information on setting up, installing and compiling the client, and about its serialization, query support and available APIs, see the Hazelcast {cpp} client GitHub https://github.com/hazelcast/hazelcast-cpp-client[repo^]. | |
| For information on setting up, installing and compiling the client, and about its serialization, query support and available APIs, see the https://github.com/hazelcast/hazelcast-cpp-client[Hazelcast {cpp} Client GitHub repo]. |
There was a problem hiding this comment.
I'm not sure on the capitalization on "Client" - we seem to flip back and forward on this in the existing content; needs a sanity/style check before we make them all consistent
Comment on lines
+8
to
+14
| * Distributed Data Structures: It provides access to Hazelcast's distributed data structures such as maps, queues, topics, and more | ||
| * SQL Support: The client allows running SQL queries over distributed data | ||
| * Near Cache: It supports Near Cache for faster read speeds. Eventual consistency is also supported | ||
| * Security Features: The client offers SSL support and Mutual Authentication for enterprise-level security needs | ||
| * JSON Object Support: It allows using and querying JSON objects | ||
| * Zero Downtime Upgrades: Blue/Green failover for zero downtime during upgrades is supported | ||
| * Scalability: The Hazelcast .NET Client is designed to scale up to hundreds of members and thousands of clients, making it suitable for large-scale applications |
There was a problem hiding this comment.
Similar comments on making the first word after a colon lowercase, as per Google
| You can also find https://github.com/hazelcast/hazelcast-csharp-client/tree/master/src/Hazelcast.Net.Examples[code samples^] | ||
| * Distributed Data Structures: It provides access to Hazelcast's distributed data structures such as maps, queues, topics, and more | ||
| * SQL Support: The client allows running SQL queries over distributed data | ||
| * Near Cache: It supports Near Cache for faster read speeds. Eventual consistency is also supported |
There was a problem hiding this comment.
Suggested change
| * Near Cache: It supports Near Cache for faster read speeds. Eventual consistency is also supported | |
| * Near Cache: It supports Near Cache for faster read speeds. Eventual consistency is also supported |
|
|
||
| For the latest .NET API documentation, see http://hazelcast.github.io/hazelcast-csharp-client/{page-latest-supported-csharp-client}/api/index.html[Hazelcast .NET Client docs]. | ||
|
|
||
| For more information about configuring, starting, and using the client, see the Hazelcast .NET client GitHub http://hazelcast.github.io/hazelcast-csharp-client/latest/doc/download-install.html[documentation^]. You can also find https://github.com/hazelcast/hazelcast-csharp-client/tree/master/src/Hazelcast.Net.Examples[code samples^] |
There was a problem hiding this comment.
In general we should make the link text include more than just repo or documentation - see my earlier suggestion for example
|
|
||
| For the latest Go API documentation, see https://pkg.go.dev/github.com/hazelcast/hazelcast-go-client@v{page-latest-supported-go-client}[Hazelcast Go Client docs]. | ||
|
|
||
| For more information, see the azelcast Go client GitHub https://github.com/hazelcast/hazelcast-go-client[repo^] |
There was a problem hiding this comment.
Suggested change
| For more information, see the azelcast Go client GitHub https://github.com/hazelcast/hazelcast-go-client[repo^] | |
| For more information, see the https://github.com/hazelcast/hazelcast-go-client[Hazelcast Go client GitHub repo]. |
| @@ -1,9 +1,21 @@ | |||
| = Node.js Client | |||
| :page-api-reference: http://hazelcast.github.io/hazelcast-nodejs-client/api/{page-latest-supported-nodejs-client}/docs/ | |||
|
|
|||
| TIP: For the latest Node.js API documentation, see http://hazelcast.github.io/hazelcast-nodejs-client/api/{page-latest-supported-nodejs-client}/docs/[Hazelcast Node.js Client docs]. | |||
| The Hazelcast native Node.js client is an official library that allows Node.js applications to connect to and interact with Hazelcast clusters. It is implemented using the Hazelcast Open Binary Client Protocol, and provides a Promise-based API with built-in support for native JavaScript objects. The key features and benefits include: | |||
There was a problem hiding this comment.
Suggested change
| The Hazelcast native Node.js client is an official library that allows Node.js applications to connect to and interact with Hazelcast clusters. It is implemented using the Hazelcast Open Binary Client Protocol, and provides a Promise-based API with built-in support for native JavaScript objects. The key features and benefits include: | |
| The Hazelcast native Node.js client is an official library that allows Node.js applications to connect to and interact with Hazelcast clusters. It is implemented using the Hazelcast Open Binary Client Protocol, and provides a promise-based API with built-in support for native JavaScript objects. The key features and benefits include: |
| @@ -2,23 +2,24 @@ | |||
| :page-api-reference: http://hazelcast.github.io/hazelcast-cpp-client/{page-latest-supported-cplusplus-client}/index.html | |||
| [[c-client]] | |||
|
|
|||
| TIP: For the latest C{plus}{plus} API documentation, see http://hazelcast.github.io/hazelcast-cpp-client/{page-latest-supported-cplusplus-client}/index.html[Hazelcast C++ Client docs]. | |||
There was a problem hiding this comment.
We put these explicit Tips in as the API docs are not that well signposted (just below the heading) so figured it was worth spelling out the link - unless there's a specific reason to remove I would put them back in (somewhere) - WDYT?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the individual client doc topics with improved descriptions based on what's already there, plus information from the main HZC website (e.g. https://hazelcast.com/developers/clients/cplusplus/).
Note that the Java client topic will be done in a separate PR (this is to avoid merge conflicts resulting from changes for Doc-294)