Skip to content

Commit 681e01d

Browse files
committed
DOC-1487 apply coderabbit cloud-docs suggestions
1 parent b83d30a commit 681e01d

File tree

10 files changed

+11
-12
lines changed

10 files changed

+11
-12
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,8 +330,8 @@
330330
**** xref:develop:connect/components/metrics/none.adoc[]
331331
**** xref:develop:connect/components/metrics/prometheus.adoc[]
332332

333-
*** xref:develop:connect/components/logger/about.adoc[]
334333
*** xref:develop:connect/components/redpanda/about.adoc[Redpanda]
334+
*** xref:develop:connect/components/logger/about.adoc[]
335335

336336
** xref:develop:connect/guides/index.adoc[]
337337
*** xref:develop:connect/guides/bloblang/about.adoc[]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ NOTE: With standard BYOC clusters, Redpanda manages security policies and resour
5252

5353
==== Bring Your Own Network (BYOVPC/BYOVNet)
5454

55-
BYOVPC or BYOVNet clusters allow you to deploy the Redpanda glossterm:data plane[] into your existing VPC (for AWS or GCP) or VNet (for Azure) and take full control of managing the networking lifecycle. Compared to standard BYOC, BYOVPC/BYOVNet provides more security, but the configuration is more complex. See <<Shared responsibility model>>.
55+
BYOVPC or BYOVNet clusters allow you to deploy the Redpanda glossterm:data plane[] into your existing VPC (for AWS or GCP) or VNet (for Azure) and take full control of the networking lifecycle. Compared to standard BYOC, BYOVPC/BYOVNet provides more security, but the configuration is more complex. See <<Shared responsibility model>>.
5656

5757
The BYOC infrastructure that Redpanda manages should not be used to deploy any other workloads.
5858

modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ EOF
448448
+
449449
TIP: See the full list of zones and tiers available with each provider in the xref:api:ROOT:cloud-controlplane-api.adoc#api-description[Control Plane API reference].
450450

451-
. Make a Cloud API call to create a Redpanda network and get the network ID from the response in JSON `.operation.metadata.network_id`.
451+
. Make a Cloud API call to create a Redpanda cluster and get the network ID from the response in JSON `.operation.metadata.network_id`.
452452
+
453453
```bash
454454
export REDPANDA_ID=$(curl -X POST "https://api.redpanda.com/v1/clusters" \

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ gcloud compute networks subnets create <primary-subnet-name> \
4444
--network <shared-vpc-name> \
4545
--range 10.0.0.0/24 \
4646
--region <region> \
47-
--secondary-range <secondary-ipv4-range-name-for-pods>=10.0.8.0/21,<secondary-ipv2-range-name-for-services>=10.0.1.0/24
47+
--secondary-range <secondary-ipv4-range-name-for-pods>=10.0.8.0/21,<secondary-ipv4-range-name-for-services>=10.0.1.0/24
4848
```
4949
+
5050
Additionally, a /28 CIDR is required for the GKE master IP addresses. This CIDR is not used in the GCP networking configuration, but is input into the Redpanda UI; for example, 10.0.7.240/28.

modules/get-started/pages/cluster-types/serverless.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ NOTE: Redpanda Serverless is opinionated about Kafka configurations. For example
8282

8383
== Supported features
8484

85-
* Redpanda Serverless supports the Kafka API.
86-
* Serverless clusters work with all Kafka clients. See xref:develop:kafka-clients.adoc[].
85+
* Redpanda Serverless supports the Kafka API. Serverless clusters work with all Kafka clients. See xref:develop:kafka-clients.adoc[].
8786
* Serverless clusters support all major Apache Kafka messages for managing topics, producing/consuming data (including transactions), managing groups, managing offsets, and managing ACLs. (User management is available in the Redpanda Cloud UI or with `rpk security acl`.)
8887
* xref:develop:connect/about.adoc[Redpanda Connect] is integrated with Serverless as a beta feature for testing and feedback. Choose from a range of connectors, processors, and other components to quickly build and deploy streaming data pipelines or AI applications.
8988

modules/manage/pages/monitor-cloud.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ image::https://github.com/redpanda-data/observability/blob/main/docs/images/Ops%
7373

7474
It includes https://github.com/redpanda-data/observability#grafana-dashboards[example Grafana dashboards^] and a https://github.com/redpanda-data/observability#sandbox-environment[sandbox environment^] in which you launch a Dockerized Redpanda cluster and create a custom workload to monitor with dashboards.
7575

76-
== Monitor for health and performance
76+
== Monitor health and performance
7777

7878
include::ROOT:manage:partial$monitor-health.adoc[tag=single-source]
7979

modules/networking/pages/aws-privatelink.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export RESOURCE_GROUP_ID=<uuid>
4545

4646
. Call xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/networks[`POST /v1/networks`] to create a network.
4747
+
48-
Make sure to supply your own values in the following example request. The example uses a BYOC cluser. For a Dedicated cluster, set `"cluster_type": "TYPE_DEDICATED"`. Store the network ID (`network_id`) after the network is created to check whether you can proceed to cluster creation.
48+
Make sure to supply your own values in the following example request. The example uses a BYOC cluster. For a Dedicated cluster, set `"cluster_type": "TYPE_DEDICATED"`. Store the network ID (`network_id`) after the network is created to check whether you can proceed to cluster creation.
4949
+
5050
--
5151
- `name`

modules/networking/pages/dedicated/gcp/configure-psc-in-api.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ gcloud compute firewall-rules create redpanda-psc \
3737
network_post_body=`cat << EOF
3838
{
3939
"cloud_provider": "CLOUD_PROVIDER_GCP",
40-
"cluster_type": "DEDICATED",
40+
"cluster_type": "TYPE_DEDICATED",
4141
"name": "<shared-vpc-name>",
4242
"resource_group_id": "$RESOURCE_GROUP_ID",
4343
"region": "<region>",
@@ -83,7 +83,7 @@ export CLUSTER_POST_BODY=`cat << EOF
8383
{
8484
"cloud_provider": "CLOUD_PROVIDER_GCP",
8585
"connection_type": "CONNECTION_TYPE_PRIVATE",
86-
"type": "DEDICATED",
86+
"type": "TYPE_DEDICATED",
8787
"name": "<cluster-name>",
8888
"resource_group_id": "$RESOURCE_GROUP_ID",
8989
"network_id": "$NETWORK_ID",

modules/networking/partials/psc-api2.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-
4141
CLUSTER_PATCH_BODY=`cat << EOF
4242
{
4343
"gcp_private_service_connect": {
44-
"enabled": false,
44+
"enabled": false
4545
}
4646
}
4747
EOF`

modules/security/pages/cloud-encryption.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ and periodically rotated managed master key (SSE-S3). The block cipher uses AES-
2222
== Data in transit encryption
2323

2424
All network traffic transporting customer data is encrypted in transit using
25-
asymmetric encryption with TLS 1.2. The network connection to the control plane
25+
asymmetric encryption with TLS 1.2 and TLS 1.3. The network connection to the control plane
2626
is also TLS 1.2 encrypted.
2727

2828
Data plane TLS certificates are generated and signed by

0 commit comments

Comments
 (0)