Skip to content

Commit

Permalink
Merge branch 'main' into generic-query-plans
Browse files Browse the repository at this point in the history
  • Loading branch information
taroface authored Aug 8, 2024
2 parents 2b24fa8 + 7e5695d commit 5322c13
Show file tree
Hide file tree
Showing 323 changed files with 3,628 additions and 2,066 deletions.
11 changes: 11 additions & 0 deletions StyleGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -821,6 +821,17 @@ Highlight shell and SQL commands where appropriate using the following info:

Start shell code samples with `~~~ shell` followed by a line break. The first character of the next line must be the terminal marker `$`. For multi-line shell commands, use a backslash (`\`) at the end of each line to indicate a line break.

In an example command to download an artifact using the command line, `curl` is preferred over `wget` because it is included in Linux, macOS, and recent builds of Windows. Use syntax like:

```
curl -o {optional_output_path}/{output_file_name} [-H {header_keys_and_values}] {url}
```

- In general, always specify `-o` or `--output` to a path and filename, or omit the path to save the file to the current working directory.

Omit `-o` to print the response to standard output. Printing a binary file can corrupt the terminal session or lead to unintended results, and is generally useful only when piping or redirecting the output to another command or a file.
- Headers are optional, but certain APIs such as the CockroachDB Cloud API require certain header fields to be set.

**SQL code samples**

SQL code samples are broken into two sections: commands and responses.
Expand Down
2 changes: 2 additions & 0 deletions src/current/_data/alerts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ tip: '<div class="alert alert-success" role="alert"><i class="fas fa-check-squar
note: '<div class="alert alert-info" role="alert"><i class="fas fa-info-circle"></i> <b>Note: </b>'
important: '<div class="alert alert-warning" role="alert"><i class="fas fa-warning"></i> <b>Important: </b>'
warning: '<div class="alert alert-danger" role="alert"><i class="fas fa-exclamation-circle"></i> <b>Warning: </b>'
version: '<div class="alert alert-version" role="alert"><i class="fas fa-info-circle"></i>'
end: '</div>'

callout_danger: '<div class="bs-callout bs-callout--danger"><div class="bs-callout__label">Warning:</div>'
callout_success: '<div class="bs-callout bs-callout--success"><div class="bs-callout__label">Tip:</div>'
callout_info: '<div class="bs-callout bs-callout--info"><div class="bs-callout__label">Note:</div>'
callout_version: '<div class="bs-callout bs-callout--version">'

hr_faded: '<hr class="faded"/>'
hr_shaded: '<hr class="shaded"/>'
92 changes: 0 additions & 92 deletions src/current/_data/cloud_releases.csv

This file was deleted.

14 changes: 3 additions & 11 deletions src/current/_data/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,7 @@
versions: ['cockroachcloud']

- destination: molt/live-migration-service.md
sources:
- v23.1/live-migration-service.md
- v23.2/live-migration-service.md
- v24.1/live-migration-service.md
sources: [':version/live-migration-service.md']

- destination: logging-overview.md
sources: ['debug-and-error-logs.md']
Expand All @@ -275,15 +272,10 @@
versions: ['v2.1', 'v19.1', 'v19.2', 'v20.1', 'v20.2', 'v21.1']

- destination: molt/molt-fetch.md
sources:
- v23.2/molt-fetch.md
- v24.1/molt-fetch.md
sources: [':version/molt-fetch.md']

- destination: molt/molt-verify.md
sources:
- v23.1/molt-verify.md
- v23.2/molt-verify.md
- v24.1/molt-verify.md
sources: [':version/molt-verify.md']

- destination: node-shutdown.md
sources: ['cockroach-quit.md']
Expand Down
Loading

0 comments on commit 5322c13

Please sign in to comment.