Skip to content

Commit

Permalink
Update Javadoc links to use OS version [DI-425] (#1538)
Browse files Browse the repository at this point in the history
The OS & EE Javadocs are versioned separately - reflecting the latest
version of each product.
However in the documentation, we use the (problematic) `full-version`
property when linking to the _OS_ Javadoc which is the latest _EE_
version.
[We no longer publish (incorrectly versioned) OS Javadoc as part of an
EE release](https://hazelcast.atlassian.net/browse/DI-328) which is why
this problem is only now visible.

Replaced:
- https://docs.hazelcast.org/docs/{full-version}/javadoc
-
https://docs.hazelcast.org/docs/{page-latest-supported-java-client}/javadoc
- https://javadoc.io/doc/com.hazelcast/hazelcast/{full-version}

With `https://docs.hazelcast.org/docs/{os-version}/javadoc` as are all
OS content.

Tested [by running external link check on
branch](https://github.com/hazelcast/hz-docs/actions/runs/13295463298/job/37126237227).

Ideally this _should_ be backported to all maintenance branches, but the
PR is unlikely to merge without conflicts. If required, re-applying the
change (now it's scoped) is trivial.

Fixes: [DI-425](https://hazelcast.atlassian.net/browse/DI-425)

[DI-425]:
https://hazelcast.atlassian.net/browse/DI-425?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
JackPGreen authored Feb 13, 2025
1 parent 685ef3f commit ba2bb1c
Show file tree
Hide file tree
Showing 56 changed files with 150 additions and 150 deletions.
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/list-of-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ be 1 under low load.

|numInFlightOps
|The number of pending (in flight) operations when using
asynchronous mapping processors. See https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/jet/core/processor/Processors.html#mapUsingServiceAsyncP-com.hazelcast.jet.pipeline.ServiceFactory-int-boolean-com.hazelcast.function.FunctionEx-com.hazelcast.function.BiFunctionEx-[Processors.mapUsingServiceAsyncP].
asynchronous mapping processors. See https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/jet/core/processor/Processors.html#mapUsingServiceAsyncP-com.hazelcast.jet.pipeline.ServiceFactory-int-boolean-com.hazelcast.function.FunctionEx-com.hazelcast.function.BiFunctionEx-[Processors.mapUsingServiceAsyncP].
.6+|_job, exec, vertex, proc, procType_

Processor specific metrics, only certain types of processors
Expand All @@ -220,7 +220,7 @@ processor.
|totalWindows
|The number of active windows being tracked by a session window
processor. See
https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/jet/core/processor/Processors.html#aggregateToSessionWindowP-long-long-java.util.List-java.util.List-com.hazelcast.jet.aggregate.AggregateOperation-com.hazelcast.jet.core.function.KeyedWindowResultFunction-[Processors.aggregateToSessionWindowP].
https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/jet/core/processor/Processors.html#aggregateToSessionWindowP-long-long-java.util.List-java.util.List-com.hazelcast.jet.aggregate.AggregateOperation-com.hazelcast.jet.core.function.KeyedWindowResultFunction-[Processors.aggregateToSessionWindowP].


|totalFrames
Expand All @@ -230,7 +230,7 @@ https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/jet/core/pr
|totalKeysInFrames
|The number of grouping keys associated with the current active
frames of a sliding window processor. See
https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/jet/core/processor/Processors.html#aggregateToSlidingWindowP-java.util.List-java.util.List-com.hazelcast.jet.core.TimestampKind-com.hazelcast.jet.core.SlidingWindowPolicy-long-com.hazelcast.jet.aggregate.AggregateOperation-com.hazelcast.jet.core.function.KeyedWindowResultFunction-[Processors.aggregateToSlidingWindowP].
https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/jet/core/processor/Processors.html#aggregateToSlidingWindowP-java.util.List-java.util.List-com.hazelcast.jet.core.TimestampKind-com.hazelcast.jet.core.SlidingWindowPolicy-long-com.hazelcast.jet.aggregate.AggregateOperation-com.hazelcast.jet.core.function.KeyedWindowResultFunction-[Processors.aggregateToSlidingWindowP].


|lateEventsDropped
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/clients/pages/java.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Java Client
:page-api-reference: https://docs.hazelcast.org/docs/{page-latest-supported-java-client}/javadoc
:page-api-reference: https://docs.hazelcast.org/docs/{os-version}/javadoc
:page-toclevels: 1
:page-aliases: security:native-client-security.adoc
:description: Hazelcast provides a {java-client} within the standard distribution you can start using right away, and also a lightweight {java-client-new} that is available in Beta.
Expand All @@ -19,7 +19,7 @@ NOTE: Where there are differences between {java-client} and {java-client-new}, t

Both clients enable you to use the Hazelcast API — this topic explains any differences or technical details that affect usage. Read this alongside the respective Javadoc-generated API documentation available from within your IDE together with the following:

* https://docs.hazelcast.org/docs/{page-latest-supported-java-client}/javadoc[Hazelcast {java-client} API documentation]
* https://docs.hazelcast.org/docs/{os-version}/javadoc[Hazelcast {java-client} API documentation]
* https://docs.hazelcast.org/hazelcast-java-client/{page-latest-supported-java-client-new}/javadoc[Hazelcast {java-client-new} API documentation]

== Get started
Expand Down Expand Up @@ -508,7 +508,7 @@ security:

For more information, see the appropriate API documentation for your client:

* https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/client/config/ClientSecurityConfig.html[{java-client-new} ClientSecurityConfig API documentation]
* https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/client/config/ClientSecurityConfig.html[{java-client-new} ClientSecurityConfig API documentation]
* https://docs.hazelcast.org/hazelcast-java-client/{page-latest-supported-java-client-new}/javadoc/com/hazelcast/client/config/ClientSecurityConfig.html[{java-client} ClientSecurityConfig API documentation]

[[classloader]]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/cluster-performance/pages/data-affinity.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ psConfig.setPartitioningStrategy(YourCustomPartitioningStrategy); <1>
...
----
====
<1> You can define your own partition strategy by implementing the class https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/partition/PartitioningStrategy.html[`PartitioningStrategy`]. To enable your implementation, add the full class name to your Hazelcast configuration using either
<1> You can define your own partition strategy by implementing the class https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/partition/PartitioningStrategy.html[`PartitioningStrategy`]. To enable your implementation, add the full class name to your Hazelcast configuration using either
the declarative or programmatic approach, as shown above.

NOTE: All the cluster members must have the same partitioning strategy configurations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ NOTE: To help you to monitor this potential problem, client invocations of certa
The threshold for logging large results is defined
by the Hazelcast property `hazelcast.expensive.imap.invocation.reporting.threshold`,
which has a default value of `100` results.
The relevant methods are listed in the https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/spi/properties/ClusterProperty.html#EXPENSIVE_IMAP_INVOCATION_REPORTING_THRESHOLD[Javadocs^].
The relevant methods are listed in the https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/spi/properties/ClusterProperty.html#EXPENSIVE_IMAP_INVOCATION_REPORTING_THRESHOLD[Javadocs^].

== Plan capacity
Proper capacity planning is crucial for providing
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/cluster-performance/pages/near-cache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ include::ROOT:example$/performance/ExampleNearCacheConfiguration.java[tag=nearca
The element `<near-cache>` has an optional attribute `name` with a default value of `default`.


The class https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/NearCacheConfig.html[NearCacheConfig^]
The class https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/config/NearCacheConfig.html[NearCacheConfig^]
is used for all supported Hazelcast data structures on members and clients.

The following are the descriptions of all configuration elements and attributes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A Thread-Per-Core (TPC) design uses one thread for every CPU core and every thre

When TPC is enabled, clients using the `ALL_MEMBERS` cluster routing mode connect to the number of cores specified in the client config. If TPC is enabled on both client and server, clients connect directly to one of the TPC threads instead of using the legacy network threads. TPC-enabled servers continue to use the same ports for discovery, which means there's no difference in how the cluster member list is created and TPC-aware servers are backward compatible with clients that don't use TPC.

NOTE: Clients using the `SINGLE_MEMBER` or `MULTI_MEMBER` cluster routing modes cannot use TPC. Your clients must use the `ALL_MEMBERS` cluster routing mode with TPC. For further information on the `ClientTpcConfig` class used to specify the number of cores to use for connections, refer to https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/client/config/ClientTpcConfig.html[Class ClientTpcConfig] in the Java API documentation.
NOTE: Clients using the `SINGLE_MEMBER` or `MULTI_MEMBER` cluster routing modes cannot use TPC. Your clients must use the `ALL_MEMBERS` cluster routing mode with TPC. For further information on the `ClientTpcConfig` class used to specify the number of cores to use for connections, refer to https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/client/config/ClientTpcConfig.html[Class ClientTpcConfig] in the Java API documentation.

[[tpc-config]]
== Configuration Options
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/clusters/pages/ucn-security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@

Permissions are set using the `UserCodeNamespacePermission` class, which extends the `InstancePermission` class.

For further information on the `UserCodeNamespacePermission` class, refer to https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/security/permission/UserCodeNamespacePermission.html[Class UserCodeNamespacePermission^] in the Java API documentation.
For further information on the `UserCodeNamespacePermission` class, refer to https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/security/permission/UserCodeNamespacePermission.html[Class UserCodeNamespacePermission^] in the Java API documentation.

For further information on client permissions with {ucn}, see the xref:security:client-authorization.adoc[] topic.
2 changes: 1 addition & 1 deletion docs/modules/computing/pages/durable-executor-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The following is a list of methods, grouped by the operations, that support spli

**Configuring Split-Brain Protection**

Split-brain protection for Durable Executor Service can be configured programmatically using the method https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/DurableExecutorConfig.html[setSplitBrainProtectionName()^], or declaratively using the element `split-brain-protection-ref`. Following is an example declarative configuration:
Split-brain protection for Durable Executor Service can be configured programmatically using the method https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/config/DurableExecutorConfig.html[setSplitBrainProtectionName()^], or declaratively using the element `split-brain-protection-ref`. Following is an example declarative configuration:

[tabs]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/computing/pages/executor-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ The following is a list of methods, grouped by the operations, that support spli

**Configuring Split-Brain Protection**

Split-brain protection for Executor Service can be configured programmatically using the method https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/ExecutorConfig.html[setSplitBrainProtectionName()^], or declaratively using the element `split-brain-protection-ref`. Following is an example declarative configuration:
Split-brain protection for Executor Service can be configured programmatically using the method https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/config/ExecutorConfig.html[setSplitBrainProtectionName()^], or declaratively using the element `split-brain-protection-ref`. Following is an example declarative configuration:

[tabs]
====
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/computing/pages/scheduled-executor-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ On top of the Vanilla Scheduling API, IScheduledExecutorService allows additiona
* `scheduleOnAllMembers`: On all cluster members.
* `scheduleOnMembers`: On all given members.
See the https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/scheduledexecutor/IScheduledExecutorService.html[IScheduledExecutorService Javadoc^] for its API details.
See the https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/scheduledexecutor/IScheduledExecutorService.html[IScheduledExecutorService Javadoc^] for its API details.

There are two different modes of durability for the service:

Expand All @@ -27,7 +27,7 @@ The name of the task can be user-defined if it needs to be, by implementing the

Upon scheduling, the service returns an `IScheduledFuture`, which on top of the `java.util.concurrent.ScheduledFuture` functionality, provides an API to get the resource handler of the task `ScheduledTaskHandler` and also the runtime statistics of the task.

Futures associated with a scheduled task, in order to be aware of lost partitions and/or members, act as listeners on the local member/client. Therefore, they are always strongly referenced, on the member/client side. In order to clean up their resources, once completed, you can use the method `dispose()`. This method also cancels further executions of the task if scheduled at a fixed rate. See the https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/scheduledexecutor/IScheduledFuture.html[IScheduledFuture Javadoc^] for its API details.
Futures associated with a scheduled task, in order to be aware of lost partitions and/or members, act as listeners on the local member/client. Therefore, they are always strongly referenced, on the member/client side. In order to clean up their resources, once completed, you can use the method `dispose()`. This method also cancels further executions of the task if scheduled at a fixed rate. See the https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/scheduledexecutor/IScheduledFuture.html[IScheduledFuture Javadoc^] for its API details.

The task handler is a descriptor class holding information for the scheduled future, which is used to pinpoint the actual task in the cluster. It contains the name of the task, the owner (member or partition) and the scheduler name.

Expand Down Expand Up @@ -168,7 +168,7 @@ The following is a list of methods, grouped by the operations, that support spli

**Configuring Split-Brain Protection**

Split-brain protection for Scheduled Executor Service can be configured programmatically using the method https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/ScheduledExecutorConfig.html[setSplitBrainProtectionName()^], or declaratively using the element `split-brain-protection-ref`. Following is an example declarative configuration:
Split-brain protection for Scheduled Executor Service can be configured programmatically using the method https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/config/ScheduledExecutorConfig.html[setSplitBrainProtectionName()^], or declaratively using the element `split-brain-protection-ref`. Following is an example declarative configuration:

[tabs]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ HazelcastInstance hz = Hazelcast.newHazelcastInstance(config);
Variable replacers are used to replace custom strings during startup when a cluster first loads a configuration file. For example, you can use a variable replacer to mask sensitive information such as usernames and passwords.

Variable replacers implement the interface `com.hazelcast.config.replacer.spi.ConfigReplacer`. For basic information about how a replacer works, see the
https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/replacer/spi/ConfigReplacer.html[Javadoc^].
https://docs.hazelcast.org/docs/{os-version}/javadoc/com/hazelcast/config/replacer/spi/ConfigReplacer.html[Javadoc^].

[tabs]
====
Expand Down
Loading

0 comments on commit ba2bb1c

Please sign in to comment.