More doc link fixes

thegridman · thegridman · commit d7fe423acdce · 2025-05-20T14:00:04.000+03:00
diff --git a/api/v1/coherence_types.go b/api/v1/coherence_types.go
@@ -386,16 +386,16 @@ type CloudNativeBuildPackSpec struct {
 // ----- CoherenceSpec struct -----------------------------------------------
 
 // CoherenceSpec is the section of the CRD configures settings specific to Coherence.
-// +coh:doc=coherence_settings/010_overview.adoc,Coherence Configuration
+// +coh:doc=docs/coherence_settings/010_overview.adoc,Coherence Configuration
 // +k8s:openapi-gen=true
 type CoherenceSpec struct {
 	// CacheConfig is the name of the cache configuration file to use
-	// +coh:doc=coherence_settings/030_cache_config.adoc,Configure Cache Config File
+	// +coh:doc=docs/coherence_settings/030_cache_config.adoc,Configure Cache Config File
 	// +optional
 	CacheConfig *string `json:"cacheConfig,omitempty"`
 	// OverrideConfig is name of the Coherence operational configuration override file,
 	// the default is tangosol-coherence-override.xml
-	// +coh:doc=coherence_settings/040_override_file.adoc,Configure Operational Config File
+	// +coh:doc=docs/coherence_settings/040_override_file.adoc,Configure Operational Config File
 	// +optional
 	OverrideConfig *string `json:"overrideConfig,omitempty"`
 	// A boolean flag indicating whether members of this deployment are storage enabled.
@@ -404,26 +404,26 @@ type CoherenceSpec struct {
 	// This flag is also used to configure the ScalingPolicy value if a value is not specified. If the
 	// StorageEnabled field is not specified or is true the scaling will be safe, if StorageEnabled is
 	// set to false scaling will be parallel.
-	// +coh:doc=coherence_settings/050_storage_enabled.adoc,Configure Storage Enabled
+	// +coh:doc=docs/coherence_settings/050_storage_enabled.adoc,Configure Storage Enabled
 	// +optional
 	StorageEnabled *bool `json:"storageEnabled,omitempty"`
 	// Persistence values configure the on-disc data persistence settings.
 	// The bool Enabled enables or disabled on disc persistence of data.
-	// +coh:doc=coherence_settings/080_persistence.adoc,Configure Persistence
+	// +coh:doc=docs/coherence_settings/080_persistence.adoc,Configure Persistence
 	// +optional
 	Persistence *PersistenceSpec `json:"persistence,omitempty"`
 	// The Coherence log level, default being 5 (info level).
-	// +coh:doc=coherence_settings/060_log_level.adoc,Configure Coherence log level
+	// +coh:doc=docs/coherence_settings/060_log_level.adoc,Configure Coherence log level
 	// +optional
 	LogLevel *int32 `json:"logLevel,omitempty"`
 	// Management configures Coherence management over REST
 	// Note: Coherence management over REST will is available in Coherence version >= 12.2.1.4.
-	// +coh:doc=management_and_diagnostics/010_overview.adoc,Management & Diagnostics
+	// +coh:doc=docs/management_and_diagnostics/010_overview.adoc,Management & Diagnostics
 	// +optional
 	Management *PortSpecWithSSL `json:"management,omitempty"`
 	// Metrics configures Coherence metrics publishing
 	// Note: Coherence metrics publishing will is available in Coherence version >= 12.2.1.4.
-	// +coh:doc=metrics/010_overview.adoc,Metrics
+	// +coh:doc=docs/metrics/010_overview.adoc,Metrics
 	// +optional
 	Metrics *PortSpecWithSSL `json:"metrics,omitempty"`
 	// Tracing is used to configure Coherence distributed tracing functionality.
@@ -442,13 +442,13 @@ type CoherenceSpec struct {
 	// +optional
 	AllowEndangeredForStatusHA []string `json:"allowEndangeredForStatusHA,omitempty"`
 	// Exclude members of this deployment from being part of the cluster's WKA list.
-	// +coh:doc=coherence_settings/070_wka.adoc,Well Known Addressing
+	// +coh:doc=docs/coherence_settings/070_wka.adoc,Well Known Addressing
 	// +optional
 	ExcludeFromWKA *bool `json:"excludeFromWKA,omitempty"`
 	// Specify an existing Coherence deployment to be used for WKA.
 	// If an existing deployment is to be used for WKA the ExcludeFromWKA is
 	// implicitly set to true.
-	// +coh:doc=coherence_settings/070_wka.adoc,Well Known Addressing
+	// +coh:doc=docs/coherence_settings/070_wka.adoc,Well Known Addressing
 	// +optional
 	WKA *CoherenceWKASpec `json:"wka,omitempty"`
 	// Certain features rely on a version check prior to starting the server, e.g. metrics requires >= 12.2.1.4.
@@ -2558,7 +2558,7 @@ type StartQuorumStatus struct {
 
 // ConfigMapVolumeSpec represents a ConfigMap that will be added to the deployment's Pods as an
 // additional Volume and as a VolumeMount in the containers.
-// +coh:doc=misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
+// +coh:doc=docs/misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
 // +k8s:openapi-gen=true
 type ConfigMapVolumeSpec struct {
 	// The name of the ConfigMap to mount.
@@ -2680,7 +2680,7 @@ func (in *ConfigMapVolumeSpec) AddVolumeMounts(c *corev1.Container) {
 
 // SecretVolumeSpec represents a Secret that will be added to the deployment's Pods as an
 // additional Volume and as a VolumeMount in the containers.
-// +coh:doc=misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
+// +coh:doc=docs/misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
 // +k8s:openapi-gen=true
 type SecretVolumeSpec struct {
 	// The name of the Secret to mount.
diff --git a/api/v1/coherenceresourcespec_types.go b/api/v1/coherenceresourcespec_types.go
@@ -122,14 +122,14 @@ type CoherenceResourceSpec struct {
 	// A list of ConfigMaps to add as volumes.
 	// Each entry in the list will be added as a ConfigMap Volume to the deployment's
 	// Pods and as a VolumeMount to all the containers and init-containers in the Pod.
-	// +coh:doc=misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
+	// +coh:doc=docs/misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
 	// +listType=map
 	// +listMapKey=name
 	ConfigMapVolumes []ConfigMapVolumeSpec `json:"configMapVolumes,omitempty"`
 	// A list of Secrets to add as volumes.
 	// Each entry in the list will be added as a Secret Volume to the deployment's
 	// Pods and as a VolumeMount to all the containers and init-containers in the Pod.
-	// +coh:doc=misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
+	// +coh:doc=docs/misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
 	// +listType=map
 	// +listMapKey=name
 	SecretVolumes []SecretVolumeSpec `json:"secretVolumes,omitempty"`
diff --git a/docs/about/04_coherence_spec.adoc b/docs/about/04_coherence_spec.adoc
@@ -302,9 +302,9 @@ see: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotatio
 m| initContainers | List of additional initialization containers to add to the deployment's Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ m| []https://{k8s-doc-link}/#container-v1-core[corev1.Container] | false
 m| sideCars | List of additional side-car containers to add to the deployment's Pod. m| []https://{k8s-doc-link}/#container-v1-core[corev1.Container] | false
 m| configMapVolumes | A list of ConfigMaps to add as volumes. Each entry in the list will be added as a ConfigMap Volume to the deployment's Pods and as a VolumeMount to all the containers and init-containers in the Pod. +
-see: <<misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes>> m| []<<ConfigMapVolumeSpec,ConfigMapVolumeSpec>> | false
+see: <<docs/misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes>> m| []<<ConfigMapVolumeSpec,ConfigMapVolumeSpec>> | false
 m| secretVolumes | A list of Secrets to add as volumes. Each entry in the list will be added as a Secret Volume to the deployment's Pods and as a VolumeMount to all the containers and init-containers in the Pod. +
-see: <<misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes>> m| []<<SecretVolumeSpec,SecretVolumeSpec>> | false
+see: <<docs/misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes>> m| []<<SecretVolumeSpec,SecretVolumeSpec>> | false
 m| volumes | Volumes defines extra volume mappings that will be added to the Coherence Pod. +
   The content of this yaml should match the normal k8s volumes section of a Pod definition + +
   as described in https://kubernetes.io/docs/concepts/storage/volumes/ + m| []https://{k8s-doc-link}/#volume-v1-core[corev1.Volume] | false
@@ -388,31 +388,31 @@ m| jobProbes | &#160; m| []<<CoherenceJobProbeStatus,CoherenceJobProbeStatus>> |
 === CoherenceSpec
 
 CoherenceSpec is the section of the CRD configures settings specific to Coherence. +
-see: <<coherence_settings/010_overview.adoc,Coherence Configuration>>
+see: <<docs/coherence_settings/010_overview.adoc,Coherence Configuration>>
 
 [cols="1,10,1,1"options="header"]
 |===
 | Field | Description | Type | Required
 m| cacheConfig | CacheConfig is the name of the cache configuration file to use +
-see: <<coherence_settings/030_cache_config.adoc,Configure Cache Config File>> m| &#42;string | false
+see: <<docs/coherence_settings/030_cache_config.adoc,Configure Cache Config File>> m| &#42;string | false
 m| overrideConfig | OverrideConfig is name of the Coherence operational configuration override file, the default is tangosol-coherence-override.xml +
-see: <<coherence_settings/040_override_file.adoc,Configure Operational Config File>> m| &#42;string | false
+see: <<docs/coherence_settings/040_override_file.adoc,Configure Operational Config File>> m| &#42;string | false
 m| storageEnabled | A boolean flag indicating whether members of this deployment are storage enabled. This value will set the corresponding coherence.distributed.localstorage System property. If not specified the default value is true. This flag is also used to configure the ScalingPolicy value if a value is not specified. If the StorageEnabled field is not specified or is true the scaling will be safe, if StorageEnabled is set to false scaling will be parallel. +
-see: <<coherence_settings/050_storage_enabled.adoc,Configure Storage Enabled>> m| &#42;bool | false
+see: <<docs/coherence_settings/050_storage_enabled.adoc,Configure Storage Enabled>> m| &#42;bool | false
 m| persistence | Persistence values configure the on-disc data persistence settings. The bool Enabled enables or disabled on disc persistence of data. +
-see: <<coherence_settings/080_persistence.adoc,Configure Persistence>> m| &#42;<<PersistenceSpec,PersistenceSpec>> | false
+see: <<docs/coherence_settings/080_persistence.adoc,Configure Persistence>> m| &#42;<<PersistenceSpec,PersistenceSpec>> | false
 m| logLevel | The Coherence log level, default being 5 (info level). +
-see: <<coherence_settings/060_log_level.adoc,Configure Coherence log level>> m| &#42;int32 | false
+see: <<docs/coherence_settings/060_log_level.adoc,Configure Coherence log level>> m| &#42;int32 | false
 m| management | Management configures Coherence management over REST Note: Coherence management over REST will is available in Coherence version >= 12.2.1.4. +
-see: <<management_and_diagnostics/010_overview.adoc,Management & Diagnostics>> m| &#42;<<PortSpecWithSSL,PortSpecWithSSL>> | false
+see: <<docs/management_and_diagnostics/010_overview.adoc,Management & Diagnostics>> m| &#42;<<PortSpecWithSSL,PortSpecWithSSL>> | false
 m| metrics | Metrics configures Coherence metrics publishing Note: Coherence metrics publishing will is available in Coherence version >= 12.2.1.4. +
-see: <<metrics/010_overview.adoc,Metrics>> m| &#42;<<PortSpecWithSSL,PortSpecWithSSL>> | false
+see: <<docs/metrics/010_overview.adoc,Metrics>> m| &#42;<<PortSpecWithSSL,PortSpecWithSSL>> | false
 m| tracing | Tracing is used to configure Coherence distributed tracing functionality. m| &#42;<<CoherenceTracingSpec,CoherenceTracingSpec>> | false
 m| allowEndangeredForStatusHA | AllowEndangeredForStatusHA is a list of Coherence partitioned cache service names that are allowed to be in an endangered state when testing for StatusHA. Instances where a StatusHA check is performed include the readiness probe and when scaling a deployment. This field would not typically be used except in cases where a cache service is configured with a backup count greater than zero but it does not matter if caches in those services loose data due to member departure. Normally, such cache services would have a backup count of zero, which would automatically excluded them from the StatusHA check. m| []string | false
 m| excludeFromWKA | Exclude members of this deployment from being part of the cluster's WKA list. +
-see: <<coherence_settings/070_wka.adoc,Well Known Addressing>> m| &#42;bool | false
+see: <<docs/coherence_settings/070_wka.adoc,Well Known Addressing>> m| &#42;bool | false
 m| wka | Specify an existing Coherence deployment to be used for WKA. If an existing deployment is to be used for WKA the ExcludeFromWKA is implicitly set to true. +
-see: <<coherence_settings/070_wka.adoc,Well Known Addressing>> m| &#42;<<CoherenceWKASpec,CoherenceWKASpec>> | false
+see: <<docs/coherence_settings/070_wka.adoc,Well Known Addressing>> m| &#42;<<CoherenceWKASpec,CoherenceWKASpec>> | false
 m| skipVersionCheck | Certain features rely on a version check prior to starting the server, e.g. metrics requires >= 12.2.1.4. The version check relies on the ability of the start script to find coherence.jar but if due to how the image has been built this check is failing then setting this flag to true will skip version checking and assume that the latest coherence.jar is being used. m| &#42;bool | false
 m| enableIpMonitor | Enables the Coherence IP Monitor feature. The Operator disables the IP Monitor by default. m| &#42;bool | false
 m| localPort | LocalPort sets the Coherence unicast port. When manually configuring unicast ports, a single port is specified and the second port is automatically selected. If either of the ports are not available, then the default behavior is to select the next available port. For example, if port 9000 is configured for the first port (port1) and it is not available, then the next available port is automatically selected. The second port (port2) is automatically opened and defaults to the next available port after port1 (port1 + 1 if available). m| &#42;int32 | false
@@ -515,7 +515,7 @@ m| ipFamily | IPFamily is the IP family to use for the WKA service (and also the
 === ConfigMapVolumeSpec
 
 ConfigMapVolumeSpec represents a ConfigMap that will be added to the deployment's Pods as an additional Volume and as a VolumeMount in the containers. +
-see: <<misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes>>
+see: <<docs/misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes>>
 
 [cols="1,10,1,1"options="header"]
 |===
@@ -957,7 +957,7 @@ m| probe | The probe to use to determine whether a deployment is Phase HA. If no
 === SecretVolumeSpec
 
 SecretVolumeSpec represents a Secret that will be added to the deployment's Pods as an additional Volume and as a VolumeMount in the containers. +
-see: <<misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes>>
+see: <<docs/misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes>>
 
 [cols="1,10,1,1"options="header"]
 |===
diff --git a/docs/about/05_upgrade.adoc b/docs/about/05_upgrade.adoc
@@ -81,15 +81,15 @@ In Operator v2 there were multiple images defined, one for Coherence and one use
 Because of the application changes described only a single image now needs to be specified in the `image` field
 of the `CRD` spec.
 
-See the <<applications/010_overview.adoc,Applications>> section of the doecumentation for more details.
+See the <<docs/applications/010_overview.adoc,Applications>> section of the doecumentation for more details.
 
 
 == CRD Differences
 
 A lot of the fields in the `Coherence` CRD are the same as when defining a role in version 2.
 Whilst a number of new fields and features have been added in version 3, a handful of fields have moved,
 and a small number, that no longer made sense, have been removed.
-The <<about/04_coherence_spec.adoc,Coherence Spec>> page documents the full `Coherence` CRD, so it is
+The <<docs/about/04_coherence_spec.adoc,Coherence Spec>> page documents the full `Coherence` CRD, so it is
 simple to locate where a field might have moved to.
 
 
@@ -100,7 +100,7 @@ There are a lot of different ways to configure Fluentd and making the Operator a
 too much of a head-ache to do in a backwards compatible way.
 If a Fluentd side-car is required it can just be added to the `Coherence` resource spec as an additional container,
 so there is no limitation on the Fluentd configuration.
-See the <<logging/010_overview.adoc,Logging documentation>> for more examples.
+See the <<docs/logging/010_overview.adoc,Logging documentation>> for more examples.
 
 == Prometheus and Elasticsearch
 
diff --git a/docs/installation/001_installation.adoc b/docs/installation/001_installation.adoc
@@ -44,12 +44,12 @@ See the <<examples/400_Istio/README.adoc,Istio example>> for more details.
 
 There are a number of ways to install the Coherence Operator.
 
-* <<installation/011_install_manifests.adoc,Install using the yaml manifest file>>
-* <<installation/012_install_helm.adoc,Install using Helm>>
-* <<installation/013_install_kustomize.adoc,Install using Kustomize>>
-* <<installation/014_install_openshift.adoc,Install on OpenShift>>
-* <<installation/015_install_olm.adoc,Install using the Operator Lifecycle Manager (OLM)>>
-* <<installation/016_install_tanzu.adoc,Install on VMWare Tanzu>>
+* <<docs/installation/011_install_manifests.adoc,Install using the yaml manifest file>>
+* <<docs/installation/012_install_helm.adoc,Install using Helm>>
+* <<docs/installation/013_install_kustomize.adoc,Install using Kustomize>>
+* <<docs/installation/014_install_openshift.adoc,Install on OpenShift>>
+* <<docs/installation/015_install_olm.adoc,Install using the Operator Lifecycle Manager (OLM)>>
+* <<docs/installation/016_install_tanzu.adoc,Install on VMWare Tanzu>>
 
 
 [#ha]
diff --git a/docs/jvm/040_gc.adoc b/docs/jvm/040_gc.adoc
@@ -105,6 +105,6 @@ spec:
 In the example above the `-XX:MaxGCPauseMillis=200` JVM argument will be added to the command line.
 
 NOTE: The `jvm.gc.args` field will add the provided arguments to the end of the command line exactly as they
-are in the args list. This field provides the same functionality as <<jvm/030_jvm_args.adoc,JVM Args>>
+are in the args list. This field provides the same functionality as <<docs/jvm/030_jvm_args.adoc,JVM Args>>
 but sometimes it might be useful to be able to separate the two gorups of arguments in the CRD spec.
 
diff --git a/docs/metrics/020_metrics.adoc b/docs/metrics/020_metrics.adoc
@@ -81,7 +81,7 @@ spec:
 <2> To expose metrics via a `Service` it is added to the `ports` list.
 The `metrics` port is a special case where the `port` number is optional so in this case metrics
 will bind to the default port `9612`.
-(see <<ports/020_container_ports.adoc,Exposing Ports>> for details)
+(see <<docs/ports/020_container_ports.adoc,Exposing Ports>> for details)
 
 
 ==== Expose Metrics on a Different Port
@@ -172,4 +172,4 @@ spec:
 ----
 <1> The `serviceMonitor.enabled` field is set to `true` for the `metrics` port.
 
-See <<ports/040_servicemonitors.adoc,Exposing ports and Services - Service Monitors>> documentation for more details.
+See <<docs/ports/040_servicemonitors.adoc,Exposing ports and Services - Service Monitors>> documentation for more details.
diff --git a/docs/metrics/030_importing.adoc b/docs/metrics/030_importing.adoc
@@ -14,7 +14,7 @@
 == Importing the Coherence Dashboards
 
 The Coherence Operator provides a set of dashboards for Coherence that may be imported into Grafana.
-The Coherence dashboards are explained in detail on the <<040_dashboards.adoc,Coherence Grafana Dashboards>> page.
+The Coherence dashboards are explained in detail on the <<docs/metrics/040_dashboards.adoc,Coherence Grafana Dashboards>> page.
 
 There are two ways to obtain the dashboards:
 
diff --git a/docs/metrics/050_ssl.adoc b/docs/metrics/050_ssl.adoc
@@ -64,5 +64,5 @@ and password files from.
 The various files and keystores referred to in the configuration above can be any location accessible in the image
 used by the `coherence` container in the deployment's `Pods`. Typically, for things such as SSL keys and certs,
 these would be provided by obtained from `Secrets` loaded as additional `Pod` `Volumes`.
-See <<other/060_secret_volumes.adoc,Add Secrets Volumes>> for the documentation on how to specify
+See <<docs/other/060_secret_volumes.adoc,Add Secrets Volumes>> for the documentation on how to specify
 secrets as additional volumes.
diff --git a/docs/ports/020_container_ports.adoc b/docs/ports/020_container_ports.adoc
@@ -92,8 +92,8 @@ Prometheus `ServiceMonitor` to be created for the port if that port is to expose
 
 See also:
 
-* <<ports/030_services.adoc,Configure Services for Ports>>
-* <<ports/040_servicemonitors.adoc,Prometheus ServiceMonitors>>
+* <<docs/ports/030_services.adoc,Configure Services for Ports>>
+* <<docs/ports/040_servicemonitors.adoc,Prometheus ServiceMonitors>>
 
 
 === Metrics & Management Ports
diff --git a/docs/ports/030_services.adoc b/docs/ports/030_services.adoc
diff --git a/docs/troubleshooting/01_trouble-shooting.adoc b/docs/troubleshooting/01_trouble-shooting.adoc
diff --git a/examples/021_deployment/README.adoc b/examples/021_deployment/README.adoc
diff --git a/examples/100_federation/README.adoc b/examples/100_federation/README.adoc
diff --git a/hack/kind/kind-config.yaml b/hack/kind/kind-config.yaml
