Skip to content

Commit

Permalink
Add API links as tips (#1161)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverhowell authored Jul 8, 2024
1 parent 14240e9 commit 134234a
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/modules/clients/pages/cplusplus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 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].

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
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/clients/pages/dotnet.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 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].

You can use the native .NET client to connect to Hazelcast client members.
The API is very similar to the Java native client.

Expand Down
2 changes: 2 additions & 0 deletions docs/modules/clients/pages/go.adoc
Original file line number Diff line number Diff line change
@@ -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 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].

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^]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/clients/pages/java.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
:page-toclevels: 3
[[java-client]]

TIP: For the 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.

Expand Down
7 changes: 3 additions & 4 deletions docs/modules/clients/pages/memcache.adoc
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
2 changes: 2 additions & 0 deletions docs/modules/clients/pages/nodejs.adoc
Original file line number Diff line number Diff line change
@@ -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 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].

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^]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/clients/pages/python.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
= Python Client
:page-api-reference: https://hazelcast.readthedocs.io/en/v{page-latest-supported-python-client}/index.html

TIP: For the 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^]
Expand Down

0 comments on commit 134234a

Please sign in to comment.