Skip to content

Commit

Permalink
DOC-65: implement new platform nav v1
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverhowell committed Jun 28, 2024
1 parent 7788fa5 commit 1f0405a
Show file tree
Hide file tree
Showing 12 changed files with 143 additions and 140 deletions.
2 changes: 2 additions & 0 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ site:
docsearch_id: 'QK2EAH8GB0'
docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
docsearch_index: 'prod_hazelcast_docs'
urls:
html_extension_style: drop
content:
sources:
- url: .
Expand Down
186 changes: 106 additions & 80 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,40 @@
** xref:getting-started:authenticate-clients.adoc[]
** xref:getting-started:wan.adoc[]
** xref:getting-started:blue-green.adoc[]
* Get started with SQL
** xref:sql:get-started-sql.adoc[]
** xref:sql:learn-sql.adoc[]
** xref:sql:get-started-sql-files.adoc[]
* xref:clients:hazelcast-clients.adoc[Get started with a Hazelcast Client]
* xref:getting-started:support.adoc[]
.Install & upgrade
* Deployment
* Overview
** xref:deploy:choosing-a-deployment-option.adoc[Available Topologies]
** xref:deploy:versioning-compatibility.adoc[Versioning and Compatibility]
** xref:deploy:deploying-in-cloud.adoc[Cloud deployment]
** xref:deploy:deploying-in-cloud.adoc[Deploying on Cloud]
*** xref:deploy:deploying-on-aws.adoc[]
*** xref:deploy:deploying-on-azure.adoc[]
*** xref:deploy:deploying-on-gcp.adoc[]
** xref:deploy:deploying-with-docker.adoc[]
* xref:getting-started:install-enterprise.adoc[Install {enterprise-product-name}]
** xref:deploy:enterprise-licenses.adoc[Managing Enterprise license keys]
* xref:getting-started:install-hazelcast.adoc[Install {open-source-product-name}]
* xref:placeholder.adoc[Upgrade to Enterprise from OSS/Community]
// * xref:placeholder.adoc[Upgrade to Enterprise from OSS/Community]
* xref:migrate:data-migration-tool.adoc[]
* Upgrades
** xref:migrate:upgrading-from-jet.adoc[]
** xref:migrate:upgrading-from-imdg-4.adoc[]
** xref:migrate:upgrading-from-imdg-3.adoc[]
** xref:migrate:migration-tool-imdg.adoc[]
** xref:migrate:data-migration-tool.adoc[]
*** xref:migrate:dmt-command-reference.adoc[]
* xref:release-notes:releases.adoc[Release notes]
// * xref:placeholder.adoc[Troubleshooting]
// * xref:placeholder.adoc[FAQ]
.Develop & build

* Finding the Right Tool
* Ingestion
** xref:ingest:overview.adoc[]
** xref:computing:distributed-computing.adoc[]
** xref:query:overview.adoc[]
Expand All @@ -54,6 +59,7 @@
** xref:cluster-performance:aws-deployments.adoc[]
** xref:cluster-performance:threading.adoc[]
** xref:cluster-performance:near-cache.adoc[]
include::architecture:partial$nav.adoc[]
* Member/Client Discovery
** xref:clusters:discovery-mechanisms.adoc[]
** xref:clusters:discovering-by-tcp.adoc[]
Expand All @@ -63,6 +69,57 @@ include::kubernetes:partial$nav.adoc[]
include::data-structures:partial$nav.adoc[]
include::mapstore:partial$nav.adoc[]
include::pipelines:partial$nav.adoc[]
* SQL
** xref:sql:sql-overview.adoc[Overview]
** SQL Over Maps
*** xref:sql:get-started-sql.adoc[Tutorial]
*** xref:sql:querying-maps-sql.adoc[Queries]
*** xref:sql:mapping-to-maps.adoc[Mappings]
** SQL Over Kafka
*** xref:sql:learn-sql.adoc[Tutorial]
*** xref:sql:mapping-to-kafka.adoc[Mappings]
** SQL Over File Systems
*** xref:sql:get-started-sql-files.adoc[Tutorial]
*** xref:sql:mapping-to-a-file-system.adoc[Mappings]
** SQL Over JDBC
*** xref:sql:mapping-to-jdbc.adoc[Mappings]
** SQL Over MongoDB
*** xref:sql:mapping-to-mongo.adoc[Mappings]
** xref:sql:working-with-json.adoc[Working with JSON]
** xref:sql:querying-streams.adoc[Stream Processing]
** xref:sql:parameterized-queries.adoc[Query Parameters]
** xref:sql:finding-mappings.adoc[Finding Mappings]
** xref:sql:improving-performance.adoc[Improving Performance]
** xref:sql:sql-reflection-configuration.adoc[Reflection Configuration]
** xref:sql:troubleshooting.adoc[Troubleshooting]
** Statements
*** xref:sql:sql-statements.adoc[Overview]
*** xref:sql:alter-job.adoc[`ALTER JOB`]
*** xref:sql:create-data-connection.adoc[`CREATE DATA CONNECTION`]
*** xref:sql:create-index.adoc[`CREATE INDEX`]
*** xref:sql:create-job.adoc[`CREATE JOB`]
*** xref:sql:create-mapping.adoc[`CREATE MAPPING`]
*** xref:sql:create-snapshot.adoc[`CREATE SNAPSHOT`]
*** xref:sql:create-view.adoc[`CREATE VIEW`]
*** xref:sql:delete.adoc[`DELETE`]
*** xref:sql:drop-data-connection.adoc[`DROP DATA CONNECTION`]
*** xref:sql:drop-job.adoc[`DROP JOB`]
*** xref:sql:drop-mapping.adoc[`DROP MAPPING`]
*** xref:sql:drop-snapshot.adoc[`DROP SNAPSHOT`]
*** xref:sql:drop-view.adoc[`DROP VIEW`]
*** xref:sql:explain.adoc[`EXPLAIN`]
*** xref:sql:sink-into.adoc[`INSERT INTO`/`SINK INTO`]
*** xref:sql:select.adoc[`SELECT`]
*** xref:sql:show-jobs.adoc[`SHOW JOBS`]
*** xref:sql:show-resources.adoc[`SHOW RESOURCES`]
*** xref:sql:show-mappings.adoc[`SHOW MAPPINGS`]
*** xref:sql:update.adoc[`UPDATE`]
** xref:sql:functions-and-operators.adoc[Functions and Expressions]
** xref:sql:data-types.adoc[]
** xref:sql:user-defined-types.adoc[]
** Optimizing SQL queries
*** xref:sql:partition-pruning.adoc[Partition Pruning]
** xref:query:predicate-overview.adoc[Predicates API]
include::query:partial$nav.adoc[]
* Improving Query Performance
** xref:query:indexing-maps.adoc[]
Expand Down Expand Up @@ -107,101 +164,70 @@ include::wan:partial$nav.adoc[]
** xref:osgi:using-osgi-service.adoc[]
.Integrate
include::integrate:partial$nav.adoc[]
include::spring:partial$nav.adoc[]
* xref:integrate:connectors.adoc[Overview]
* 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[]
* Integrating with Spring
** xref:spring:overview.adoc[Overview]
** xref:spring:configuration.adoc[]
** xref:spring:springaware.adoc[]
** xref:spring:add-caching.adoc[]
** xref:spring:hibernate.adoc[]
** xref:spring:transaction-manager.adoc[]
** xref:spring:best-practices.adoc[]
* 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 (options, what's available for SQL, what's available for JetAPI)
** xref:integrate:jcache-connector.adoc[]
** xref:integrate:list-connector.adoc[]
** xref:integrate:map-connector.adoc[]
** xref:integrate:reliable-topic-connector.adoc[]
* Databases
** xref:integrate:database-connectors.adoc[Overview]
** xref:integrate:jdbc-connector.adoc[]
** xref:integrate:cdc-connectors.adoc[]
** xref:integrate:elasticsearch-connector.adoc[]
** xref:integrate:mongodb-connector.adoc[]
** xref:integrate:influxdb-connector.adoc[]
** xref:integrate:redis-connector.adoc[]
* xref:integrate:test-connectors.adoc[]
* xref:integrate:socket-connector.adoc[]
* xref:integrate:http-connector.adoc[]
* xref:integrate:twitter-connector.adoc[]
* xref:integrate:custom-connectors.adoc[]
.Clients & APIs
* xref:clients:hazelcast-clients.adoc[Get started with a Hazelcast Client]
* xref:clients:hazelcast-clients.adoc[Overview]
* xref:clients:java.adoc[]
* xref:clients:cplusplus.adoc[]
* xref:clients:dotnet.adoc[]
* xref:clients:rest.adoc[]
* xref:maintain-cluster:enterprise-rest-api.adoc[]
* xref:clients:memcache.adoc[]
* xref:clients:python.adoc[]
* xref:clients:nodejs.adoc[]
* xref:clients:go.adoc[]
* SQL
** xref:sql:sql-overview.adoc[Overview]
** SQL Over Maps
*** xref:sql:get-started-sql.adoc[Tutorial]
*** xref:sql:querying-maps-sql.adoc[Queries]
*** xref:sql:mapping-to-maps.adoc[Mappings]
** SQL Over Kafka
*** xref:sql:learn-sql.adoc[Tutorial]
*** xref:sql:mapping-to-kafka.adoc[Mappings]
** SQL Over File Systems
*** xref:sql:get-started-sql-files.adoc[Tutorial]
*** xref:sql:mapping-to-a-file-system.adoc[Mappings]
** SQL Over JDBC
*** xref:sql:mapping-to-jdbc.adoc[Mappings]
** SQL Over MongoDB
*** xref:sql:mapping-to-mongo.adoc[Mappings]
** xref:sql:working-with-json.adoc[Working with JSON]
** xref:sql:querying-streams.adoc[Stream Processing]
** xref:sql:parameterized-queries.adoc[Query Parameters]
** xref:sql:finding-mappings.adoc[Finding Mappings]
** xref:sql:improving-performance.adoc[Improving Performance]
** xref:sql:sql-reflection-configuration.adoc[Reflection Configuration]
** xref:sql:troubleshooting.adoc[Troubleshooting]
** Statements
*** xref:sql:sql-statements.adoc[Overview]
*** xref:sql:alter-job.adoc[`ALTER JOB`]
*** xref:sql:create-data-connection.adoc[`CREATE DATA CONNECTION`]
*** xref:sql:create-index.adoc[`CREATE INDEX`]
*** xref:sql:create-job.adoc[`CREATE JOB`]
*** xref:sql:create-mapping.adoc[`CREATE MAPPING`]
*** xref:sql:create-snapshot.adoc[`CREATE SNAPSHOT`]
*** xref:sql:create-view.adoc[`CREATE VIEW`]
*** xref:sql:delete.adoc[`DELETE`]
*** xref:sql:drop-data-connection.adoc[`DROP DATA CONNECTION`]
*** xref:sql:drop-job.adoc[`DROP JOB`]
*** xref:sql:drop-mapping.adoc[`DROP MAPPING`]
*** xref:sql:drop-snapshot.adoc[`DROP SNAPSHOT`]
*** xref:sql:drop-view.adoc[`DROP VIEW`]
*** xref:sql:explain.adoc[`EXPLAIN`]
*** xref:sql:sink-into.adoc[`INSERT INTO`/`SINK INTO`]
*** xref:sql:select.adoc[`SELECT`]
*** xref:sql:show-jobs.adoc[`SHOW JOBS`]
*** xref:sql:show-resources.adoc[`SHOW RESOURCES`]
*** xref:sql:show-mappings.adoc[`SHOW MAPPINGS`]
*** xref:sql:update.adoc[`UPDATE`]
** xref:sql:functions-and-operators.adoc[Functions and Expressions]
** xref:sql:data-types.adoc[]
** xref:sql:user-defined-types.adoc[]
** Optimizing SQL queries
*** xref:sql:partition-pruning.adoc[Partition Pruning]
** xref:clients:clc.adoc[]
** xref:maintain-cluster:enterprise-rest-api.adoc[REST API]
*** xref:maintain-cluster:rest-api.adoc[Community Edition REST API]
** xref:query:predicate-overview.adoc[Predicates API]
.Tools & plugins
* xref:placeholder.adoc[Management Center]
* xref:management-center.adoc[Management Center]
* xref:kubernetes:deploying-in-kubernetes.adoc#hazelcast-platform-operator-for-kubernetesopenshift[Platform Operator]
* xref:placeholder.adoc[Command Line Client (CLC)]
* xref:clients:clc.adoc[Command Line Client (CLC)]
* xref:ROOT:simulator.adoc[Simulator]
* xref:plugins:hazelcast-plugins.adoc[]
** xref:plugins:cloud-discovery.adoc[]
** xref:plugins:web-session-replication.adoc[]
** xref:plugins:framework-integration.adoc[]
** xref:plugins:other-integrations.adoc[]
.xref:tutorials:tutorials-index.adoc[Tutorials]
* xref:tutorials:kubernetes.adoc[]
* xref:tutorials:java-client-getting-started.adoc[]
* xref:tutorials:csharp-client-getting-started.adoc[]
* xref:tutorials:go-client-getting-started.adoc[]
* xref:tutorials:nodejs-client-getting-started.adoc[]
* xref:tutorials:python-client-getting-started.adoc[]
* xref:tutorials:cpsubsystem.adoc[]
* xref:tutorials:join-two-streams.adoc[]
* xref:tutorials:stream-from-kafka-kerberos.adoc[]
* xref:tutorials:hazelcast-platform-operator-expose-externally.adoc[]
.Reference
* xref:ROOT:glossary.adoc[]
include::architecture:partial$nav.adoc[]
* xref:system-properties.adoc[]
* xref:faq.adoc[]
* xref:list-of-metrics.adoc[Metrics]
* xref:phone-homes.adoc[]
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/management-center.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Management Center
:description: Management Center is a tool for managing and monitoring Hazelcast Platform clusters.

{description}

For more information on features and getting started with Management Center, see xref:{page-latest-supported-mc}@management-center:getting-started:overview.adoc[Management Center docs].
32 changes: 16 additions & 16 deletions docs/modules/ROOT/pages/whats-new.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,6 @@
* xref:{page-latest-supported-hazelcast}@hazelcast:ROOT:whats-new.adoc[What's New in Hazelcast Platform 5.4]
* xref:{page-latest-supported-mc}@management-center:ROOT:whats-new.adoc[What's New in Management Center 5.4]
== Tiered Storage now generally available (GA)
[.enterprise]*Enterprise*

Tiered Storage ensures that frequently accessed (_high-hit_) data remains in fast memory and less frequently accessed (_low-hit_) data is stored on cheaper disks. We are delighted to confirm this functionality is now generally available as an Enterprise feature.

Tiered Storage uses an in-memory index to provide faster access to map entries. A dedicated memory manager decides which entries to store in the memory tier and which to store in the disk tier. If a map entry is not accessed for some time, it is flushed or _spilled_ to disk – if a map is frequently accessed, it stays in memory. Tiered Storage allows the cluster to hold more data than the total available RAM.

For more information on how to enable and configure this feature, see xref:tiered-storage:overview.adoc[].

== Use CP Map for mission-critical workflows
[.enterprise]*Enterprise*

Expand All @@ -25,13 +16,6 @@ The CP Subsystem is the Hazelcast component that builds a strongly consistent la

For more information on how to use this new `CPMap` data structure, see xref:data-structures:cpmap.adoc[].

== Thread-Per-Core (TPC) now generally available (GA)
[.enterprise]*Enterprise*

Enable Thread-Per-Core (TPC) on both clients and cluster members to improve system performance, especially in environments where the number of CPU cores on your machines does not match the recommended hardware. TPC is an alternative to traditional Staged Event-Driven Architecture (SEDA) that supports easier scaling based on the number of available cores.

For more information on how to enable and configure TPC, see xref:cluster-performance:thread-per-core-tpc.adoc[].

== Manage resources effectively with User Code Namespaces
[.enterprise]*Enterprise*

Expand All @@ -47,6 +31,22 @@ For more information on how to enable and configure User Code Namespaces, or mig

**JDBC SQL Connector (SQL over JDBC)** is now generally available. In addition to MySQL and PostgreSQL, the JDBC SQL connector now also supports Oracle and Microsoft SQL Server databases. For more information, see xref:sql:mapping-to-jdbc.adoc#data-type-mapping-between-hazelcast-and-mssql[Mapping between Hazelcast and MSSQL].

== Thread-Per-Core (TPC) now generally available (GA)
[.enterprise]*Enterprise*

Enable Thread-Per-Core (TPC) on both clients and cluster members to improve system performance, especially in environments where the number of CPU cores on your machines does not match the recommended hardware. TPC is an alternative to traditional Staged Event-Driven Architecture (SEDA) that supports easier scaling based on the number of available cores.

For more information on how to enable and configure TPC, see xref:cluster-performance:thread-per-core-tpc.adoc[].

== Tiered Storage now generally available (GA)
[.enterprise]*Enterprise*

Tiered Storage ensures that frequently accessed (_high-hit_) data remains in fast memory and less frequently accessed (_low-hit_) data is stored on cheaper disks. We are delighted to confirm this functionality is now generally available as an Enterprise feature.

Tiered Storage uses an in-memory index to provide faster access to map entries. A dedicated memory manager decides which entries to store in the memory tier and which to store in the disk tier. If a map entry is not accessed for some time, it is flushed or _spilled_ to disk – if a map is frequently accessed, it stays in memory. Tiered Storage allows the cluster to hold more data than the total available RAM.

For more information on how to enable and configure this feature, see xref:tiered-storage:overview.adoc[].

== Upgrade Requirements

Hazelcast Platform 5.4 requires Java 17 or later.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/configuration/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@
*** xref:configuration:dynamic-config-programmatic-api.adoc[Programmatic API]
*** xref:configuration:dynamic-config-update-and-reload.adoc[Update and Reload with REST]
*** xref:configuration:dynamic-config-persistence.adoc[Configuration Options]
** xref:phone-homes.adoc[]
2 changes: 1 addition & 1 deletion docs/modules/getting-started/pages/install-hazelcast.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Installing Hazelcast {open-source-product-name}
:description: You can install the {open-source-product-name} of Hazelcast, using the command line interface (CLI), Docker, the binary, or Java.]
:description: You can install the {open-source-product-name} of Hazelcast, using the command line interface (CLI), Docker, the binary, or Java.
:page-aliases: installing-using-download-archives.adoc, deploy:running-in-modular-java.adoc

{description}
Expand Down
33 changes: 1 addition & 32 deletions docs/modules/integrate/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,5 @@
* Connector Guides
** xref:integrate:connectors.adoc[Overview]
** 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[]
** Kafka Connect Connectors
*** xref:integrate:kafka-connect-connectors.adoc[Source Connectors]
** 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 (options, what's available for SQL, what's available for JetAPI)
*** xref:integrate:jcache-connector.adoc[]
*** xref:integrate:list-connector.adoc[]
*** xref:integrate:map-connector.adoc[]
*** xref:integrate:reliable-topic-connector.adoc[]
** Databases
*** xref:integrate:database-connectors.adoc[Overview]
*** xref:integrate:jdbc-connector.adoc[]
*** xref:integrate:cdc-connectors.adoc[]
*** xref:integrate:elasticsearch-connector.adoc[]
*** xref:integrate:mongodb-connector.adoc[]
*** xref:integrate:influxdb-connector.adoc[]
*** xref:integrate:redis-connector.adoc[]
** xref:integrate:test-connectors.adoc[]
** xref:integrate:socket-connector.adoc[]
** xref:integrate:http-connector.adoc[]
** xref:integrate:twitter-connector.adoc[]
** xref:integrate:custom-connectors.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/kubernetes/pages/deploying-in-kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Explore some step-by-step guides about how to use Hazelcast in Kubernetes.

=== Getting Started

* link:https://guides.hazelcast.org/kubernetes/[Deploy Hazelcast Cluster on Kubernetes]
* xref:tutorials:kubernetes.adoc[Deploy Hazelcast using Kubernetes]

=== Hazelcast Platform Operator

Expand Down
1 change: 1 addition & 0 deletions docs/modules/kubernetes/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
* Kubernetes
** xref:kubernetes:deploying-in-kubernetes.adoc[Overview]
** xref:tutorials:kubernetes.adoc[Deploy Hazelcast using Kubernetes]
** xref:kubernetes:deploying-in-kubernetes.adoc#hazelcast-platform-operator-for-kubernetesopenshift[Hazelcast Platform Operator]
** xref:kubernetes:kubernetes-auto-discovery.adoc[Discovery and Partitioning]
** xref:kubernetes:kubernetes-persistence.adoc[Persistence]
Expand Down
Loading

0 comments on commit 1f0405a

Please sign in to comment.