Skip to content

docs: Fix broken xrefs in single-sourced content #1645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JakeSCahill merged 5 commits into from
Mar 31, 2026
+29 −14
Merged

docs: Fix broken xrefs in single-sourced content #1645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ad672e2
docs: Fix broken xrefs in single-sourced content
JakeSCahill Mar 31, 2026
ee7121d
Update docs-data/property-overrides.json
JakeSCahill Mar 31, 2026
c0e5805
docs: Fix cloud-topics.adoc xrefs in property docs
JakeSCahill Mar 31, 2026
fc24c96
docs: Add cloud xrefs for gbac.adoc
JakeSCahill Mar 31, 2026
7e471a8
Update k-group-controller.adoc
JakeSCahill Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs-data/property-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@
"cloud_topics_enabled": {
"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.",
"related_topics": [
"xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics]"
"self-managed-only: xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics]"
],
"config_scope": "cluster"
},
Expand Down Expand Up @@ -1092,16 +1092,16 @@
"config_scope": "topic"
},
"initial_retention_local_target_bytes_default": {
"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.",
"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.",
"related_topics": [
"xref:manage:tiered-storage.adoc[Tiered Storage]"
"self-managed-only: xref:manage:tiered-storage.adoc[Tiered Storage]"
],
"config_scope": "cluster"
},
"initial_retention_local_target_ms_default": {
"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.",
"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.",
"related_topics": [
"xref:manage:tiered-storage.adoc[Tiered Storage]"
"self-managed-only: xref:manage:tiered-storage.adoc[Tiered Storage]"
],
"config_scope": "cluster"
},
Expand Down
4 changes: 2 additions & 2 deletions modules/manage/pages/kubernetes/security/authorization/k-group-controller.adoc
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we single source this page for Cloud too? Curious about needing the conditionals here

Copy link
Copy Markdown
Contributor Author

@JakeSCahill JakeSCahill Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha, good catch! Thanks.

Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ This is useful when:
You must have the following:

* *Kubectl*: Ensure you have the https://kubernetes.io/docs/tasks/tools/#kubectl[kubectl^] command-line tool installed and configured to communicate with your cluster.
* *Redpanda Operator*: Ensure you have at least version 25.3 of the xref:deploy:kubernetes/k-production-deployment.adoc[Redpanda Operator].
* *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.
* *Redpanda Operator*: Ensure you have at least version 25.3 of the xref:deploy:redpanda/kubernetes/k-production-deployment.adoc[Redpanda Operator].
* *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.
* *Redpanda v26.1+*: The cluster must be running Redpanda v26.1 or later, which supports the v2 Security API required for group principals.

== Create a Group resource
Expand Down
11 changes: 4 additions & 7 deletions modules/manage/pages/security/authorization/acl.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
// tag::single-source[]
:description: Learn how to use ACLs to configure fine-grained access to Redpanda resources.

ifdef::env-cloud[:gbac-doc: security:authorization/gbac.adoc]
ifndef::env-cloud[:gbac-doc: manage:security/authorization/gbac.adoc]

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.

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

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`).
ifndef::env-cloud[]
See xref:manage:security/authorization/gbac.adoc[].
endif::[]
ifdef::env-cloud[]
See xref:security:authorization/gbac.adoc[].
endif::[]
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}[].

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

Expand Down
18 changes: 18 additions & 0 deletions modules/reference/partials/properties/cluster-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1185,8 +1185,10 @@ ifndef::env-cloud[]
| User
endif::[]

ifndef::env-cloud[]
| Related topics
|xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics]
endif::[]

|===

Expand Down Expand Up @@ -4990,9 +4992,11 @@ endif::[]

| Related topics
|
ifndef::env-cloud[]
* xref:manage:tiered-storage.adoc[Tiered Storage]

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

|===

Expand Down Expand Up @@ -9166,7 +9170,12 @@ endif::[]

=== initial_retention_local_target_bytes_default

ifndef::env-cloud[]
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.
endif::[]
ifdef::env-cloud[]
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.
endif::[]

[cols="1s,2a"]
|===
Expand Down Expand Up @@ -9202,15 +9211,22 @@ ifndef::env-cloud[]
| User
endif::[]

ifndef::env-cloud[]
| Related topics
|xref:manage:tiered-storage.adoc[Tiered Storage]
endif::[]

|===


=== initial_retention_local_target_ms_default

ifndef::env-cloud[]
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.
endif::[]
ifdef::env-cloud[]
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.
endif::[]

[cols="1s,2a"]
|===
Expand Down Expand Up @@ -9249,8 +9265,10 @@ ifndef::env-cloud[]
| User
endif::[]

ifndef::env-cloud[]
| Related topics
|xref:manage:tiered-storage.adoc[Tiered Storage]
endif::[]

|===

Expand Down
Loading