Merge branch 'hazelcast:main' into main

hazelcast · Nov 14, 2024 · bc20b7c · bc20b7c
2 parents 52f2578 + 4f65371
commit bc20b7c
Show file tree

Hide file tree

Showing 141 changed files with 5,361 additions and 4,578 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,3 +1,3 @@
 # These owners will be the default owners for everything in
 # the repo
-*   @oliverhowell @amandalindsay
+*   @oliverhowell @amandalindsay @Rob-Hazelcast
diff --git a/.github/workflows/action-updater.yml b/.github/workflows/action-updater.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4.1.4
+      - uses: actions/checkout@v4
         with:
           # [Required] Access token with `workflow` scope.
           token: ${{ secrets.ACTION_UPDATER }}

diff --git a/.github/workflows/adoc-html.yml b/.github/workflows/adoc-html.yml
@@ -9,8 +9,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4.1.4
-    - uses: actions/setup-node@v4.0.2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
       with:
         node-version: 20
     - name: Convert adoc

diff --git a/.github/workflows/backport-5-0.yml b/.github/workflows/backport-5-0.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
 
       - name: checkout
-        uses: actions/checkout@v4.1.4
+        uses: actions/checkout@v4
         with:
          fetch-depth: 0
 

diff --git a/.github/workflows/backport-5-1.yml b/.github/workflows/backport-5-1.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
 
       - name: checkout
-        uses: actions/checkout@v4.1.4
+        uses: actions/checkout@v4
         with:
          fetch-depth: 0
 

diff --git a/.github/workflows/backport-5-2.yml b/.github/workflows/backport-5-2.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
 
       - name: checkout
-        uses: actions/checkout@v4.1.4
+        uses: actions/checkout@v4
         with:
          fetch-depth: 0
 

diff --git a/.github/workflows/backport-5-3.yml b/.github/workflows/backport-5-3.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
 
       - name: checkout
-        uses: actions/checkout@v4.1.4
+        uses: actions/checkout@v4
         with:
          fetch-depth: 0
 

diff --git a/.github/workflows/backport-5-4.yml b/.github/workflows/backport-5-4.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
 
       - name: checkout
-        uses: actions/checkout@v4.1.4
+        uses: actions/checkout@v4
         with:
          fetch-depth: 0
 

diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
 
       - name: checkout
-        uses: actions/checkout@v4.1.4
+        uses: actions/checkout@v4
         with:
          fetch-depth: 0
 

diff --git a/.github/workflows/forwardport.yml b/.github/workflows/forwardport.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
 
       - name: checkout
-        uses: actions/checkout@v4.1.4
+        uses: actions/checkout@v4
         with:
          fetch-depth: 0
 

diff --git a/.github/workflows/to-plain-html.yml b/.github/workflows/to-plain-html.yml
@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:              
-      - uses: actions/checkout@v4.1.4
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.TO_HTML }}      
       - name: Asciidoc to html

diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -13,8 +13,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4.1.4
-    - uses: actions/setup-node@v4.0.2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
       with:
         node-version: 20
     - name: Check for broken internal links

diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml
@@ -7,6 +7,7 @@ site:
     docsearch_id: 'QK2EAH8GB0'
     docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
     docsearch_index: 'prod_hazelcast_docs'
+    ai_search_id: '6b326171-dd1e-40c6-a948-1f9bb6c0ed52'       
 urls:
   html_extension_style: drop    
 content:
@@ -19,7 +20,7 @@ content:
 #    start_path: docs/rest
 ui:
   bundle:
-    url: ../hazelcast-docs-ui/build/ui-bundle.zip
+    url:  https://github.com/hazelcast/hazelcast-docs-ui/releases/latest/download/ui-bundle.zip #../hazelcast-docs-ui/build/ui-bundle.zip
     snapshot: true
 antora:
   extensions:

diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -1,12 +1,13 @@
 site:
   title: Documentation
   url: https://hardcore-allen-f5257d.netlify.app/
-  start_page: hazelcast:getting-started:get-started-cli.adoc
+  start_page: hazelcast:ROOT:what-is-hazelcast.adoc
   robots: disallow
   keys:
     docsearch_id: 'QK2EAH8GB0'
     docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
     docsearch_index: 'prod_hazelcast_docs'
+    ai_search_id: '6b326171-dd1e-40c6-a948-1f9bb6c0ed52'        
 content:
   sources:
   - url: .

diff --git a/docs/antora.yml b/docs/antora.yml
@@ -14,21 +14,23 @@ asciidoc:
     minor-version: '6.0-SNAPSHOT'
     # The snapshot version for installing with brew
     version-brew: '6.0.0-SNAPSHOT'
+    java-client-standalone-version: '5.5.0-BETA'
     # Allows us to use UI macros. See https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/
     experimental: true
     snapshot: true
     page-toclevels: 1@
     # All page-latest attributes are used as a variable in the docs for things like download links and search results
     page-latest-cli: '5.2021.09'
     # Must be lowercase because this is how the version appears in the docs
-    page-latest-supported-mc: '5.6-snapshot'
+    page-latest-supported-mc: '6.0-snapshot'
     page-latest-supported-java-client: '6.0.0-SNAPSHOT'
+    page-latest-supported-java-client-new: '5.5.0-BETA'
     # https://github.com/hazelcast/hazelcast-go-client/releases
     page-latest-supported-go-client: '1.4.2'
     # https://github.com/hazelcast/hazelcast-cpp-client/releases
     page-latest-supported-cplusplus-client: '5.3.0'
     # https://github.com/hazelcast/hazelcast-csharp-client/releases
-    page-latest-supported-csharp-client: '5.4.0'
+    page-latest-supported-csharp-client: '5.5.0'
     # https://github.com/hazelcast/hazelcast-python-client/releases
     page-latest-supported-python-client: '5.5.0'
     # https://github.com/hazelcast/hazelcast-nodejs-client/releases
@@ -37,5 +39,11 @@ asciidoc:
     page-latest-supported-clc: '5.4.1'
     open-source-product-name: 'Community Edition'
     enterprise-product-name: 'Enterprise Edition'
+    java-client-new: 'Java Client (Standalone)'
+    java-client: 'Java Client and Embedded Server'
+    url-cloud-signup: https://cloud.hazelcast.com/sign-up?utm_source=docs-website
+    hazelcast-cloud: Cloud
+    ucn: User Code Namespaces
+    ucd: User Code Deployment
 nav:
   - modules/ROOT/nav.adoc
diff --git a/docs/modules/ROOT/examples/helper/LicenseUtils.java b/docs/modules/ROOT/examples/helper/LicenseUtils.java
@@ -18,7 +18,7 @@
  * <li>the system property {@code -Dhazelcast.enterprise.license.key=<YOUR_LICENSE_KEY_HERE>}</li>
  * </ul>
  *
- * You can request a trial key at http://hazelcast.com/hazelcast-enterprise-trial
+ * You can request a trial key at http://hazelcast.com/hazelcast-enterprise-trial?utm_source=docs-website
  */
 public final class LicenseUtils {
 

diff --git a/docs/modules/ROOT/images/Ask_AI_JDK.png b/docs/modules/ROOT/images/Ask_AI_JDK.png
diff --git a/docs/modules/ROOT/images/Ask_AI_demo.gif b/docs/modules/ROOT/images/Ask_AI_demo.gif
diff --git a/docs/modules/ROOT/images/ask_ai.png b/docs/modules/ROOT/images/ask_ai.png
diff --git a/docs/modules/ROOT/images/ask_ai_search.png b/docs/modules/ROOT/images/ask_ai_search.png
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -1,6 +1,7 @@
 .Get started
 * xref:whats-new.adoc[What's new]
 * xref:what-is-hazelcast.adoc[What is Hazelcast Platform]
+* xref:ask-ai.adoc[]
 * xref:getting-started:editions.adoc[Available versions]
 * Start a local cluster
 ** xref:getting-started:get-started-docker.adoc[Docker]
@@ -184,16 +185,19 @@ include::wan:partial$nav.adoc[]
 ** xref:integrate:feast-config.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:integrate-with-vertx.adoc[]
+** xref:integrate:get-started-with-vertx.adoc[]
 // Connectors
 * Messaging System Connectors
-* xref:integrate:messaging-system-connectors.adoc[Overview]
+** xref:integrate:messaging-system-connectors.adoc[Overview]
 ** xref:integrate:kafka-connector.adoc[]
 ** xref:integrate:kinesis-connector.adoc[]
 ** xref:integrate:jms-connector.adoc[]
 // Database and CDC
 * xref:integrate:database-connectors.adoc[Database & CDC Connectors]
 ** xref:integrate:jdbc-connector.adoc[]
 ** xref:integrate:cdc-connectors.adoc[]
+** xref:integrate:legacy-cdc-connectors.adoc[]
 ** xref:integrate:elasticsearch-connector.adoc[]
 ** xref:integrate:mongodb-connector.adoc[]
 * File Connectors

diff --git a/docs/modules/ROOT/pages/ask-ai.adoc b/docs/modules/ROOT/pages/ask-ai.adoc
@@ -0,0 +1,33 @@
+= Ask AI
+:description: Use our Ask AI feature to get instant answers to technical questions.
+
+== Overview
+image:ask_ai.png[Ask AI,role="related thumb right"] You can use the *Ask AI* feature available on every docs page to get answers to your technical questions. The chatbot has indexed all Hazelcast documentation, including standalone API docs microsites, and selected hazelcast.com and support content. The AI uses the information from the knowledge sources to answer questions and does not make up information if it's not listed in the sources.
+
+To use Ask AI, click the *Ask AI* button in the bottom right of any docs.hazelcast.com page.
+
+Ask AI currently indexes the following sources:
+
+- docs.hazelcast.com (the /latest version for all products and tools)
+- API docs for languages and clients (Javadoc, C++, .NET/C#, Node.js, Python, Go)
+- hazelcast.com/blog (from last two years)
+- hazelcast.com/developers/clients
+- support.hazelcast.com
+- Hazelcast Code Samples repository
+
+IMPORTANT: This is an experimental custom LLM for answering technical questions about Hazelcast. Answers are based *only* on Hazelcast documentation and support sources, but may not be fully accurate so please use your best judgement.
+
+== Tips
+
+- Don't forget to rate the answers using the voting buttons. And please give detailed feedback if the answers you receive aren't correct or could be improved, as this feedback helps us improve Ask AI!
+- You can ask follow up questions or clarify the scope or use case to focus the conversation and get the information you're looking for.
+- You can also ask the chatbot to identify problems in code or configuration files, or create, for example, a pom.xml with certain features enabled.
+- Answers are all based on English language content (see sources listed above) but you can ask and receive answers in different languages. 
+- If the answer is not documented in the indexed sources then Ask AI will be unable to provide an answer (feedback is especially welcome in cases where you would expect the answer to be documented and indexed).
+
+== Search
+
+You can also use the *Search* tab within Ask AI to search the same sources, and toggle between Search and Ask AI mode.
+
+image:ask_ai_search.png[Search with Ask AI]
+
diff --git a/docs/modules/ROOT/pages/production-checklist.adoc b/docs/modules/ROOT/pages/production-checklist.adoc
@@ -53,7 +53,7 @@ Consider the following for VMWare ESX:
 * Network performance issues, including timeouts, might occur with LRO (Large Receive Offload)
 enabled on Linux virtual machines and ESXi/ESX hosts. We have specifically had
 this reported in VMware environments, but it could potentially impact other environments as well.
-We strongly recommend disabling LRO when running in virtualized environments, see https://kb.vmware.com/s/article/1027511.
+Although this issue is observed only under certain conditions, we strongly recommend either using the e1000 device driver, or disabling LRO when running in virtualized environments. For more information, see https://kb.vmware.com/s/article/1027511.
 
 === Windows
 

diff --git a/docs/modules/ROOT/pages/system-properties.adoc b/docs/modules/ROOT/pages/system-properties.adoc
@@ -1068,7 +1068,7 @@ These operations log a warning and are shown in the Management Center with detai
 |`hazelcast.socket.bind.any`
 | true
 | bool
-| Bind both server-socket and client-sockets to any local interface.
+| Bind both server-socket and client-sockets to any local interface. For ZIP and TAR distributions, this is overridden by false in configuration files.
 
 |`hazelcast.socket.buffer.direct`
 | false

diff --git a/docs/modules/ROOT/pages/whats-new.adoc b/docs/modules/ROOT/pages/whats-new.adoc
@@ -6,6 +6,14 @@ NOTE: The What's New page for Hazelcast Platform 6.0-SNAPSHOT will be available
 
 {description}
 
+== Get instant answers with new Hazelcast Ask AI
+
+On every docs page you can now click the *Ask AI* button in the bottom right and get instant answers to all your questions about Hazelcast Platform, and our tools and clients. Ask AI is powered by the entire suite of Hazelcast documentation, including the latest docs from docs.hazelcast.com, the various API docs microsites, the latest official blogs, and a bunch of code samples and support knowledgebase articles.
+
+image:Ask_AI_JDK.png[Ask AI example]
+
+Give it a try now - for more information, see xref:ask-ai.adoc[].
+
 == New Vector Collection for building semantic search (BETA)
 [.enterprise]*Enterprise* 
 

diff --git a/docs/modules/architecture/pages/data-partitioning.adoc b/docs/modules/architecture/pages/data-partitioning.adoc
@@ -201,6 +201,7 @@ Please note that `IndeterminateOperationStateException` does not apply to
 read-only operations, such as `map.get()`. If a partition primary replica member crashes before
 replying to a read-only operation, the operation is retried on the new owner of the primary replica.
 
+[[best-effort-consistency]]
 === Best-Effort Consistency
 
 The replication algorithm for AP data structures enables Hazelcast clusters to offer high throughput.

diff --git a/docs/modules/cache/pages/overview.adoc b/docs/modules/cache/pages/overview.adoc
@@ -7,9 +7,9 @@
 :url-hibernate: http://hibernate.org
 :url-spring: https://spring.io/projects/spring-framework
 :url-jetty: https://www.eclipse.org/jetty/documentation/current/configuring-sessions-hazelcast.html
-:blog-caching-patterns: https://hazelcast.com/blog/a-hitchhikers-guide-to-caching-patterns/
-:glossary-hibernate: https://hazelcast.com/glossary/hibernate-second-level-cache/
-:use-cases-jcache: https://hazelcast.com/use-cases/jcache-provider/
+:blog-caching-patterns: https://hazelcast.com/blog/a-hitchhikers-guide-to-caching-patterns/?utm_source=docs-website
+:glossary-hibernate: https://hazelcast.com/glossary/hibernate-second-level-cache/?utm_source=docs-website
+:use-cases-jcache: https://hazelcast.com/use-cases/jcache-provider/?utm_source=docs-website
 :guides-spring-boot: https://guides.hazelcast.org/hazelcast-embedded-springboot/
 :guides-spring-boot-caching: https://guides.hazelcast.org/caching-springboot/
 :guides-spring-boot-web-sessions: https://guides.hazelcast.org/caching-springboot/

diff --git a/docs/modules/clients/pages/hazelcast-clients.adoc b/docs/modules/clients/pages/hazelcast-clients.adoc
@@ -27,7 +27,7 @@ Additional tools are available to help operate and manage Hazelcast Platform clu
 Not all features are available in all clients.
 
 To find out which features are available in each client,
-see the link:https://hazelcast.com/developers/clients/[clients page].
+see the link:https://hazelcast.com/developers/clients/?utm_source=docs-website[clients page].
 
 After selecting the language you need, you can find the table showing supported features on the selected language.