Skip to content

Commit

Permalink
1st pass Data Structures nav tidy (hazelcast#1199)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverhowell authored Jul 29, 2024
1 parent 8fc2802 commit e7a8051
Show file tree
Hide file tree
Showing 7 changed files with 138 additions and 51 deletions.
2 changes: 1 addition & 1 deletion antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ antora:
trace: true
componentversions:
- name: hazelcast
version: '5.5-snapshot'
version: '6.0-snapshot'
mappings:
- module: maintain-cluster
family: attachment
Expand Down
2 changes: 1 addition & 1 deletion docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ asciidoc:
# The full major.minor.patch version, which is used as a variable in the docs for things like download links
full-version: '6.0.0-SNAPSHOT'
# The minor.patch version, which is used as a variable in the docs for things like file versions
minor-version: '5.5'
minor-version: '6.0-SNAPSHOT'
# The snapshot version for installing with brew
version-brew: '6.0.0-SNAPSHOT'
# Allows us to use UI macros. See https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/
Expand Down
16 changes: 10 additions & 6 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* xref:whats-new.adoc[What's new]
* xref:what-is-hazelcast.adoc[What is Hazelcast Platform]
* xref:getting-started:editions.adoc[Available versions]
//* xref:placeholder.adoc[Feature overview]
//* xref:placeholder.adoc[How Hazelcast works]
* Start a local cluster
** xref:getting-started:get-started-docker.adoc[Docker]
** xref:getting-started:get-started-cli.adoc[CLI]
Expand All @@ -20,6 +18,7 @@
** 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
* Overview
** xref:deploy:choosing-a-deployment-option.adoc[Available Topologies]
Expand All @@ -33,7 +32,7 @@
** xref:deploy:enterprise-licenses.adoc[Managing Enterprise license keys]
* xref:getting-started:install-hazelcast.adoc[Install {open-source-product-name}]
* xref:migrate:lts.adoc[]
* xref:migrate:community-to-enterprise.adoc[]
* xref:migrate:community-to-enterprise.adoc[Move to Enterprise from Community/OSS]
** xref:migrate:rolling-restart.adoc[]
* xref:migrate:data-migration-tool.adoc[]
* Upgrades
Expand All @@ -42,9 +41,9 @@
** xref:migrate:upgrading-from-imdg-3.adoc[]
** xref:migrate:migration-tool-imdg.adoc[]
*** xref:migrate:dmt-command-reference.adoc[]
//* xref:release-notes:releases.adoc[Release notes]
// * xref:placeholder.adoc[Troubleshooting]
// * xref:placeholder.adoc[FAQ]
* xref:release-notes:releases.adoc[Release notes]
.Develop & build
* Ingestion
** xref:ingest:overview.adoc[]
Expand Down Expand Up @@ -132,6 +131,7 @@ include::events:partial$nav.adoc[]
include::transactions:partial$nav.adoc[]
include::test:partial$nav.adoc[]
include::troubleshoot:partial$nav.adoc[]
.Operate & manage
include::configuration:partial$nav.adoc[]
* xref:maintain-cluster:logging.adoc[]
Expand Down Expand Up @@ -159,6 +159,7 @@ include::wan:partial$nav.adoc[]
** xref:osgi:configuring-osgi-support.adoc[]
** xref:osgi:design.adoc[]
** xref:osgi:using-osgi-service.adoc[]
.Integrate
* xref:integrate:connectors.adoc[Overview]
* Files
Expand Down Expand Up @@ -202,6 +203,7 @@ include::wan:partial$nav.adoc[]
* xref:integrate:socket-connector.adoc[]
* xref:integrate:http-connector.adoc[]
* xref:integrate:custom-connectors.adoc[]
.Clients & APIs
* xref:clients:hazelcast-clients.adoc[Overview]
* xref:clients:java.adoc[]
Expand All @@ -216,6 +218,7 @@ include::wan:partial$nav.adoc[]
* xref:clients:python.adoc[]
* xref:clients:nodejs.adoc[]
* xref:clients:go.adoc[]
.Tools & plugins
* xref:management-center.adoc[Management Center]
* xref:kubernetes:deploying-in-kubernetes.adoc#hazelcast-platform-operator-for-kubernetesopenshift[Platform Operator]
Expand All @@ -226,6 +229,7 @@ include::wan:partial$nav.adoc[]
** xref:plugins:web-session-replication.adoc[]
** xref:plugins:framework-integration.adoc[]
** xref:plugins:other-integrations.adoc[]
.Reference
* xref:ROOT:glossary.adoc[]
* xref:system-properties.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/architecture/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
** xref:architecture:event-time-processing.adoc[]
** xref:architecture:sliding-window.adoc[]
** xref:architecture:in-memory-storage.adoc[]
** xref:data-structures:vector-search-overview.adoc[]
Expand Down
86 changes: 45 additions & 41 deletions docs/modules/data-structures/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
* Distributed Data Structures
** xref:data-structures:distributed-data-structures.adoc[Overview]
** xref:cache:overview.adoc[]
** Map
*** xref:data-structures:map.adoc[Overview]
*** xref:data-structures:map-config.adoc[]
*** xref:data-structures:creating-a-map.adoc[]
*** xref:data-structures:reading-a-map.adoc[]
*** xref:data-structures:updating-map-entries.adoc[]
*** xref:data-structures:setting-data-format.adoc[]
*** xref:data-structures:backing-up-maps.adoc[]
*** xref:data-structures:managing-map-memory.adoc[]
*** xref:data-structures:locking-maps.adoc[]
*** xref:data-structures:listening-for-map-entries.adoc[]
*** xref:data-structures:reading-map-metrics.adoc[]
** xref:data-structures:vector-collections.adoc[Vector Collection]
** AP Data Structures
*** Map
**** xref:data-structures:map.adoc[Overview]
**** xref:data-structures:map-config.adoc[]
**** xref:data-structures:creating-a-map.adoc[]
**** xref:data-structures:reading-a-map.adoc[]
**** xref:data-structures:updating-map-entries.adoc[]
**** xref:data-structures:setting-data-format.adoc[]
**** xref:data-structures:backing-up-maps.adoc[]
**** xref:data-structures:managing-map-memory.adoc[]
**** xref:data-structures:locking-maps.adoc[]
**** xref:data-structures:listening-for-map-entries.adoc[]
**** xref:data-structures:reading-map-metrics.adoc[]
*** JCache
**** xref:jcache:jcache.adoc[Overview]
**** xref:jcache:overview.adoc[]
**** xref:jcache:setup.adoc[]
**** xref:jcache:providers.adoc[]
**** xref:jcache:api.adoc[]
**** xref:jcache:hazelcast-integration.adoc[]
**** xref:jcache:icache.adoc[]
**** xref:jcache:tck.adoc[]
*** xref:data-structures:topic.adoc[]
*** xref:data-structures:reliable-topic.adoc[]
*** xref:data-structures:queue.adoc[]
*** xref:data-structures:priority-queue.adoc[]
*** xref:data-structures:multimap.adoc[]
*** xref:data-structures:set.adoc[]
*** xref:data-structures:list.adoc[]
*** xref:data-structures:ringbuffer.adoc[]
** CP Data Structures
*** xref:data-structures:cpmap.adoc[]
*** xref:data-structures:fencedlock.adoc[]
*** xref:data-structures:iatomiclong.adoc[]
*** xref:data-structures:isemaphore.adoc[]
*** xref:data-structures:iatomicreference.adoc[]
*** xref:data-structures:icountdownlatch.adoc[]
*** xref:data-structures:pn-counter.adoc[]
*** xref:data-structures:flake-id-generator.adoc[]
*** xref:data-structures:replicated-map.adoc[]
** Streaming Data Structures
*** xref:data-structures:event-journal.adoc[]
** AI/ML Data Structures
*** xref:data-structures:cardinality-estimator-service.adoc[]
*** xref:data-structures:vector-collections.adoc[Vector Collection]
*** xref:data-structures:vector-search-overview.adoc[Data Structure Design]
** JCache
*** xref:jcache:jcache.adoc[Overview]
*** xref:jcache:overview.adoc[]
*** xref:jcache:setup.adoc[]
*** xref:jcache:providers.adoc[]
*** xref:jcache:api.adoc[]
*** xref:jcache:hazelcast-integration.adoc[]
*** xref:jcache:icache.adoc[]
*** xref:jcache:tck.adoc[]
** xref:data-structures:queue.adoc[]
** xref:data-structures:priority-queue.adoc[]
** xref:data-structures:multimap.adoc[]
** xref:data-structures:set.adoc[]
** xref:data-structures:list.adoc[]
** xref:data-structures:ringbuffer.adoc[]
** xref:data-structures:topic.adoc[]
** xref:data-structures:reliable-topic.adoc[]
** xref:data-structures:fencedlock.adoc[]
** xref:data-structures:iatomiclong.adoc[]
** xref:data-structures:isemaphore.adoc[]
** xref:data-structures:iatomicreference.adoc[]
** xref:data-structures:icountdownlatch.adoc[]
** xref:data-structures:cpmap.adoc[]
** xref:data-structures:pn-counter.adoc[]
** xref:data-structures:flake-id-generator.adoc[]
** xref:data-structures:replicated-map.adoc[]
** xref:data-structures:cardinality-estimator-service.adoc[]
** xref:data-structures:event-journal.adoc[]
78 changes: 78 additions & 0 deletions docs/modules/release-notes/pages/5-5-0.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
= 5.5.0 Release Notes
:description: These release notes list any new features, enhancements, fixes and breaking changes that were made between version 5.4.1 and version 5.5.0 of Hazelcast Platform.

{description}

// check version delta above

== New Features
* Vector collection data structure
* Multi-member routing for Java clients
* Jet job placement control
* Long-term Support (LTS) releases
* Feast feature store integration
* Debezium 2.x connector support
* Dynamic configuration using REST API

For more details on new features, see xref:ROOT:whats-new.adoc[What's new in 5.5].

== Breaking Changes
* For {open-source-product-name} users only - CP Subsystem is now an {enterprise-product-name} only feature
* Thread-per-core (TPC) requires `ALL_MEMBERS` cluster routing (previously known as smart routing) to function on clients

== Enhancements
* Replace smart-routing with cluster-routing options
* Update cluster routing mode compatibility for TPC
* Introduce queue cap props for persistence
* Allow EE member to join OS cluster
* Client connectivity logging
* Add needsFsync to Clear task
* Shade vector JAR in main enterprise JAR
* Manual index cleanup operation
* Re-introduce RU code for 5.2 -> 5.5 upgrade
* Configuration for number of neighbours fetched from partitions
* Fail-fast if specify CP config in a Community version
* Allow 5.5 member join clusters with version 5.0-5.4
* Add JobBuilder to JetService
* Introduce a common parent POM for hazelcast and hazelcast-enterprise
* Improve float array serialization performance
* Add CP direct-to-leader operation sending for `ADVANCED_CP` licensed clients
* Add ZGC bean names to support GC stats https://github.com/hazelcast/hazelcast/pull/26329[#26329]

== Fixes

* Delete Jet job resources immediately after job finishes
* Fix completed op count metric in OperationThread
* Fix incorrect results of parallel SQL queries with reusable processor meta-suppliers
* Restore previous ExecutionService graceful shutdown timeout value
* Improve float array serialization performance in client protocol
* Explicitly release netty release counted netty ssl engine
* Exclude non-WAN address aliases during WAN MemberHandshake
* JobConfig#add() not using derived id for some resources
* GCS connection issue workaround
* Correct UserCodeNamespaceService#reset behaviour
* Prevent SystemPropertiesConfigParser throwing ClassCastException on startup with non-String properties
* Don't use the default password from the SymmetricEncryptionConfig
* Make AddIndexBackupOperation allowed in passive state
* Execute PostJoin operations if member hot restart start is forced
* Fix partition migrating lock during concurrent migration and replication
* Fix known CP issue that caused OOMs due to leadership races
* Fix partitions initial offsets in Kafka connector https://github.com/hazelcast/hazelcast/pull/25769[#25769]
* IMap.delete operations don't update the LocalMapStats https://github.com/hazelcast/hazelcast/issues/26212[#26212]
* Updated StringUtil::trim() to consider all type of white space https://github.com/hazelcast/hazelcast/pull/25804[#25804]

== Removed/Deprecated Features
* The `smart-routing` client configuration option has been deprecated in favor of the new `cluster-routing` options

== Contributors

We would like to thank the contributors from our open source community
who worked on this release:

* https://github.com/RobbanHoglund[Robert Höglund]
* https://github.com/rickymemphis[Ricky Memphis]
* https://github.com/anestoruk[Andrzej Nestoruk]
* https://github.com/Gauravsalunke5[Gaurav Salunke]



3 changes: 2 additions & 1 deletion docs/modules/release-notes/pages/releases.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Hazelcast Platform 5.4.x release notes
= Hazelcast Platform release notes

* xref:release-notes:5-5-0.adoc[5.5.0]
* xref:release-notes:5-4-0.adoc[5.4.0]
* xref:release-notes:5-3-0.adoc[5.3.0]

0 comments on commit e7a8051

Please sign in to comment.