From 2ec876d5bf0a36bac7c154ef09e7eb5c8d838a2d Mon Sep 17 00:00:00 2001 From: Oliver Howell Date: Wed, 3 Jul 2024 08:54:59 +0100 Subject: [PATCH] Add API links as tips --- docs/modules/clients/pages/cplusplus.adoc | 2 ++ docs/modules/clients/pages/dotnet.adoc | 2 ++ docs/modules/clients/pages/go.adoc | 2 ++ docs/modules/clients/pages/java.adoc | 2 ++ docs/modules/clients/pages/memcache.adoc | 7 +++---- docs/modules/clients/pages/nodejs.adoc | 2 ++ docs/modules/clients/pages/python.adoc | 2 ++ 7 files changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/modules/clients/pages/cplusplus.adoc b/docs/modules/clients/pages/cplusplus.adoc index f43456413..ddf98ec73 100644 --- a/docs/modules/clients/pages/cplusplus.adoc +++ b/docs/modules/clients/pages/cplusplus.adoc @@ -2,6 +2,8 @@ :page-api-reference: http://hazelcast.github.io/hazelcast-cpp-client/{page-latest-supported-cplusplus-client}/index.html [[c-client]] +TIP: For 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]. + You can use the native {cpp} client to connect to Hazelcast cluster members and perform almost all operations that a member can perform. Clients differ from members in that clients do not hold data. The {cpp} client is diff --git a/docs/modules/clients/pages/dotnet.adoc b/docs/modules/clients/pages/dotnet.adoc index e1e66424a..6704953ae 100644 --- a/docs/modules/clients/pages/dotnet.adoc +++ b/docs/modules/clients/pages/dotnet.adoc @@ -2,6 +2,8 @@ :page-api-reference: http://hazelcast.github.io/hazelcast-csharp-client/{page-latest-supported-csharp-client}/api/index.html [[net-client]] +TIP: For latest .NET API documentation, see http://hazelcast.github.io/hazelcast-csharp-client/{page-latest-supported-csharp-client}/api/index.html[Hazelcast .NET Client docs]. + You can use the native .NET client to connect to Hazelcast client members. The API is very similar to the Java native client. diff --git a/docs/modules/clients/pages/go.adoc b/docs/modules/clients/pages/go.adoc index 8a3fd2f0a..f4eb92011 100644 --- a/docs/modules/clients/pages/go.adoc +++ b/docs/modules/clients/pages/go.adoc @@ -1,6 +1,8 @@ = Go Client :page-api-reference: https://pkg.go.dev/github.com/hazelcast/hazelcast-go-client@v{page-latest-supported-go-client} +TIP: For 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]. + Go Client implementation for Hazelcast. It is implemented using the Hazelcast Open Binary Client Protocol. See Hazelcast Go client's GitHub https://github.com/hazelcast/hazelcast-go-client[repo^] diff --git a/docs/modules/clients/pages/java.adoc b/docs/modules/clients/pages/java.adoc index b836b897d..69c4bafb5 100644 --- a/docs/modules/clients/pages/java.adoc +++ b/docs/modules/clients/pages/java.adoc @@ -4,6 +4,8 @@ :page-toclevels: 3 [[java-client]] +TIP: For latest Java API documentation, see https://docs.hazelcast.org/docs/{page-latest-supported-java-client}/javadoc[Hazelcast Java Client docs]. + To get started, include the `hazelcast.jar` dependency in your classpath. Once included, you can start using this client as if you are using the Hazelcast API. The differences are discussed in the below sections. diff --git a/docs/modules/clients/pages/memcache.adoc b/docs/modules/clients/pages/memcache.adoc index b46c460e3..974afc0a8 100644 --- a/docs/modules/clients/pages/memcache.adoc +++ b/docs/modules/clients/pages/memcache.adoc @@ -1,12 +1,11 @@ = Memcache Client -NOTE: Hazelcast Memcache Client only supports ASCII protocol. Binary Protocol is not supported. - A Memcache client written in any language can talk directly to a Hazelcast cluster. No additional configuration is required. -To be able to use a Memcache client, you must enable -the Memcache client request listener service using either one of the following configuration options: +NOTE: Hazelcast Memcache Client only supports ASCII protocol. Binary Protocol is not supported. + +To be able to use a Memcache client, you must enable the Memcache client request listener service using either one of the following configuration options: 1 - Using the `network` configuration element: diff --git a/docs/modules/clients/pages/nodejs.adoc b/docs/modules/clients/pages/nodejs.adoc index e844e9d41..139858f48 100644 --- a/docs/modules/clients/pages/nodejs.adoc +++ b/docs/modules/clients/pages/nodejs.adoc @@ -1,6 +1,8 @@ = Node.js Client :page-api-reference: http://hazelcast.github.io/hazelcast-nodejs-client/api/{page-latest-supported-nodejs-client}/docs/ +TIP: For 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]. + Node.js Client implementation for Hazelcast. It is implemented using the Hazelcast Open Binary Client Protocol. See Hazelcast Node.js client's GitHub https://github.com/hazelcast/hazelcast-nodejs-client[repo^] diff --git a/docs/modules/clients/pages/python.adoc b/docs/modules/clients/pages/python.adoc index 83b5e9b63..dd9b585cb 100644 --- a/docs/modules/clients/pages/python.adoc +++ b/docs/modules/clients/pages/python.adoc @@ -1,6 +1,8 @@ = Python Client :page-api-reference: https://hazelcast.readthedocs.io/en/v{page-latest-supported-python-client}/index.html +TIP: For latest Python API documentation, see https://hazelcast.readthedocs.io/en/v{page-latest-supported-python-client}/index.html[Hazelcast Python Client docs]. + Python Client implementation for Hazelcast. It is implemented using the Hazelcast Open Binary Client Protocol. See Hazelcast Python client's GitHub https://github.com/hazelcast/hazelcast-python-client[repo^]