Skip to content

Commit

Permalink
Merge pull request #4622 from cockroachdb/fix-anchors
Browse files Browse the repository at this point in the history
Don't bury manual anchor links under top nav
  • Loading branch information
Jesse Seldess authored Apr 3, 2019
2 parents d38d457 + a610eed commit 045c37e
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 7 deletions.
20 changes: 17 additions & 3 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,18 +186,32 @@ Link capitalization can be either title- or sentence-case:

Links are marked with inline text surrounded by square brackets followed by the link address in parentheses. If you are including a relative (i.e., internal) link:

- To another page in the docs, use just the name of the file.
- To link to another page in the docs, use just the name of the file.

**Example:** `[here](name-of-article.html)`

- To a specific section on another page, use the name of the file plus the heading.
- To link to a specific heading on another page, use the name of the file plus the heading.

**Example:** `[xyz](name-of-article.html#heading-on-page)`

- To a specific section on the current page, use just the heading.
- To link to a specific heading on the current page, use just the heading.

**Example:** `[xyz](#heading-on-page)`

- To link to a specific location on a page that is not a heading (e.g., a specific command-line flag in a table), add a manual anchor and use the `name` parameter:

**Example:**

```
# Anchor:
<a name="flags-max-offset"></a>`--max-offset`
```
```
# Link:
[--max-offset](#flags-max-offset)
```
### Tips, notes, and warnings
Our docs use three classes of highlighted text:
Expand Down
3 changes: 2 additions & 1 deletion css/customstyles.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion css/customstyles.css.map

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion css/customstyles.scss
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ h2:target:before,
h3:target:before,
h4:target:before,
h5:target:before,
h6:target:before {
h6:target:before,
td a:target:before {
content: '';
display: block;
height: 155px;
Expand Down
2 changes: 1 addition & 1 deletion v19.1/start-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Flag | Description
`--listening-url-file` | The file to which the node's SQL connection URL will be written on successful startup, in addition to being printed to the [standard output](#standard-output).<br><br>This is particularly helpful in identifying the node's port when an unused port is assigned automatically (`--port=0`).
`--locality` | Arbitrary key-value pairs that describe the location of the node. Locality might include country, region, datacenter, rack, etc. For more details, see [Locality](#locality) below.
`--max-disk-temp-storage` | The maximum on-disk storage capacity available to store temporary data for SQL queries that exceed the memory budget (see `--max-sql-memory`). This ensures that JOINs, sorts, and other memory-intensive SQL operations are able to spill intermediate results to disk. This can be a percentage (notated as a decimal or with `%`) or any bytes-based unit (e.g., `.25`, `25%`, `500GB`, `1TB`, `1TiB`).<br><br><strong>Note:</strong> If you use the `%` notation, you might need to escape the `%` sign, for instance, while configuring CockroachDB through `systemd` service files. For this reason, it's recommended to use the decimal notation instead. Also, if expressed as a percentage, this value is interpreted relative to the size of the first store. However, the temporary space usage is never counted towards any store usage; therefore, when setting this value, it's important to ensure that the size of this temporary storage plus the size of the first store doesn't exceed the capacity of the storage device.<br><br>The temporary files are located in the path specified by the `--temp-dir` flag, or in the subdirectory of the first store (see `--store`) by default.<br><br>**Default:** `32GiB`
`--max-offset` | The maximum allowed clock offset for the cluster. If observed clock offsets exceed this limit, servers will crash to minimize the likelihood of reading inconsistent data. Increasing this value will increase the time to recovery of failures as well as the frequency of uncertainty-based read restarts.<br><br>Note that this value must be the same on all nodes in the cluster and cannot be changed with a [rolling upgrade](upgrade-cockroach-version.html). In order to change it, first stop every node in the cluster. Then once the entire cluster is offline, restart each node with the new value.<br><br>**Default:** `500ms`
<a name="flags-max-offset"></a>`--max-offset` | The maximum allowed clock offset for the cluster. If observed clock offsets exceed this limit, servers will crash to minimize the likelihood of reading inconsistent data. Increasing this value will increase the time to recovery of failures as well as the frequency of uncertainty-based read restarts.<br><br>Note that this value must be the same on all nodes in the cluster and cannot be changed with a [rolling upgrade](upgrade-cockroach-version.html). In order to change it, first stop every node in the cluster. Then once the entire cluster is offline, restart each node with the new value.<br><br>**Default:** `500ms`
`--max-sql-memory` | The maximum in-memory storage capacity available to store temporary data for SQL queries, including prepared queries and intermediate data rows during query execution. This can be a percentage (notated as a decimal or with `%`) or any bytes-based unit, for example:<br><br>`--max-sql-memory=.25`<br>`--max-sql-memory=25%`<br>`--max-sql-memory=10000000000 ----> 1000000000 bytes`<br>`--max-sql-memory=1GB ----> 1000000000 bytes`<br>`--max-sql-memory=1GiB ----> 1073741824 bytes`<br><br>The temporary files are located in the path specified by the `--temp-dir` flag, or in the subdirectory of the first store (see `--store`) by default.<br><br><strong>Note:</strong> If you use the `%` notation, you might need to escape the `%` sign, for instance, while configuring CockroachDB through `systemd` service files. For this reason, it's recommended to use the decimal notation instead.<br><br>**Default:** `128MiB`<br><br>The default SQL memory size is reasonable for local development clusters. For production deployments, this should be increased to 25% or higher. See [Recommended Production Settings](recommended-production-settings.html#cache-and-sql-memory-size) for more details.
`--pid-file` | The file to which the node's process ID will be written on successful startup. When this flag is not set, the process ID is not written to file.
`--store`<br>`-s` | The file path to a storage device and, optionally, store attributes and maximum size. When using multiple storage devices for a node, this flag must be specified separately for each device, for example: <br><br>`--store=/mnt/ssd01 --store=/mnt/ssd02` <br><br>For more details, see [Store](#store) below.
Expand Down

0 comments on commit 045c37e

Please sign in to comment.