Skip to content

Commit 13fdc99

Browse files
author
Nick Vigilante
committed
Merge branch 'master' into DOC-2827-serverless-movr
2 parents 898fc63 + 2b293be commit 13fdc99

File tree

1,417 files changed

+14833
-12610
lines changed

Some content is hidden

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

1,417 files changed

+14833
-12610
lines changed

.github/workflows/changed_files.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ jobs:
4444
major_version=${path[0]}
4545
fi
4646
file_name=${path[-1]}
47-
mainRefs=($(grep -irl ${file_name} ${major_version} | sed -e 's/^\.\///g'))
48-
includeRefs=($(grep -irl ${file_name} _includes/${major_version} | sed -e 's/^\.\///g'))
47+
mainRefs=($(grep -irl /${file_name} ${major_version} | sed -e 's/^\.\///g'))
48+
includeRefs=($(grep -irl /${file_name} _includes/${major_version} | sed -e 's/^\.\///g'))
4949
if [[ ${#mainRefs[@]} > 0 ]]
5050
then
5151
for ref in ${mainRefs[@]}; do

.htmltest.yml

+9-1
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,24 @@ ExternalTimeout: 30
33
IgnoreDirs:
44
- ^docs/stable
55
- ^docs/dev
6+
- ^docs/v1.0
7+
- ^docs/v1.1
68
- ^docs/v1.2
9+
- ^docs/v2.0
10+
- ^docs/v2.1
11+
- ^docs/advisories
712
IgnoreURLs:
8-
- "http://localhost*"
13+
- "http://localhost:*"
914
- "https://github.com.*"
1015
- "https://movr.cloud"
1116
- "https://support.cockroachlabs.com/*"
1217
- "https://www.php.net/*"
1318
- "https://crates.io/*"
1419
- "https://docs.pipenv.org/*"
1520
- "https://arxiv.org/*"
21+
- "https://fonts.googleapis.com/*"
22+
- "https://fonts.gstatic.com/*"
23+
- "https://typeorm.io/*"
1624
IgnoreInternalEmptyHash: true
1725
TestFilesConcurrently: true
1826
DocumentConcurrencyLimit: 16

Makefile

+6-1
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,22 @@ no-remote-cache: bootstrap
6262
.PHONY: profile
6363
profile: bootstrap
6464
bundle exec jekyll $(jekyll-action) --incremental --profile --trace --config _config_base.yml,_config_cockroachdb.yml$(extra-config) $(JEKYLLFLAGS)
65+
6566

6667
.PHONY: test
6768
test:
68-
go get -u github.com/cockroachdb/htmltest
6969
# Docker must be running locally for this to work.
7070
./netlify/local
7171
htmltest
7272

73+
.PHONY: linkcheck
74+
linkcheck: cockroachdb-build
75+
htmltest -s
76+
7377
vendor:
7478
gem install bundler
7579
bundle install
80+
go install github.com/wjdp/htmltest@master
7681

7782
bootstrap: Gemfile | vendor
7883
touch $@

StyleGuide.md

+8
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ Avoid using socially-charged terms for features and technical concepts.
182182
- Use periods at the end of list items if they are sentences or complete a sentence.
183183
- Use the [Oxford (a.k.a. serial) comma](https://en.wikipedia.org/wiki/Serial_comma).
184184
- Avoid using slashes `/` and ampersands `&` as conjunctions in place of **or** and **and** respectively, unless space is very limited (e.g., in a table).
185+
- Avoid using _and/or_ unless space is very limited (e.g., in a table). Instead, decide whether **and** or **or** can stand alone or make use of **both** when the inclusivity must be explicit, e.g., **x or y or both**.
185186

186187
For more detail about how to format text, see [Components](#components).
187188

@@ -204,6 +205,13 @@ Each version's pages are found in a directory named for the version. For example
204205

205206
Each version's images are stored in a versioned directory under the `images` directory. For example, images for CockroachDB v21.1 are in the `docs > images > v21.1` directory. For more information, see [Images](#images).
206207

208+
### File naming
209+
210+
File names should match the page title. If you need to change a file name, it is necessary to do the following:
211+
212+
- Add the previous page URL with the new URL to `_redirects`.
213+
- Replace all links to the previous file name with the new file name in the applicable docs versions.
214+
207215
## Content types
208216

209217
There are four fundamental content types:

_config_base.yml

+8-8
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,16 @@ release_info:
8585
start_time: 2022-05-10 14:15:58.748869 +0000 UTC
8686
version: v21.1.19
8787
v21.2:
88-
build_time: 2022-05-23 00:00:00 (go1.16)
88+
build_time: 2022-06-06 00:00:00 (go1.16)
8989
docker_image: cockroachdb/cockroach
90-
name: v21.2.11
91-
start_time: 2022-05-18 11:39:58.956639 +0000 UTC
92-
version: v21.2.11
90+
name: v21.2.12
91+
start_time: 2022-06-02 14:27:35.870357 +0000 UTC
92+
version: v21.2.12
9393
v22.1:
94-
build_time: 2022-05-24 00:00:00 (go1.17)
94+
build_time: 2022-06-22 00:00:00 (go1.17)
9595
docker_image: cockroachdb/cockroach
96-
name: v22.1.0
97-
start_time: 2022-05-24 11:14:49.970328 +0000 UTC
98-
version: v22.1.0
96+
name: v22.1.2
97+
start_time: 2022-06-16 08:22:03.011199 +0000 UTC
98+
version: v22.1.2
9999
site_title: CockroachDB Docs
100100
url: https://www.cockroachlabs.com

_data/releases.csv

+3
Original file line numberDiff line numberDiff line change
@@ -279,3 +279,6 @@ v22.1.0-rc.1,v22.1,2022-05-09,false,False,Testing,False,go1.17,5b78463ed2e7106a8
279279
v21.1.19,v21.1,2022-05-09,false,False,Production,False,go1.15,bf2bef135b5be9c73ccc445f2d996781ee59e94f,cockroachdb/cockroach,false
280280
v21.2.11,v21.2,2022-05-23,false,False,Production,False,go1.16,b05bab30da2ff789dc232da4fac771c01a72a87f,cockroachdb/cockroach,false
281281
v22.1.0,v22.1,2022-05-24,false,False,Production,False,go1.17,5b78463ed2e7106a8477b63fa837564ad02bb510,cockroachdb/cockroach,true
282+
v22.1.1,v22.1,2022-06-06,false,False,Production,False,go1.17,242d13b1191e31a25a36ed9cd7abc5f5b24cb510,cockroachdb/cockroach,true
283+
v21.2.12,v21.2,2022-06-06,false,False,Production,False,go1.16,4f97a101e6c1ba12f1ff133d69beee4333b7216e,cockroachdb/cockroach,false
284+
v22.1.2,v22.1,2022-06-22,false,False,Production,False,go1.17,fc456a26830067b6dfbb8cd87e093a28d9b833d1,cockroachdb/cockroach,true

_data/versions.csv

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ v20.1,2020-05-12,2021-05-12,2021-11-12,v19.2
99
v20.2,2020-11-10,2021-11-10,2022-05-10,v20.1
1010
v21.1,2021-05-18,2022-05-18,2022-11-18,v20.2
1111
v21.2,2021-11-16,2022-11-16,2023-05-16,v21.1
12-
v22.1,2022-05-24,2023-05-24,2022-11-24,v21.2
12+
v22.1,2022-05-24,2023-05-24,2023-11-24,v21.2

_includes/releases/v21.1/v21.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ For information about new and unresolved limitations in CockroachDB v21.1, with
113113
Area | Topic | Description
114114
-----|-------|------------
115115
Cockroach University | **New Intro Courses** | [Introduction to Distributed SQL and CockroachDB](https://university.cockroachlabs.com/courses/course-v1:crl+intro-to-distributed-sql-and-cockroachdb+self-paced/about) teaches you the core concepts behind distributed SQL databases and describes how CockroachDB fits into this landscape. [Practical First Steps with CockroachDB](https://university.cockroachlabs.com/courses/course-v1:crl+practical-first-steps-with-crdb+self-paced/about) is a hands-on sequel that gives you the tools to get started with CockroachDB.
116-
Cockroach University | **New Java Course** | [Fundamentals of CockroachDB for Java Developers](https://university.cockroachlabs.com/courses/course-v1:crl+fundamentals-of-crdb-for-java-devs+self-paced/about) walks you through building a full-stack vehicle-sharing app in Java using the popular Spring Data JPA framework with Spring Boot and a <a href="https://cockroachlabs.cloud/signup?referralId=docs_crdb_release_notes" rel="noopener" target="_blank">CockroachCloud Free</a> cluster as the backend.
116+
Cockroach University | **New Java Course** | [Fundamentals of CockroachDB for Java Developers](https://university.cockroachlabs.com/courses/course-v1:crl+fundamentals-of-crdb-for-java-devs+self-paced/about) guides you through building a full-stack vehicle-sharing app in Java using the popular Spring Data JPA framework with Spring Boot and a <a href="https://cockroachlabs.cloud/signup?referralId=docs_crdb_release_notes" rel="noopener" target="_blank">CockroachCloud Free</a> cluster as the backend.
117117
Cockroach University | **New Query Performance Course** | [CockroachDB Query Performance for Developers](https://university.cockroachlabs.com/courses/course-v1:crl+cockroachdb-query-performance-for-devs+self-paced/about) teaches you key CockroachDB features and skills to improve application performance and functionality, such as analyzing a query execution plan, using indexes to avoid expensive full table scans, improving sorting performance, and efficiently querying fields in JSON records.
118118
Docs | **Quickstart** | Documented the simplest way to [get started with CockroachDB](../cockroachcloud/quickstart.html) for testing and app development by using <a href="https://cockroachlabs.cloud/signup?referralId=docs_crdb_release_notes" rel="noopener" target="_blank">CockroachCloud Free</a>.
119119
Docs | **Developer Guidance** | Published more comprehensive, task-oriented [guidance for developers](../v21.1/developer-guide-overview.html) building applications on CockroachDB, including connecting to a cluster, designing a database schema, reading and writing data, optimizing query performance, and debugging applications.

_includes/releases/v21.2/v21.2.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Area | Topic | Description
113113
---------------------+---------------------------+------------
114114
Cockroach University | **New Serverless course** | [Introduction to Serverless Databases and {{ site.data.products.serverless }}](https://university.cockroachlabs.com/courses/course-v1:crl+intro-to-serverless+self-paced/about) teaches you the core concepts behind serverless databases and gives you the tools you need to get started with {{ site.data.products.serverless }}.
115115
Cockroach University | **New Schema Design Course** | [Foundations of Schema Design in CockroachDB](https://university.cockroachlabs.com/courses/course-v1:crl+foundations-schema-design-cockroachdb+self-paced/about) teaches you CockroachDB's rich data types and the best practices and anti-patterns to consider when designing schema for CockroachDB.
116-
Cockroach University | **New Node.js Course** | [Fundamentals of CockroachDB for Node.js Developers](https://university.cockroachlabs.com/courses/course-v1:crl+fundamentals-of-crdb-for-nodejs-devs+self-paced/about) walks you through building a full-stack vehicle-sharing app in Typescript using Node.js with TypeORM and a <a href="https://cockroachlabs.cloud/signup?referralId=docs_crdb_release_notes" rel="noopener" target="_blank">CockroachCloud Free</a> cluster as the backend.
116+
Cockroach University | **New Node.js Course** | [Fundamentals of CockroachDB for Node.js Developers](https://university.cockroachlabs.com/courses/course-v1:crl+fundamentals-of-crdb-for-nodejs-devs+self-paced/about) guides you through building a full-stack vehicle-sharing app in Typescript using Node.js with TypeORM and a <a href="https://cockroachlabs.cloud/signup?referralId=docs_crdb_release_notes" rel="noopener" target="_blank">CockroachCloud Free</a> cluster as the backend.
117117
Docs | **CockroachDB Cloud Guidance** | Added Node.js, Go, Python, and Java sample app code and connection guidance to the [{{ site.data.products.serverless }} Quickstart](../cockroachcloud/quickstart.html), as well as docs explaining the [{{ site.data.products.serverless }} Architecture](../cockroachcloud/architecture.html), important concepts for [planning/managing a Serverless cluster](../cockroachcloud/plan-your-cluster.html) (e.g., request units, cluster scaling), and how to run [bulk operations on {{ site.data.products.dedicated }} and {{ site.data.products.serverless }} clusters](../cockroachcloud/run-bulk-operations.html).
118118
Docs | **Multi-Region Guidance** | Added docs on [transitioning to the new multi-region SQL abstractions](../v21.2/migrate-to-multiregion-sql.html) from the legacy zone-configuration-based workflows, and on [data domiciling in multi-region clusters](../v21.2/data-domiciling.html).
119119
Docs | **Performance Tuning Recipes** | Added [solutions for common performance issues](../v21.2/performance-recipes.html).

_includes/releases/v21.2/v21.2.12.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## v21.2.12
2+
3+
Release Date: June 6, 2022
4+
5+
{% include releases/release-downloads-docker-image.md release=include.release %}
6+
7+
<h3 id="v21-2-12-miscellaneous">Miscellaneous</h3>
8+
9+
* Fixed an internal logging bug that affected the stability of the server. [#4f97a101e][#4f97a101e]
10+
11+
<h3 id="v21-2-12-contributors">Contributors</h3>
12+
13+
This release includes 2 commits by 2 authors.
14+
15+
[#4d7c8f356]: https://github.com/cockroachdb/cockroach/commit/4d7c8f356
16+
[#4f97a101e]: https://github.com/cockroachdb/cockroach/commit/4f97a101e

_includes/releases/v22.1/v22.1.0-alpha.5.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Release Date: March 28, 2022
1818
- Added support for the `MOVE` command, which moves a SQL cursor without fetching any rows from it. `MOVE` is identical to [`FETCH`](../v22.1/limit-offset.html), including in its arguments and syntax, except it doesn't return any rows. [#74877][#74877]
1919
- Added the `enable_implicit_transaction_for_batch_statements` [session variable](../v22.1/set-vars.html). It defaults to false. When true, multiple statements in a single query (a "batch statement") will all run in the same implicit transaction, which matches the PostgreSQL wire protocol. This setting is provided for users who want to preserve the behavior of CockroachDB versions v21.2 and lower. [#77865][#77865]
2020
- The `enable_implicit_transaction_for_batch_statements` session variable now defaults to false. [#77973][#77973]
21-
- The `experimental_enable_hash_sharded_indexes` session variable is deprecated as hash-sharded indexes are enabled by default. Enabling this setting results in a noop. [#78038][#78038]
21+
- The `experimental_enable_hash_sharded_indexes` session variable is deprecated as hash-sharded indexes are enabled by default. Enabling this setting results in a no-op. [#78038][#78038]
2222
- New `crdb_internal.merge_stats_metadata` [built-in function](../v22.1/functions-and-operators.html#built-in-functions) to group statement statistics metadata. [#78064][#78064]
2323
- [Changefeeds](../v22.1/use-changefeeds.html) can now specify column families to target, using the syntax `[TABLE] foo FAMILY bar`. For example, `CREATE CHANGEFEED FOR TABLE foo FAMILY bar, TABLE foo FAMILY baz, TABLE users` will create a feed that watches the `bar` and `baz` column families of `foo`, as well as the whole table `users`. A family must exist with that name when the feed is created. If all columns in a watched family are dropped in an `ALTER TABLE` statement, the feed will fail with an error, similar to dropping a table. The behavior is otherwise similar to feeds created using `split_column_families`. [#77964][#77964]
2424
- [Casts](../v22.1/data-types.html#data-type-conversions-and-casts) that are affected by the `DateStyle` or `IntervalStyle` session variables used in [computed columns](../v22.1/computed-columns.html) or [partial index](../v22.1/partial-indexes.html) definitions will be rewritten to use immutable functions after upgrading to v22.1. [#78229][#78229]

_includes/releases/v22.1/v22.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Before [upgrading to CockroachDB v22.1](../v22.1/upgrade-cockroach-version.html)
126126

127127
- Using the [`cockroach node drain`](../v22.1/cockroach-node.html) command without specifying a node ID is deprecated. [#73991][#73991]
128128
- The flag `--self` of the [`cockroach node decommission` command](../v22.1/cockroach-node.html) is deprecated. Instead, operators should specify the node ID of the target node as an explicit argument. The node that the command is connected to should not be a target node. [#74319][#74319]
129-
- The `experimental_enable_hash_sharded_indexes` session variable is deprecated as hash-sharded indexes are enabled by default. Enabling this setting results in a noop. [#78038][#78038]
129+
- The `experimental_enable_hash_sharded_indexes` session variable is deprecated as hash-sharded indexes are enabled by default. Enabling this setting results in a no-op. [#78038][#78038]
130130
- The [`BACKUP TO`](../v22.1/) syntax to take backups is deprecated, and will be removed in a future release. Create a backup collection using the `BACKUP INTO` syntax. [#78250][#78250]
131131
- Users can no longer define the subdirectory of their full backup. This deprecated syntax can be enabled by changing the new `bulkio.backup.deprecated_full_backup_with_subdir` [cluster setting](../v22.1/cluster-settings.html) to `true`. [#80145][#80145]
132132
- `SHOW BACKUP` without the `IN` keyword to specify a subdirectory is deprecated and will be removed from a future release. Users are recommended to only create collection based backups and view them with `SHOW BACKUP FROM <backup> IN <collection>`. [#79116][#79116]

0 commit comments

Comments
 (0)