From 5099f5628ac1dd182fb7a85b4899f46c28a35d3b Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Wed, 4 Sep 2024 14:46:15 +0300 Subject: [PATCH 1/3] fix errors --- .../pages/dynamic-config-via-rest.adoc | 12 ++++---- .../pages/enterprise-rest-api.adoc | 28 +++++++++---------- .../maintain-cluster/pages/shutdown.adoc | 12 ++++---- .../migrate/pages/upgrading-from-imdg-3.adoc | 3 +- docs/modules/release-notes/pages/5-4-0.adoc | 4 +-- 5 files changed, 31 insertions(+), 28 deletions(-) diff --git a/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc b/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc index 8ca2789ea..71177a812 100644 --- a/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc +++ b/docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc @@ -116,7 +116,7 @@ Here is the expected response body: == Step 2. Create map with new configuration -Access the `/map/{mapName}/{key}` POST endpoint to create the map and add an entry: +Access the `/map/\{mapName}/\{key}` POST endpoint to create the map and add an entry: [tabs] ==== @@ -136,7 +136,7 @@ curl -X POST \ Using Swagger UI:: + - Open the Swagger UI at http://localhost:8443/swagger-ui/index.html. -- Navigate to the `/map/{mapName}/{key}` POST endpoint under the *Data Controller* section. +- Navigate to the `/map/\{mapName}/\{key}` POST endpoint under the *Data Controller* section. - Click **Try it out**. - Enter `my-map` and `1` in the 'mapName' and `key` fields respectively. - Enter the value in the request body section: @@ -154,7 +154,7 @@ You can use https://docs.hazelcast.com/management-center/latest/data-structures/ == Step 3. Create queue with new configuration -Access the `/queue/{queueName}` POST endpoint to create the queue and add an item: +Access the `/queue/\{queueName}` POST endpoint to create the queue and add an item: [tabs] ==== @@ -174,7 +174,7 @@ curl -X POST \ Using Swagger UI:: + - Open the Swagger UI at http://localhost:8443/swagger-ui/index.html. -- Navigate to the `/queue/{queueName}` POST endpoint under the *Data Controller* section. +- Navigate to the `/queue/\{queueName}` POST endpoint under the *Data Controller* section. - Click **Try it out**. - Enter `my-queue` in the 'queueName' field. - Enter the item value in the request body section: @@ -210,14 +210,14 @@ curl -X 'POST' \ Using Swagger UI:: + - Open the Swagger UI at http://localhost:8443/swagger-ui/index.html. -- Navigate to the `/map/{mapName}/{key}` POST endpoint under the *Config Controller* section. +- Navigate to the `/map/\{mapName}/\{key}` POST endpoint under the *Config Controller* section. - Click **Try it out**. - Click **Execute**. ==== == Next Steps -If you're interested in learning more about the topics introduced in this tutorial, see: +If you're interested in learning more about the topics introduced in this tutorial, see: * xref:enterprise-rest-api.adoc#update-dynamic-configuration-using-rest[REST Dynamic Configuration] * xref:configuration:dynamic-config.adoc[Dynamic Configuration for Members] diff --git a/docs/modules/maintain-cluster/pages/enterprise-rest-api.adoc b/docs/modules/maintain-cluster/pages/enterprise-rest-api.adoc index 30e487b91..074f71841 100644 --- a/docs/modules/maintain-cluster/pages/enterprise-rest-api.adoc +++ b/docs/modules/maintain-cluster/pages/enterprise-rest-api.adoc @@ -24,9 +24,9 @@ NOTE: The REST API comes packaged with Spring framework and FasterXML Jackson de REST service is disabled by default; to enable the REST service you must change the configuration as follows: -[tabs] -==== -XML:: +[tabs] +==== +XML:: + -- [source,xml] @@ -64,11 +64,11 @@ The default port for the REST API is `8443`. To change it to another port, updat NOTE: If the port is occupied, the server instance will fail to start. To run multiple server instances with REST on the same machine, each instance should have a separate configuration file with a unique port assigned to it. -[tabs] -==== -XML:: -+ --- +[tabs] +==== +XML:: ++ +-- [source,xml] ---- @@ -151,7 +151,7 @@ XML:: - + com.hazelcast.internal.rest.access.DefaultAccessControlServiceFactory @@ -180,7 +180,7 @@ hazelcast: password: 'restpassword' roles: - admin - access-control-service: + access-control-service: factory-class-name: com.hazelcast.internal.rest.access.DefaultAccessControlServiceFactory ---- @@ -413,7 +413,7 @@ On the Swagger page, each endpoint is listed with a caret icon on the right side image::rest-api-swagger-expanding-an-endpoint.png[Example Swagger UI showing cluster endpoint] -After expanding the endpoint, let's send a request. Click **Try it out**. There are no parameters for this example but if there were you could enter these here. Click **Execute** to send the request. +After expanding the endpoint, let's send a request. Click **Try it out**. There are no parameters for this example but if there were you could enter these here. Click **Execute** to send the request. image::rest-api-swagger-clicking-execute-button.png[] @@ -530,7 +530,7 @@ curl -X 'POST' \ === Destroy a CP Group -You can send a `DELETE` request to the endpoint at `/hazelcast/rest/api/v1/cp/groups/{group-name}` to unconditionally destroy the given active CP group. For example, using cURL: +You can send a `DELETE` request to the endpoint at `/hazelcast/rest/api/v1/cp/groups/\{group-name}` to unconditionally destroy the given active CP group. For example, using cURL: [source,shell] ---- @@ -540,7 +540,7 @@ curl -X 'DELETE' \ ---- * If successful, it will return a `200` response without body. -* If you try to destroy METADATA group, it will return a `400` response: +* If you try to destroy METADATA group, it will return a `400` response: [source,json] ---- @@ -567,7 +567,7 @@ TIP: For a short tutorial showing how to dynamically add a data structure using The endpoint requires that you send a XML/YAML server configuration file with the required changes. The response will be two lists in JSON format: -- The first `addedConfigs` list includes the newly added configuration among the configurations sent to the server. +- The first `addedConfigs` list includes the newly added configuration among the configurations sent to the server. - The second `ignoredConfigs` list includes ignored configurations which were in the sent configuration list but could not be applied by the server. These could include duplicates, or static configurations (which cannot be applied dynamically). Whether a dynamic configuration can be applied or not depends on the type of request. For some updates, you can change configuration parameters for an existing configuration; for other updates, you cannot change the configuration dynamically. For more detail on which configuration parameters can be changed dynamically and which cannot, see xref:configuration:dynamic-config.adoc[Dynamic Configuration for Members]. diff --git a/docs/modules/maintain-cluster/pages/shutdown.adoc b/docs/modules/maintain-cluster/pages/shutdown.adoc index 216cd168a..25e10b155 100644 --- a/docs/modules/maintain-cluster/pages/shutdown.adoc +++ b/docs/modules/maintain-cluster/pages/shutdown.adoc @@ -7,10 +7,10 @@ To send a command to shut down the cluster, use one of the following options: -[tabs] -==== -CLI:: -+ +[tabs] +==== +CLI:: ++ -- NOTE: To use the CLI to shut down a cluster, you must first xref:clients:rest.adoc[enable the REST API]. @@ -18,6 +18,8 @@ NOTE: To use the CLI to shut down a cluster, you must first xref:clients:rest.ad ---- bin/hz-cluster-admin -a
-c -o shutdown ---- +-- + REST API:: + -- @@ -147,4 +149,4 @@ Similarly, the `isLocalMemberSafe()` method does the same check for the local me The `forceLocalMemberToBeSafe()` method forces the owned and backup partitions to be synchronized, making the local member safe. -For code samples, see https://github.com/hazelcast/hazelcast-code-samples/tree/master/monitoring/cluster-safety[GitHub^]. \ No newline at end of file +For code samples, see https://github.com/hazelcast/hazelcast-code-samples/tree/master/monitoring/cluster-safety[GitHub^]. diff --git a/docs/modules/migrate/pages/upgrading-from-imdg-3.adoc b/docs/modules/migrate/pages/upgrading-from-imdg-3.adoc index 7325009a3..f383435ec 100644 --- a/docs/modules/migrate/pages/upgrading-from-imdg-3.adoc +++ b/docs/modules/migrate/pages/upgrading-from-imdg-3.adoc @@ -307,6 +307,7 @@ mapConfig.addIndexConfig(indexConfig); ... +---- 2+|Dynamic Index Create @@ -2248,7 +2249,7 @@ See the following table for the before/after snippets. == Deprecation of User Code Deployment -The adding of Java classes to members using {ucd} was deprecated in Platform 5.4. +The adding of Java classes to members using {ucd} was deprecated in Platform 5.4. The {ucn} feature, which extends {ucd} to allow you to redeploy your classes, is available for Enterprise users. diff --git a/docs/modules/release-notes/pages/5-4-0.adoc b/docs/modules/release-notes/pages/5-4-0.adoc index 357819fe0..74e209e60 100644 --- a/docs/modules/release-notes/pages/5-4-0.adoc +++ b/docs/modules/release-notes/pages/5-4-0.adoc @@ -227,7 +227,7 @@ https://github.com/hazelcast/hazelcast/pull/24800[#24800] === API Documentation -* Detailed the existing partition aware interface description to explain the requirements when calculating the partition ID in case partition aware is implemented. See {platform-javadocs}/{full-version}/com/hazelcast/partition/PartitionAware.html. #875 +* Detailed the existing partition aware interface description to explain the requirements when calculating the partition ID in case partition aware is implemented. See link:https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/partition/PartitionAware.html[`Interface PartitionAware`]. == Fixes @@ -312,7 +312,7 @@ With this fix, only the members on which the jobs have not been completed are qu https://github.com/hazelcast/hazelcast/pull/24734[#24734] * The evaluation tool for IMDG 3.x users (Hazelcast 3 Connector) is removed. In the upcoming releases, a new tool for migrating data from 3.x versions will be introduced. https://github.com/hazelcast/hazelcast/pull/25051[#25051] -* Transactions have been deprecated, and will be removed as of Hazelcast version 7.0. +* Transactions have been deprecated, and will be removed as of Hazelcast version 7.0. An improved version of this feature is under consideration. If you are already using transactions, get in touch and share your use case. Your feedback will help us to develop a solution that meets your needs. * Portable Serialization has been deprecated. We recommend you use Compact Serialization as Portable Serialization will be removed as of version 7.0. * The user code deployment API is deprecated, and will be removed in Hazelcast Platform version 6.0. #223 From cfbe1140a229aab9295fcc49589eaafea5e5a801 Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Wed, 4 Sep 2024 15:06:52 +0300 Subject: [PATCH 2/3] fix errors --- check-links-playbook.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/check-links-playbook.yml b/check-links-playbook.yml index 424a941b5..ce401647a 100644 --- a/check-links-playbook.yml +++ b/check-links-playbook.yml @@ -2,10 +2,13 @@ site: title: Documentation url: http:localhost:5000 content: - sources: + sources: - url: . branches: HEAD start_path: docs + - url: https://github.com/hazelcast/hz-docs + branches: [v/5.5] + start_path: docs - url: https://github.com/hazelcast/hazelcast-docs branches: [main] start_paths: [home,tutorials] @@ -13,7 +16,7 @@ content: branches: [main] start_path: docs - url: https://github.com/hazelcast/management-center-docs - branches: [main] + branches: [main, v/5.5] start_path: docs - url: https://github.com/hazelcast/cloud-docs branches: [main] @@ -140,7 +143,7 @@ content: - url: https://github.com/hazelcast/clc-docs branches: main start_path: docs -ui: +ui: bundle: url: https://github.com/hazelcast/hazelcast-docs-ui/releases/latest/download/ui-bundle.zip #../hazelcast-docs-ui/build/ui-bundle.zip snapshot: true From fe2e49fcc75f2f5f01d163b09729a4b475d71589 Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Tue, 8 Apr 2025 12:29:41 +0300 Subject: [PATCH 3/3] fix docs-tools versioning --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9210c1f67..2c077f226 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "@antora/site-generator": "^3.1.1", "@asciidoctor/core": "^2.0.0", "asciidoctor-kroki": "^0.10.0", - "hazelcast-docs-tools": "github:hazelcast/hazelcast-docs-tools#v2.1.0", + "hazelcast-docs-tools": "github:hazelcast/hazelcast-docs-tools#semver:2.1.0", "ngrok": "^5.0.0-beta.2", "serve": "^14.2.4" },