Feast main fixes + API links (#1291)

Forwardports changes implemented for 5.5 at release --------- Co-authored-by: rebekah-lawrence <[email protected]>
hazelcast · Sep 16, 2024 · ab5ece8 · ab5ece8
1 parent b076f34
commit ab5ece8
Show file tree

Hide file tree

Showing 13 changed files with 35 additions and 14 deletions.
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -166,7 +166,11 @@ include::wan:partial$nav.adoc[]
 
 .Integrate
 * xref:integrate:connectors.adoc[Overview]
-* Integrating with Spring
+* Files
+// Files need an overview (options, what's available for SQL, what's available for Jet API)
+** xref:integrate:file-connector.adoc[]
+** xref:integrate:legacy-file-connector.adoc[]
+* Integrate with Spring
 ** xref:spring:overview.adoc[Overview]
 ** xref:spring:configuration.adoc[]
 ** xref:spring:springaware.adoc[]
@@ -175,9 +179,17 @@ include::wan:partial$nav.adoc[]
 ** xref:spring:transaction-manager.adoc[]
 ** xref:spring:best-practices.adoc[]
 * xref:integrate:integrate-with-feast.adoc[]
-** xref:integrate:install-connect.adoc[]
+** xref:integrate:install-connect.adoc[Install and connect Feast]
 ** xref:integrate:feast-config.adoc[]
-** xref:integrate:feature-engineering-with-feast.adoc[]
+** xref:integrate:feature-engineering-with-feast.adoc[Get started with Feast batch features]
+** xref:integrate:streaming-features-with-feast.adoc[Get started with Feast streaming features]
+* xref:integrate:kafka-connect-connectors.adoc[]
+* Messaging System Connectors
+** xref:integrate:messaging-system-connectors.adoc[Overview]
+** xref:integrate:kafka-connector.adoc[]
+** xref:integrate:kinesis-connector.adoc[]
+** xref:integrate:jms-connector.adoc[]
+** xref:integrate:pulsar-connector.adoc[]
 * Data Structure Connectors
 // Need an overview
 ** xref:integrate:map-connector.adoc[]

diff --git 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 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

diff --git 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 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.
 

diff --git 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 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^]

diff --git 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 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.
 

diff --git 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
@@ -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^]

diff --git 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 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^]

diff --git a/docs/modules/integrate/pages/feast-config.adoc b/docs/modules/integrate/pages/feast-config.adoc
@@ -1,5 +1,4 @@
 = Configure Feature Store
-:page-enterprise: true
 :description: To use a Feast project, you must configure the feature store. The configuration is defined in a YAML configuration file.
 
 {description}

diff --git a/docs/modules/integrate/pages/feature-engineering-with-feast.adoc b/docs/modules/integrate/pages/feature-engineering-with-feast.adoc
@@ -13,7 +13,7 @@ Finally, you will transfer the features in the offline store to the online store
 
 You will need the following ready before starting the tutorial:
 
-* Hazelcast CLC. link:https://docs.hazelcast.com/clc/latest/install-clc[Installation instructions]
+* Hazelcast CLC (see link:https://docs.hazelcast.com/clc/latest/install-clc[Install CLC])
 * A recent version of Docker and Docker Compose
 
 To set up your project, complete the following steps:

diff --git a/docs/modules/integrate/pages/install-connect.adoc b/docs/modules/integrate/pages/install-connect.adoc
@@ -1,5 +1,4 @@
 = Install Feast and Connect to Hazelcast
-:page-enterprise: true
 :description: Before you can use Feast with Hazelcast as an online store, you must install Feast and connect to Hazelcast.
 
 {description}

diff --git a/docs/modules/integrate/pages/integrate-with-feast.adoc b/docs/modules/integrate/pages/integrate-with-feast.adoc
@@ -1,5 +1,4 @@
 = Integrate with Feast
-:page-enterprise: true
 :description: pass:q[Feast (**Fea**ture **St**ore) is a customizable operational data system, which uses your existing infratstructure to manage and serve machine learning features to real-time models. When integrated with Hazelcast, you can benefit from an online store that supports materializing feature values in a running Hazelcast cluster.]
 
 {description}
@@ -115,5 +114,5 @@ To use Feast with Hazelcast, you must do the following:
 
 You can also work through the following tutorials:
 
-* Get Started with Feature Store
-* Feature Compute and Transformation
+* xref:integrate:feature-engineering-with-feast.adoc[Get started with Feast streaming]
+* xref:integrate:streaming-features-with-feast.adoc[Get started with Feast feature engineering]
diff --git a/docs/modules/integrate/pages/streaming-features-with-feast.adoc b/docs/modules/integrate/pages/streaming-features-with-feast.adoc
@@ -12,7 +12,7 @@ Then update the online feature store using a Jet job in real time from transacti
 
 You will need the following ready before starting the tutorial:
 
-* Hazelcast CLC - link:https://docs.hazelcast.com/clc/latest/install-clc[Installation instructions]
+* Hazelcast CLC (see link:https://docs.hazelcast.com/clc/latest/install-clc[Install CLC])
 * A recent version of Docker and Docker Compose
 
 To set up your project, complete the following steps:
@@ -346,6 +346,7 @@ Outputs something similar to:
   ]
 }
 ----
+
 == Summary
 
 In this tutorial, you learned how to set up a feature engineering project that uses Hazelcast as the online store.