Skip to content

Commit 060277a

Browse files
authored
Remove docs.hazelcast.com links (#1694)
Within our own documentation, links should be relative to follow versions and to improve compile-time checks. Updated links to use relative links _where possible_: - in documentation pages (not code samples) - `hz-docs`, `clc` & MC docs updated, no corresponding properties for operator or tutorials Fixes: #1183
1 parent b41874c commit 060277a

14 files changed

+31
-31
lines changed

docs/modules/ROOT/pages/list-of-metrics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ metric reflects the member's local view of the cluster (consider split-brain sce
1414
metric, and its value in the local member is obtained by communicating
1515
with the master member.
1616

17-
NOTE: If you use Management Center to export cluster-wide metrics to Prometheus, Management Center reformats the metrics to align with Prometheus best practice recommendations. See link:https://docs.hazelcast.com/management-center/latest/integrate/prometheus-monitoring[Prometheus Monitoring].
17+
NOTE: If you use Management Center to export cluster-wide metrics to Prometheus, Management Center reformats the metrics to align with Prometheus best practice recommendations. See xref:{page-latest-supported-mc}@management-center:integrate:prometheus-monitoring.adoc[Prometheus Monitoring].
1818

1919
.Streaming Engine Cluster-Wide Metrics
2020
[%collapsible]

docs/modules/clients/pages/client-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Hazelcast clients must be installed locally to communicate with the server.
2323

2424
* Language flexibility: Hazelcast offers clients in multiple programming languages, allowing you to use Hazelcast in various environments.
2525
Clients are available for xref:java.adoc[Java], xref:dotnet.adoc[.NET], xref:python.adoc[Python], xref:cplusplus.adoc[{cpp}], xref:go.adoc[Go], and xref:nodejs.adoc[Node.js]
26-
* Independent scaling: in client/server mode, you can scale the Hazelcast cluster independently from your application. For details, see: https://docs.hazelcast.com/hazelcast/latest/deploy/choosing-a-deployment-option[Choosing an Application Topology]
26+
* Independent scaling: in client/server mode, you can scale the Hazelcast cluster independently from your application. For details, see: xref:deploy:choosing-a-deployment-option.adoc[Choosing an Application Topology].
2727
* Polyglot applications: client/server mode allows you to write polyglot applications that can all connect to the same cache cluster
2828
* Decoupling application from data: the application and cached data are separated, which can be beneficial for management and security purposes
2929

docs/modules/clients/pages/hazelcast-clients.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ Alternatively, you can use xref:memcache.adoc[Memcache] to communicate directly
3232

3333
Additional tools are available to help operate and manage Hazelcast Platform clusters:
3434

35-
* link:https://docs.hazelcast.com/management-center/latest/getting-started/overview[Management Center]
35+
* xref:{page-latest-supported-mc}@management-center:getting-started:overview.adoc[Management Center]
3636
* link:https://docs.hazelcast.com/operator/latest/[Platform Operator]
37-
* link:https://docs.hazelcast.com/clc/latest/overview[Command Line Client (CLC)]
37+
* xref:{page-latest-supported-clc}@clc::overview.adoc[Command Line Client (CLC)]

docs/modules/clients/pages/java.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2149,7 +2149,7 @@ For <<client-cluster-routing-modes, Client cluster routing modes>>, the behaviou
21492149
* If set to `SINGLE_MEMBER`, `LoadBalancer` is ignored
21502150
* If set to `MULTI_MEMBER`, best effort is made to route operations to the required member. If this can't be done for any reason, operations are routed as defined by the `LoadBalancer`
21512151

2152-
NOTE: If you are using smart or unisocket client operation modes, see https://docs.hazelcast.com/hazelcast/5.4/clients/java#configuring-client-load-balancer[previous documentation on this topic].
2152+
NOTE: If you are using smart or unisocket client operation modes, see xref:clients:java.adoc#configuring-client-load-balancer[previous documentation on this topic].
21532153

21542154
For example configurations, see the following code samples:
21552155

docs/modules/data-structures/pages/map-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For details on in-memory format, refer to xref:setting-data-format.adoc[].
3838
When a map is created, if the map name matches an entry in the `hazelcast.xml`/`hazelcast.yaml` file, the values in the matching entry are used to overwrite the initial values
3939
discussed in the <<map-configuration-defaults,Map Configuration Defaults>> section.
4040

41-
Maps that do not have any configuration defined use the default configuration. If you want to set a configuration that is valid for all maps, you can name your configuration as `default`. A user-defined default configuration applies to every map that does not have a specific custom map configuration defined with the map’s name. You can also use wildcards to associate your configuration with multiple map names. See the [configuration documentation](https://docs.hazelcast.com/hazelcast/5.5/configuration/using-wildcards) for more information about wildcards.
41+
Maps that do not have any configuration defined use the default configuration. If you want to set a configuration that is valid for all maps, you can name your configuration as `default`. A user-defined default configuration applies to every map that does not have a specific custom map configuration defined with the map’s name. You can also use wildcards to associate your configuration with multiple map names. See the xref:configuration:using-wildcards.adoc[configuration documentation] for more information about wildcards.
4242

4343
When a map name does not match any entry in the `hazelcast.xml`/`hazelcast.yaml` file then:
4444

docs/modules/data-structures/pages/reliable-topic.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ data structures, e.g., collection listeners,
1515
1616
Use Reliable Topic when you need a robust, durable messaging system that can handle high throughput without losing messages, especially in scenarios where message delivery guarantees are crucial.
1717

18-
For more information about the metrics provided by Reliable Topic, see https://docs.hazelcast.com/hazelcast/latest/maintain-cluster/monitoring#topic-statistics[Topic Statistics].
18+
For more information about the metrics provided by Reliable Topic, see xref:maintain-cluster:monitoring.adoc#topic-statistics[Topic Statistics].
1919

2020
Here is an example for a publisher using Reliable Topic:
2121

docs/modules/integrate/pages/feature-engineering-with-feast.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ image:ROOT:feast_batch.png[Feast batch wokflow]
1616

1717
You will need the following ready before starting the tutorial:
1818

19-
* Hazelcast CLC (see link:https://docs.hazelcast.com/clc/latest/install-clc[Install CLC])
19+
* Hazelcast CLC (see xref:{page-latest-supported-clc}@clc::install-clc.adoc[Install CLC])
2020
* A recent version of Docker and Docker Compose
2121

2222
To set up your project, complete the following steps:

docs/modules/integrate/pages/streaming-features-with-feast.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ image:ROOT:feast_streaming.png[Feast streaming wokflow]
1515

1616
You will need the following ready before starting the tutorial:
1717

18-
* Hazelcast CLC (see link:https://docs.hazelcast.com/clc/latest/install-clc[Install CLC])
18+
* Hazelcast CLC (see xref:{page-latest-supported-clc}@clc::install-clc.adoc[Install CLC])
1919
* A recent version of Docker and Docker Compose
2020

2121
To set up your project, complete the following steps:

docs/modules/maintain-cluster/pages/dynamic-config-via-rest.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ my-value
149149

150150
This action will create the map named `my-map` which matches the dynamically added config from the previous step.
151151

152-
You can use https://docs.hazelcast.com/management-center/latest/data-structures/map[Management Center] to verify that the map was successfully created with the expected configuration properties.
152+
You can use xref:{page-latest-supported-mc}@management-center:data-structures:map.adoc[Management Center] to verify that the map was successfully created with the expected configuration properties.
153153

154154
== Step 3. Create queue with new configuration
155155

@@ -187,7 +187,7 @@ item-1
187187

188188
This step will create a queue named `my-queue` which matches the dynamically added config from the previous step.
189189

190-
You can use https://docs.hazelcast.com/management-center/latest/data-structures/queue[Management Center] to verify that the queue was successfully created with the expected configuration properties.
190+
You can use xref:{page-latest-supported-mc}@management-center:data-structures:queue.adoc[Management Center] to verify that the queue was successfully created with the expected configuration properties.
191191

192192
== Step 4 (Optional) Dynamically add new map by reloading configuration from disk
193193

docs/modules/maintain-cluster/pages/monitoring.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ hazelcast:
147147
----
148148
====
149149

150-
See the https://docs.hazelcast.com/management-center/latest/tools/console[Management Center documentation]
150+
See the xref:{page-latest-supported-mc}@management-center:tools:console.adoc[Management Center documentation]
151151
for more information.
152152

153153
=== Managing Data Access
@@ -510,7 +510,7 @@ which frees up the heap occupied by the blob once it is consumed.
510510
As mentioned earlier, the client metrics are also stored in these
511511
blobs on the member side with timestamps assigned to them on the client side.
512512

513-
See the https://docs.hazelcast.com/management-center/latest/metric-persistence.html[Management Center documentation]
513+
See the xref:{page-latest-supported-mc}@management-center::metric-persistence.adoc[Management Center documentation]
514514
for more information .
515515

516516
==== Over JMX
@@ -551,7 +551,7 @@ Prometheus enabled on port 8080
551551

552552
The metrics are available on `\http://localhost:8080`.
553553

554-
NOTE: You will need to configure Prometheus to scrape each member individually, manage changes from scaling and restarts, and collate the metrics from all members. If you are an Enterprise customer, you can configure Prometheus to scrape metrics from Management Center to easily collect metrics for the whole cluster. See link:https://docs.hazelcast.com/management-center/latest/integrate/prometheus-monitoring[Prometheus Monitoring].
554+
NOTE: You will need to configure Prometheus to scrape each member individually, manage changes from scaling and restarts, and collate the metrics from all members. If you are an Enterprise customer, you can configure Prometheus to scrape metrics from Management Center to easily collect metrics for the whole cluster. See xref:{page-latest-supported-mc}@management-center:integrate:prometheus-monitoring.adoc[Prometheus Monitoring].
555555

556556
For a guide on how to set up Prometheus server go to the
557557
https://prometheus.io/docs/prometheus/latest/getting_started[Prometheus website].
@@ -2516,22 +2516,22 @@ Management Center monitors your entire Hazelcast cluster, making it much easier
25162516
Hazelcast Management Center can expose the metrics collected from cluster members to https://prometheus.io/[Prometheus]. This
25172517
feature can be turned on by setting the `hazelcast.mc.prometheusExporter.enabled` system property to `true`.
25182518

2519-
This is an {enterprise-product-name} feature. See link:https://docs.hazelcast.com/management-center/latest/integrate/prometheus-monitoring[Prometheus Monitoring] for details.
2519+
This is an {enterprise-product-name} feature. See link:xref:{page-latest-supported-mc}@management-center:integrate:prometheus-monitoring.adoc[Prometheus Monitoring] for details.
25202520

25212521
=== AppDynamics
25222522

25232523
You can use the xref:{page-latest-supported-mc}@management-center:jmx:jmx.adoc[Clustered JMX] interface to integrate the <<management-center, Hazelcast Management Center>>
25242524
with *AppDynamics*. To perform this integration, attach the AppDynamics
25252525
Java agent to the Management Center.
25262526

2527-
This is an {enterprise-product-name} feature. See link:https://docs.hazelcast.com/management-center/latest/integrate/jmx#integrating-jmx-with-appdynamics[Integrating JMX with AppDynamics] for details.
2527+
This is an {enterprise-product-name} feature. See xref:{page-latest-supported-mc}@management-center:integrate:jmx.adoc#integrating-jmx-with-appdynamics[Integrating JMX with AppDynamics] for details.
25282528

25292529
=== New Relic
25302530

25312531
You can use the xref:{page-latest-supported-mc}@management-center:jmx:jmx.adoc[Clustered JMX] interface to integrate the <<management-center, Hazelcast Management Center>>
25322532
with New Relic. To perform this integration, attach the New Relic Java agent
25332533
and provide an extension file that describes which metrics will be sent to New Relic.
25342534

2535-
This is an {enterprise-product-name} feature. See link:https://docs.hazelcast.com/management-center/latest/integrate/jmx#integrating-jmx-with-new-relic[Integrating JMX with New Relic] for details.
2535+
This is an {enterprise-product-name} feature. See xref:{page-latest-supported-mc}@management-center:integrate:jmx.adoc#integrating-jmx-with-new-relic[Integrating JMX with New Relic] for details.
25362536

25372537

docs/modules/maintain-cluster/pages/rolling-upgrades.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Before starting a rolling upgrade, consider the following best practices:
1515
* Ensure that <<hazelcast-members-compatibility,Upgrade Compatibility>> covers your requirements
1616
* If the minimum version of JDK has changed between releases, <<updated-jdk,upgrade the JDK version>> before starting a rolling upgrade
1717
* If you used Hazelcast Operator to deploy your cluster, refer to the link:https://docs.hazelcast.com/operator/latest/scaling-upgrading#upgrading[Operator documentation, window=_blank]
18-
* If using Hazelcast Management Center to trigger your rolling upgrade, upgrade Management Center before upgrading your members. For information on upgrading Management Center, refer to the link:https://docs.hazelcast.com/management-center/latest/getting-started/install[Management Center documentation, window=_blank], or if you deployed Management Center using the Hazelcast Operator, refer to the link:https://docs.hazelcast.com/operator/latest/deploy-management-center[Operator documentation, window=_blank]
18+
* If using Hazelcast Management Center to trigger your rolling upgrade, upgrade Management Center before upgrading your members. For information on upgrading Management Center, refer to the xref:{page-latest-supported-mc}@management-center:getting-started:install.adoc[Management Center documentation, window=_blank], or if you deployed Management Center using the Hazelcast Operator, refer to the link:https://docs.hazelcast.com/operator/latest/deploy-management-center[Operator documentation, window=_blank]
1919
* If using the `hz-cluster-admin` script to update your cluster, enable the `CLUSTER_WRITE` endpoints in the REST API. For further information on the {open-source-product-name} REST API, see xref:maintain-cluster:rest-api.adoc#using-the-rest-endpoint-groups[{open-source-product-name} REST API]. For further information on the {enterprise-product-name} REST API, see xref:maintain-cluster:enterprise-rest-api.adoc#dynamic-configuration-update-rest-endpoint[{enterprise-product-name} REST API]
2020
* Plan sufficient time for the migration and upgrade to complete, and remember that the members cannot change during the upgrade
2121
* Avoid issues where an automatic upgrade is triggered before the last member has been upgraded by setting a <<enabling-auto-upgrading,minimum cluster size>>

docs/modules/mapstore/pages/configuring-a-generic-mapstore.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
NOTE: The objects created in the distributed map are stored as GenericRecord. You can use the `type-name` property to store the data in a POJO (Plain Old Java Object).
88

9-
IMPORTANT: GenericMapStore is designed to handle GenericRecord and does not support automatic transformation between stored data (GenericRecord) and domain objects (POJOs) in embedded mode. While the `type-name` property allows specifying a https://docs.hazelcast.com/hazelcast/latest/serialization/compact-serialization[Compact type name], it does not enable domain object mapping.
9+
IMPORTANT: GenericMapStore is designed to handle GenericRecord and does not support automatic transformation between stored data (GenericRecord) and domain objects (POJOs) in embedded mode. While the `type-name` property allows specifying a xref:serialization:compact-serialization.adoc[Compact type name], it does not enable domain object mapping.
1010

1111
For a list of all supported external systems, including databases, see available xref:data-connections:data-connections-configuration.adoc#connectors[data connection types].
1212

0 commit comments

Comments
 (0)