Skip to content

Commit db93ef9

Browse files
authored
Bump topics patch (#394)
* Remaining xref cleanup for API docs * Remove docs:api as content source * Remove x-topics from nav and index page * Revert "Remove x-topics from nav and index page" This reverts commit 02dd8c2. * Remove .adoc from `link:` URLs
1 parent 9fff985 commit db93ef9

File tree

7 files changed

+19
-32
lines changed

7 files changed

+19
-32
lines changed

local-antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ content:
1515
- url: .
1616
branches: HEAD
1717
- url: https://github.com/redpanda-data/documentation
18-
branches: [main, v/*, api, shared, site-search]
18+
branches: [main, v/*, shared, site-search]
1919
- url: https://github.com/redpanda-data/redpanda-labs
2020
branches: main
2121
start_paths: [docs,'*/docs']

modules/ROOT/nav.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -431,16 +431,16 @@
431431
*** xref:manage:schema-reg/programmable-push-filters.adoc[Programmable Push Filters]
432432
*** xref:manage:schema-reg/edit-topic-configuration.adoc[Edit Topic Configuration]
433433
** xref:manage:api/index.adoc[Cloud API]
434-
*** link:/api/doc/cloud-controlplane/topic/topic-quickstart.adoc[Cloud API Quickstart]
435-
*** link:/api/doc/cloud-controlplane/topic/topic-cloud-api-overview.adoc[Cloud API Overview]
436-
*** link:/api/doc/cloud-controlplane/authentication.adoc[Cloud API Authentication]
434+
*** link:/api/doc/cloud-controlplane/topic/topic-quickstart[Cloud API Quickstart]
435+
*** link:/api/doc/cloud-controlplane/topic/topic-cloud-api-overview[Cloud API Overview]
436+
*** link:/api/doc/cloud-controlplane/authentication[Cloud API Authentication]
437437
*** xref:manage:api/controlplane/index.adoc[Use the Control Plane API]
438438
**** xref:manage:api/cloud-byoc-controlplane-api.adoc[BYOC]
439439
**** xref:manage:api/cloud-dedicated-controlplane-api.adoc[Dedicated]
440440
**** xref:manage:api/cloud-serverless-controlplane-api.adoc[Serverless]
441441
*** xref:manage:api/cloud-dataplane-api.adoc[Use the Data Plane APIs]
442-
*** link:/api/doc/cloud-controlplane/topic/topic-error-and-status-codes.adoc[Cloud API Errors and Status Codes]
443-
*** link:/api/doc/cloud-controlplane/topic/topic-deprecation-policy.adoc[Cloud API Deprecation Policy]
442+
*** link:/api/doc/cloud-controlplane/topic/topic-error-and-status-codes[Cloud API Errors and Status Codes]
443+
*** link:/api/doc/cloud-controlplane/topic/topic-deprecation-policy[Cloud API Deprecation Policy]
444444
** xref:manage:terraform-provider.adoc[]
445445
446446
* xref:billing:index.adoc[Billing]

modules/develop/pages/connect/about.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
= Redpanda Connect in Redpanda Cloud
2-
:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--Redpanda-Connect-Pipeline
32
:description: Learn about Redpanda Connect in Redpanda Cloud and its wide range of connectors.
43

5-
Redpanda Connect in Redpanda Cloud lets you quickly build and deploy streaming data pipelines on your clusters from a fully-integrated UI or using the pass:a,m[xref:{tag-pipeline-service}[Data Plane API\]].
4+
Redpanda Connect in Redpanda Cloud lets you quickly build and deploy streaming data pipelines on your clusters from a fully-integrated UI or using the link:/api/doc/cloud-dataplane/group/endpoint-redpanda-connect-pipeline[Data Plane API].
65

76
Choose from a xref:develop:connect/components/about.adoc[wide range of connectors] to suit your use case, including connectors to:
87

modules/get-started/pages/cloud-overview.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
= Redpanda Cloud Overview
22
:description: Learn about Redpanda Serverless, Bring Your Own Cloud (BYOC), and Dedicated clusters.
3-
:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--Redpanda-Connect-Pipeline
43
:page-aliases: cloud:dedicated-byoc.adoc, deploy:deployment-option/cloud/dedicated-byoc.adoc, deploy:deployment-option/cloud/cloud-overview.adoc
54

65

@@ -216,7 +215,7 @@ Dedicated::
216215

217216
== Redpanda Connect and Kafka Connect
218217

219-
xref:develop:connect/about.adoc[Redpanda Connect] is integrated into Redpanda Cloud and available as a fully-managed service. Choose from a range of connectors, processors, and other components to quickly build and deploy streaming data pipelines or AI applications from the Cloud UI or using the pass:a,m[xref:{tag-pipeline-service}[Data Plane API\]]. Comprehensive metrics, monitoring, and per pipeline scaling are also available. To start using Redpanda Connect, xref:develop:connect/connect-quickstart.adoc[try this quickstart].
218+
xref:develop:connect/about.adoc[Redpanda Connect] is integrated into Redpanda Cloud and available as a fully-managed service. Choose from a range of connectors, processors, and other components to quickly build and deploy streaming data pipelines or AI applications from the Cloud UI or using the link:/api/doc/cloud-dataplane/group/endpoint-redpanda-connect-pipeline[Data Plane API]. Comprehensive metrics, monitoring, and per pipeline scaling are also available. To start using Redpanda Connect, xref:develop:connect/connect-quickstart.adoc[try this quickstart].
220219

221220
xref:develop:managed-connectors/index.adoc[Kafka Connect] is disabled by default on all new clusters. To unlock this feature for your account, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^]. Note that when Kafka Connect is enabled, there is a node running for Kafka Connect, even if connectors are not used.
222221

modules/get-started/pages/whats-new-cloud.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
= What's New in Redpanda Cloud
22
:description: Summary of new features in Redpanda Cloud.
3-
:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--Redpanda-Connect-Pipeline
43
:page-aliases: deploy:deployment-option/cloud/whats-new-cloud.adoc
54
:page-toclevels: 1
65

@@ -290,7 +289,7 @@ Redpanda Cloud now offers greater flexibility to schedule upgrades to your clust
290289

291290
=== Redpanda Connect: LA for BYOC, beta for Serverless
292291

293-
xref:develop:connect/about.adoc[Redpanda Connect] is now integrated into Redpanda Cloud and available as a fully-managed service. This is a limited availability (LA) release for BYOC and a beta release for Serverless. xref:develop:connect/components/about.adoc[Choose from a range of connectors, processors, and other components] to quickly build and deploy streaming data pipelines or AI applications from the xref:develop:connect/connect-quickstart.adoc[Cloud UI] or using the pass:a,m[xref:{tag-pipeline-service}[Data Plane API\]]. Comprehensive metrics, monitoring, and per pipeline scaling are also available. To start using Redpanda Connect, xref:develop:connect/connect-quickstart.adoc[try this quickstart].
292+
xref:develop:connect/about.adoc[Redpanda Connect] is now integrated into Redpanda Cloud and available as a fully-managed service. This is a limited availability (LA) release for BYOC and a beta release for Serverless. xref:develop:connect/components/about.adoc[Choose from a range of connectors, processors, and other components] to quickly build and deploy streaming data pipelines or AI applications from the xref:develop:connect/connect-quickstart.adoc[Cloud UI] or using the link:/api/doc/cloud-dataplane/group/endpoint-redpanda-connect-pipeline[Data Plane API]. Comprehensive metrics, monitoring, and per pipeline scaling are also available. To start using Redpanda Connect, xref:develop:connect/connect-quickstart.adoc[try this quickstart].
294293

295294
For more detailed information about recent component updates, see xref:redpanda-connect:ROOT:whats_new_rpcn.adoc[What's New in Redpanda Connect].
296295

modules/manage/partials/controlplane-api.adoc

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
:tag-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--Clusters
2-
:tag-networks: api:ROOT:cloud-controlplane-api.adoc#tag--Networks
3-
:tag-operations: api:ROOT:cloud-controlplane-api.adoc#tag--Operations
4-
:tag-resource-groups: api:ROOT:cloud-controlplane-api.adoc#tag--Resource-Groups
5-
:tag-serverless-regions: api:ROOT:cloud-controlplane-api.adoc#tag--Serverless-Regions
6-
:tag-serverless-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--Serverless-Clusters
7-
:tag-role-bindings: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Role-Bindings
8-
:tag-users: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Users
9-
:tag-service-accounts: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Service-Accounts
10-
111
The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. The Control Plane API enables you to programmatically manage your organization's Redpanda infrastructure outside of the Cloud UI. You can call the API endpoints directly, or use tools like Terraform or Python scripts to automate cluster management.
122

133
See link:/api/doc/cloud-controlplane/[Control Plane API] for the full API reference documentation.
@@ -19,18 +9,18 @@ The Control Plane API is one central API that allows you to provision clusters,
199
The Control Plane API consists of the following endpoint groups:
2010

2111
ifndef::env-serverless[]
22-
* pass:a,m[xref:{tag-clusters}[Clusters\]]
23-
* pass:a,m[xref:{tag-networks}[Networks\]]
12+
* link:/api/doc/cloud-controlplane/group/endpoint-clusters[Clusters]
13+
* link:/api/doc/cloud-controlplane/group/endpoint-networks[Networks]
2414
endif::[]
25-
* pass:a,m[xref:{tag-operations}[Operations\]]
26-
* pass:a,m[xref:{tag-resource-groups}[Resource Groups\]]
15+
* link:/api/doc/cloud-controlplane/group/endpoint-operations[Operations]
16+
* link:/api/doc/cloud-controlplane/group/endpoint-resource-groups[Resource Groups]
2717
ifdef::env-serverless[]
28-
* pass:a,m[xref:{tag-serverless-clusters}[Serverless Clusters\]]
29-
* pass:a,m[xref:{tag-serverless-regions}[Serverless Regions\]]
18+
* link:/api/doc/cloud-controlplane/group/endpoint-serverless-clusters[Serverless Clusters]
19+
* link:/api/doc/cloud-controlplane/group/endpoint-serverless-regions[Serverless Regions]
3020
endif::[]
31-
* pass:a,m[xref:{tag-role-bindings}[Control Plane Role Bindings\]]
32-
* pass:a,m[xref:{tag-users}[Control Plane Users\]]
33-
* pass:a,m[xref:{tag-service-accounts}[Control Plane Service Accounts\]]
21+
* link:/api/doc/cloud-controlplane/group/endpoint-control-plane-role-bindings[Control Plane Role Bindings]
22+
* link:/api/doc/cloud-controlplane/group/endpoint-control-plane-users[Control Plane Users]
23+
* link:/api/doc/cloud-controlplane/group/endpoint-control-plane-service-accounts[Control Plane Service Accounts]
3424

3525
// For serverless, show this section at the end of the doc
3626
ifndef::env-serverless[]

modules/networking/pages/azure-private-link.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ After <<get-a-cloud-api-access-token,getting an access token>>, you can <<create
2121
* Install xref:manage:rpk/rpk-install.adoc[`rpk`].
2222
* Install https://jqlang.org/download/[`jq`^], which is used to parse JSON values from API responses.
2323
* You will use the https://learn.microsoft.com/en-us/cli/azure/[Azure CLI^] to authenticate with Azure and configure resources in your Azure account.
24-
* You will use the xref:deploy:deployment-option/cloud/api/cloud-api-overview.adoc[Redpanda Cloud API] to enable the Redpanda Private Link service for your clusters. Follow the steps on this page to <<get-a-cloud-api-access-token, get an access token>>.
24+
* You will use the link:/api/doc/cloud-controlplane/[Redpanda Cloud API] to enable the Redpanda Private Link service for your clusters. Follow the steps on this page to <<get-a-cloud-api-access-token, get an access token>>.
2525

2626
TIP: In Kafka clients, set `connections.max.idle.ms` to a value less than 240 seconds.
2727

0 commit comments

Comments
 (0)