Skip to content

Commit c4f9842

Browse files
docs: Fix broken xrefs in single-sourced content (#1645)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent db9ff19 commit c4f9842

File tree

4 files changed

+29
-14
lines changed

4 files changed

+29
-14
lines changed

docs-data/property-overrides.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@
499499
"cloud_topics_enabled": {
500500
"description": "Enable Cloud Topics for the cluster. Cloud Topics are optimized for high-throughput, cost-sensitive workloads that can tolerate higher latencies compared to standard Kafka topics.",
501501
"related_topics": [
502-
"xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics]"
502+
"self-managed-only: xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics]"
503503
],
504504
"config_scope": "cluster"
505505
},
@@ -1092,16 +1092,16 @@
10921092
"config_scope": "topic"
10931093
},
10941094
"initial_retention_local_target_bytes_default": {
1095-
"description": "Initial local retention size target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica set.",
1095+
"description": "Initial local retention size target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica set.",
10961096
"related_topics": [
1097-
"xref:manage:tiered-storage.adoc[Tiered Storage]"
1097+
"self-managed-only: xref:manage:tiered-storage.adoc[Tiered Storage]"
10981098
],
10991099
"config_scope": "cluster"
11001100
},
11011101
"initial_retention_local_target_ms_default": {
1102-
"description": "Initial local retention time target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica is set.",
1102+
"description": "Initial local retention time target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.",
11031103
"related_topics": [
1104-
"xref:manage:tiered-storage.adoc[Tiered Storage]"
1104+
"self-managed-only: xref:manage:tiered-storage.adoc[Tiered Storage]"
11051105
],
11061106
"config_scope": "cluster"
11071107
},

modules/manage/pages/kubernetes/security/authorization/k-group-controller.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ This is useful when:
4040
You must have the following:
4141

4242
* *Kubectl*: Ensure you have the https://kubernetes.io/docs/tasks/tools/#kubectl[kubectl^] command-line tool installed and configured to communicate with your cluster.
43-
* *Redpanda Operator*: Ensure you have at least version 25.3 of the xref:deploy:kubernetes/k-production-deployment.adoc[Redpanda Operator].
44-
* *Redpanda cluster with OIDC enabled*: Ensure you have a Redpanda cluster deployed with xref:manage:security/authentication/oidc/index.adoc[OIDC authentication] configured. Group-based access control (GBAC) is an enterprise feature that requires OIDC.
43+
* *Redpanda Operator*: Ensure you have at least version 25.3 of the xref:deploy:redpanda/kubernetes/k-production-deployment.adoc[Redpanda Operator].
44+
* *Redpanda cluster with OIDC enabled*: Ensure you have a Redpanda cluster deployed with xref:manage:security/authorization/gbac.adoc[OIDC authentication] configured. Group-based access control (GBAC) is an enterprise feature that requires OIDC.
4545
* *Redpanda v26.1+*: The cluster must be running Redpanda v26.1 or later, which supports the v2 Security API required for group principals.
4646

4747
== Create a Group resource

modules/manage/pages/security/authorization/acl.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
// tag::single-source[]
55
:description: Learn how to use ACLs to configure fine-grained access to Redpanda resources.
66

7+
ifdef::env-cloud[:gbac-doc: security:authorization/gbac.adoc]
8+
ifndef::env-cloud[:gbac-doc: manage:security/authorization/gbac.adoc]
9+
710
Access control lists (ACLs) provide a way to configure fine-grained access to Redpanda resources. ACLs are permission rules that determine which actions users or roles can perform on Redpanda resources. Redpanda stores ACLs internally, replicated with glossterm:Raft[] to provide the same consensus guarantees as your data.
811

912
ifndef::env-cloud[]
@@ -91,13 +94,7 @@ ACL commands work on a multiplicative basis. If you specify two principals and t
9194
[[principals]]
9295
=== Principals
9396

94-
All ACLs require a principal. A principal is composed of two parts: the type, and the name. Redpanda supports the types "User", "RedpandaRole", and "Group". When you create user "bar", Redpanda expects you to add ACLs for "User:bar". To grant permissions to an OIDC group, use the `Group:` prefix (for example, `Group:engineering`).
95-
ifndef::env-cloud[]
96-
See xref:manage:security/authorization/gbac.adoc[].
97-
endif::[]
98-
ifdef::env-cloud[]
99-
See xref:security:authorization/gbac.adoc[].
100-
endif::[]
97+
All ACLs require a principal. A principal is composed of two parts: the type, and the name. Redpanda supports the types "User", "RedpandaRole", and "Group". When you create user "bar", Redpanda expects you to add ACLs for "User:bar". To grant permissions to an OIDC group, use the `Group:` prefix (for example, `Group:engineering`). See xref:{gbac-doc}[].
10198

10299
The `--allow-principal` and `--deny-principal` flags add this prefix for you, if necessary.
103100

modules/reference/partials/properties/cluster-properties.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1185,8 +1185,10 @@ ifndef::env-cloud[]
11851185
| User
11861186
endif::[]
11871187

1188+
ifndef::env-cloud[]
11881189
| Related topics
11891190
|xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics]
1191+
endif::[]
11901192

11911193
|===
11921194

@@ -4990,9 +4992,11 @@ endif::[]
49904992

49914993
| Related topics
49924994
|
4995+
ifndef::env-cloud[]
49934996
* xref:manage:tiered-storage.adoc[Tiered Storage]
49944997

49954998
* xref:develop:manage-topics/cloud-topics.adoc[Manage Cloud Topics]
4999+
endif::[]
49965000

49975001
|===
49985002

@@ -9166,7 +9170,12 @@ endif::[]
91669170

91679171
=== initial_retention_local_target_bytes_default
91689172

9173+
ifndef::env-cloud[]
91699174
Initial local retention size target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica set.
9175+
endif::[]
9176+
ifdef::env-cloud[]
9177+
Initial local retention size target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica set.
9178+
endif::[]
91709179

91719180
[cols="1s,2a"]
91729181
|===
@@ -9202,15 +9211,22 @@ ifndef::env-cloud[]
92029211
| User
92039212
endif::[]
92049213

9214+
ifndef::env-cloud[]
92059215
| Related topics
92069216
|xref:manage:tiered-storage.adoc[Tiered Storage]
9217+
endif::[]
92079218

92089219
|===
92099220

92109221

92119222
=== initial_retention_local_target_ms_default
92129223

9224+
ifndef::env-cloud[]
92139225
Initial local retention time target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica is set.
9226+
endif::[]
9227+
ifdef::env-cloud[]
9228+
Initial local retention time target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica is set.
9229+
endif::[]
92149230

92159231
[cols="1s,2a"]
92169232
|===
@@ -9249,8 +9265,10 @@ ifndef::env-cloud[]
92499265
| User
92509266
endif::[]
92519267

9268+
ifndef::env-cloud[]
92529269
| Related topics
92539270
|xref:manage:tiered-storage.adoc[Tiered Storage]
9271+
endif::[]
92549272

92559273
|===
92569274

0 commit comments

Comments
 (0)