Skip to content

Commit ff04715

Browse files
authored
Merge branch 'main' into edueng-614-validate-branch-existence
2 parents a3b864d + 395351c commit ff04715

558 files changed

Lines changed: 5450 additions & 20342 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

StyleGuide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Included in this guide:
1313
- [CockroachDB products](#cockroachdb-products)
1414
- [CockroachDB versions](#cockroachdb-versions)
1515
- [Third-party products](#third-party-products)
16+
- [AI](#ai)
1617
- [Inclusivity](#inclusivity)
1718
- [Avoid ableist language](#avoid-ableist-language)
1819
- [Avoid unnecessarily gendered language](#avoid-unnecessarily-gendered-language)
@@ -219,6 +220,19 @@ Use **on a cluster** when referring to workloads, services, or databases that ru
219220
- Databases on the cluster
220221
- Jobs running on the cluster
221222

223+
### AI
224+
225+
Write "AI" without periods. Not "A.I."
226+
227+
You don't need to precede the usage of the term "AI" with its elaboration (e.g. "Artificial Intelligence (AI).") Any reader will know what AI is.
228+
229+
When describing "AI tools," "AI agents," or "AI assistants" (etc.) in the context of integrating with CockroachDB, precede introductory instances of these terms with the word "your."
230+
231+
- **Avoid:** The MCP server enables AI tools to access a cluster.
232+
- **Prefer:** The MCP server enables your AI tools to access a cluster.
233+
234+
This is a request from Cockroach Labs' legal team. The idea is to remind the reader that these tools are not Cockroach Labs', and so any mistaken/detrimental use of these tools is not Cockroach Labs' responsibility. Not every instance of these terms needs to be preceded with the word "your." This is mainly meant for early instances of these terms on the page (i.e. in introductory paragraphs), to establish this idea.
235+
222236
## Inclusivity
223237

224238
Use inclusive language that reflects a diverse readership. Avoid terms that inherently exclude, stereotype, or cause confusion.

src/current/_config_cockroachdb.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ destination: _site/docs
44
homepage_title: CockroachDB Docs
55
versions:
66
stable: v26.1
7-
dev: v26.1
7+
dev: v26.2

src/current/_data/cards.yml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,14 @@ develop:
88
- link: "/PREFIX/connect-to-the-database.html"
99
title: "Connect to a cluster"
1010
text: "Get details on how to connect to a CockroachDB cluster using your favorite language and framework."
11-
- link: "/PREFIX/example-apps.html"
12-
title: "Example applications"
13-
text: "Browse our example applications written in your favorite language and framework."
14-
- link: "/PREFIX/example-apps.html"
15-
title: "Tutorials"
16-
text: "Browse our tutorials."
1711
- link: "/PREFIX/developer-basics.html"
1812
title: "Developer basics"
1913
text: "A quick overview of key concepts developers need to know about CockroachDB."
2014
text: "Submit SQL queries to retrieve data from your cluster."
2115
- link: "/PREFIX/schema-design-overview.html"
2216
title: "Design a schema"
2317
text: "Details and best practices about designing schemas for your data."
24-
- link: "/PREFIX/query-data.html"
25-
title: "Read data"
26-
text: "How to query your cluster to retrieve data."
27-
- link: "/PREFIX/insert-data.html"
18+
- link: "/PREFIX/insert.html"
2819
title: "Write data"
2920
text: "How to insert data into your cluster."
3021
- link: "/PREFIX/query-behavior-troubleshooting.html"

src/current/_data/redirects.yml

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@
422422
- show-transaction.md
423423
versions: [':version']
424424

425-
- destination: stable/example-apps.md#python
425+
- destination: stable/build-a-python-app-with-cockroachdb-psycopg3
426426
sources:
427427
- v20.1/build-a-python-app-with-cockroachdb-pony.md
428428

@@ -1073,11 +1073,88 @@
10731073
sources: ['cockroachcloud/learn-cockroachdb-sql.md']
10741074

10751075
- destination: cockroachcloud/client-certs-advanced.md
1076-
sources: ['v26.1/security-reference/config-secure-hba.md', 'stable/security-reference/config-secure-hba.md']
1076+
sources: ['v26.1/security-reference/config-secure-hba.md', 'stable/security-reference/config-secure-hba.md', 'v26.2/security-reference/config-secure-hba.md']
10771077

10781078
- destination: cockroachdb-operator-overview.md
10791079
sources: ['orchestrate-a-local-cluster-with-kubernetes.md', 'orchestrate-a-local-cluster-with-kubernetes-insecure.md']
1080-
versions: ['v26.1']
1080+
versions: ['v26.1', 'v26.2']
10811081

1082+
- destination: deploy-cockroachdb-on-premises.md
1083+
sources: ['deploy-cockroachdb-on-premises-insecure.md']
1084+
versions: ['v26.1', 'v26.2']
10821085

1086+
- destination: deploy-cockroachdb-on-aws.md
1087+
sources: ['deploy-cockroachdb-on-aws-insecure.md']
1088+
versions: ['v26.1', 'v26.2']
10831089

1090+
- destination: deploy-cockroachdb-on-microsoft-azure.md
1091+
sources: ['deploy-cockroachdb-on-microsoft-azure-insecure.md']
1092+
versions: ['v26.1', 'v26.2']
1093+
1094+
- destination: deploy-cockroachdb-on-google-cloud-platform.md
1095+
sources: ['deploy-cockroachdb-on-google-cloud-platform-insecure.md']
1096+
versions: ['v26.1', 'v26.2']
1097+
1098+
- destination: deploy-cockroachdb-on-digital-ocean.md
1099+
sources: ['deploy-cockroachdb-on-digital-ocean-insecure.md']
1100+
versions: ['v26.1', 'v26.2']
1101+
1102+
- destination: stable/developer-guide-overview.md
1103+
sources: ['cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.md']
1104+
1105+
- destination: developer-guide-overview.md
1106+
sources: ['example-apps.md', 'build-a-spring-app-with-cockroachdb-jdbc.md', 'build-a-spring-app-with-cockroachdb-jpa.md', 'movr-flask-use-case.md', 'movr-flask-database.md', 'movr-flask-setup.md', 'movr-flask-application.md', 'movr-flask-deployment.md']
1107+
versions: ['v26.1', 'v26.2']
1108+
1109+
- destination: topology-patterns.md
1110+
sources: ['topology-development.md']
1111+
versions: ['v26.1', 'v26.2']
1112+
1113+
- destination: monitoring-and-alerting.md
1114+
sources: ['datadog.md', 'dbmarlin.md', 'kibana.md']
1115+
versions: ['v26.1', 'v26.2']
1116+
1117+
- destination: schema-design-overview.md
1118+
sources: ['schema-design-database.md', 'schema-design-schema.md', 'schema-design-table.md', 'schema-design-update.md']
1119+
versions: ['v26.1', 'v26.2']
1120+
1121+
- destination: reads-and-writes-overview.md
1122+
sources: ['query-data.md']
1123+
versions: ['v26.1', 'v26.2']
1124+
1125+
- destination: cockroachcloud/overview-page.md
1126+
sources: ['cockroachcloud/cluster-overview-page.md']
1127+
1128+
- destination: releases/index.md
1129+
sources: ['releases/staged-release-process.md']
1130+
1131+
- destination: releases/downloads-archive.md
1132+
sources: ['releases/unsupported-versions.md']
1133+
1134+
- destination: delete.md
1135+
sources: ['delete-data.md']
1136+
versions: ['v26.1', 'v26.2']
1137+
1138+
- destination: configure-replication-zones.md
1139+
sources: ['demo-automatic-cloud-migration.md']
1140+
versions: ['v26.1', 'v26.2']
1141+
1142+
- destination: jsonb.md
1143+
sources: ['demo-json-support.md']
1144+
versions: ['v26.1', 'v26.2']
1145+
1146+
- destination: query-spatial-data.md
1147+
sources: ['export-spatial-data.md']
1148+
versions: ['v26.1', 'v26.2']
1149+
1150+
- destination: insert.md
1151+
sources: ['insert-data.md']
1152+
versions: ['v26.1', 'v26.2']
1153+
1154+
- destination: spatial-data-overview.md
1155+
sources: ['spatial-tutorial.md', 'geoserver.md']
1156+
versions: ['v26.1', 'v26.2']
1157+
1158+
- destination: update.md
1159+
sources: ['update-data.md']
1160+
versions: ['v26.1', 'v26.2']

0 commit comments

Comments
 (0)