Style Guide fixit day

Author: Lauren

v2.1/add-column.md

@@ -23,7 +23,7 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
 | `table_name` | The name of the table to which you want to add the column. |
 | `column_name` | The name of the column you want to add. The column name must follow these [identifier rules](keywords-and-identifiers.html#identifiers) and must be unique within the table but can have the same name as indexes or constraints.  |
 | `typename` | The [data type](data-types.html) of the new column. |
-| `col_qualification` | An optional list of column definitions, which may include [column-level constraints](constraints.html), [collation](collate.html), or [column family assignments](column-families.html).<br><br>Note that it is not possible to add a column with the [Foreign Key](foreign-key.html) constraint. As a workaround, you can add the column without the constraint, then use [`CREATE INDEX`](create-index.html) to index the column, and then use [`ADD CONSTRAINT`](add-constraint.html) to add the Foreign Key constraint to the column. |
+| `col_qualification` | An optional list of column definitions, which may include [column-level constraints](constraints.html), [collation](collate.html), or [column family assignments](column-families.html).<br><br>Note that it is not possible to add a column with the [`FOREIGN KEY`](foreign-key.html) constraint. As a workaround, you can add the column without the constraint, then use [`CREATE INDEX`](create-index.html) to index the column, and then use [`ADD CONSTRAINT`](add-constraint.html) to add the `FOREIGN KEY` constraint to the column. |
 
 ## Viewing schema changes
 
@@ -33,10 +33,12 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
 
 ### Add a single column
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN names STRING;
 ~~~
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > SHOW COLUMNS FROM accounts;
 ~~~
@@ -53,10 +55,12 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
 
 ### Add multiple columns
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN location STRING, ADD COLUMN amount DECIMAL;
 ~~~
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > SHOW COLUMNS FROM accounts;
 ~~~
@@ -76,10 +80,12 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
 
 ### Add a column with a `NOT NULL` constraint and a `DEFAULT` value
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN interest DECIMAL NOT NULL DEFAULT (DECIMAL '1.3');
 ~~~
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > SHOW COLUMNS FROM accounts;
 ~~~
@@ -98,29 +104,37 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
 
 ### Add a column with `NOT NULL` and `UNIQUE` constraints
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN cust_number DECIMAL UNIQUE NOT NULL;
 ~~~
 
 ### Add a column with collation
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN more_names STRING COLLATE en;
 ~~~
 
 ### Add a column and assign it to a column family
 
 #### Add a column and assign it to a new column family
+
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN location1 STRING CREATE FAMILY new_family;
 ~~~
 
 #### Add a column and assign it to an existing column family
+
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN location2 STRING FAMILY existing_family;
 ~~~
 
 #### Add a column and create a new column family if column family does not exist
+
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE accounts ADD COLUMN new_name STRING CREATE IF NOT EXISTS FAMILY f1;
 ~~~

v2.1/add-constraint.md

@@ -6,12 +6,13 @@ toc: false
 
 The `ADD CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and can add the following [constraints](constraints.html) to columns:
 
-- [Check](check.html)
-- [Foreign Keys](foreign-key.html)
-- [Unique](unique.html)
+- [`CHECK`](check.html)
+- [`FOREIGN KEY`](foreign-key.html)
+- [`UNIQUE`](unique.html)
 
 {{site.data.alerts.callout_info}}
-The <a href="primary-key.html">Primary Key</a> and <a href="not-null.html">Not Null</a> constraints can only be applied through <a href="create-table.html"><code>CREATE TABLE</code></a>. The <a href="default-value.html">Default</a> constraint is managed through <a href="alter-column.html"><code>ALTER COLUMN</code>.</a>{{site.data.alerts.end}}
+The [`PRIMARY KEY`](primary-key.html) and [`NOT NULL`](not-null.html) constraints can only be applied through [`CREATE TABLE`](create-table.html). The [`DEFAULT`](default-value.html) constraint is managed through [`ALTER COLUMN`](alter-column.html).
+{{site.data.alerts.end}}
 
 <div id="toc"></div>
 
@@ -29,7 +30,7 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
 |-----------|-------------|
 | `table_name` | The name of the table containing the column you want to constrain. |
 | `constraint_name` | The name of the constraint, which must be unique to its table and follow these [identifier rules](keywords-and-identifiers.html#identifiers). |
-| `constraint_elem` | The [Check](check.html), [Foreign Keys](foreign-key.html), [Unique](unique.html) constraint you want to add. <br/><br/>Adding/changing a Default constraint is done through [`ALTER COLUMN`](alter-column.html). <br/><br/>Adding/changing the table's Primary Key is not supported through `ALTER TABLE`; it can only be specified during [table creation](create-table.html#create-a-table-primary-key-defined). |
+| `constraint_elem` | The [`CHECK`](check.html), [`FOREIGN KEY`](foreign-key.html), [`UNIQUE`](unique.html) constraint you want to add. <br/><br/>Adding/changing a `DEFAULT` constraint is done through [`ALTER COLUMN`](alter-column.html). <br/><br/>Adding/changing the table's `PRIMARY KEY` is not supported through `ALTER TABLE`; it can only be specified during [table creation](create-table.html#create-a-table-primary-key-defined). |
 
 ## Viewing schema changes
 
@@ -39,26 +40,29 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
 
 ### Add the `UNIQUE` constraint
 
-Adding the [Unique constraint](unique.html) requires that all of a column's values be distinct from one another (except for *NULL* values).
+Adding the [`UNIQUE` constraint](unique.html) requires that all of a column's values be distinct from one another (except for *NULL* values).
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE orders ADD CONSTRAINT id_customer_unique UNIQUE (id, customer);
 ~~~
 
 ### Add the `CHECK` constraint
 
-Adding the [Check constraint](check.html) requires that all of a column's values evaluate to `TRUE` for a Boolean expression.
+Adding the [`CHECK` constraint](check.html) requires that all of a column's values evaluate to `TRUE` for a Boolean expression.
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE orders ADD CONSTRAINT total_0_check CHECK (total > 0);
 ~~~
 
 ### Add the `FOREIGN KEY` constraint with `CASCADE`
 
-Before you can add the [Foreign Key](foreign-key.html) constraint to columns, the columns must already be indexed. If they are not already indexed, use [`CREATE INDEX`](create-index.html) to index them and only then use the `ADD CONSTRAINT` statement to add the Foreign Key constraint to the columns.
+Before you can add the [`FOREIGN KEY`](foreign-key.html) constraint to columns, the columns must already be indexed. If they are not already indexed, use [`CREATE INDEX`](create-index.html) to index them and only then use the `ADD CONSTRAINT` statement to add the Foreign Key constraint to the columns.
 
 For example, let's say you have two tables, `orders` and `customers`:
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > SHOW CREATE TABLE customers;
 ~~~
@@ -78,6 +82,7 @@ For example, let's say you have two tables, `orders` and `customers`:
 (1 row)
 ~~~
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > SHOW CREATE TABLE orders;
 ~~~
@@ -100,18 +105,20 @@ For example, let's say you have two tables, `orders` and `customers`:
 
 To ensure that each value in the `orders.customer_id` column matches a unique value in the `customers.id` column, you want to add the Foreign Key constraint to `orders.customer_id`. So you first create an index on `orders.customer_id`:
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > CREATE INDEX ON orders (customer_id);
 ~~~
 
-Then you add the Foreign Key constraint.
+Then you add the `FOREIGN KEY` constraint.
 
 You can include a [foreign key action](foreign-key.html#foreign-key-actions) to specify what happens when a foreign key is updated or deleted.
 
 In this example, let's use `ON DELETE CASCADE` (i.e., when referenced row is deleted, all dependent objects are also deleted).
 
 {{site.data.alerts.callout_danger}}<code>CASCADE</code> does not list objects it drops or updates, so it should be used cautiously.{{site.data.alerts.end}}
 
+{% include copy-clipboard.html %}
 ~~~ sql
 > ALTER TABLE orders ADD CONSTRAINT customer_fk FOREIGN KEY (customer_id) REFERENCES customers (id) ON DELETE CASCADE;
 ~~~

v2.1/admin-ui-access-and-navigate.md

@@ -12,7 +12,9 @@ The built-in Admin UI gives you essential metrics about a cluster's health, such
 
 You can access the Admin UI from any node in the cluster.
 
-{{site.data.alerts.callout_info}}By default, CockroachDB allows all users to access and view the Admin UI. For secure clusters, you can choose to <a href="#secure-the-admin-ui">enable user authentication</a> to restrict access to the Admin UI to authorized users. {{site.data.alerts.end}}
+{{site.data.alerts.callout_info}}
+By default, CockroachDB allows all users to access and view the Admin UI. For secure clusters, you can choose to [enable user authentication](#secure-the-admin-ui) to restrict access to the Admin UI to authorized users.
+{{site.data.alerts.end}}
 
 By default, you can access it via HTTP on port `8080` of the hostname or IP address you configured using the `--host` flag while [starting the node](https://www.cockroachlabs.com/docs/stable/start-a-node.html#general). For example, `http://<any node host>:8080`. If you are running a secure cluster, use `https://<any node host>:8080`.
 
@@ -22,7 +24,7 @@ For additional guidance on accessing the Admin UI in the context of cluster depl
 
 ## Navigate the Admin UI
 
-The left-hand navigation bar allows you to navigate to the [Cluster Overview page](admin-ui-access-and-navigate.html), [Cluster metrics dashboards](admin-ui-overview.html), [Databases page](admin-ui-databases-page.html), and [Jobs page](admin-ui-jobs-page.html).
+The left-hand navigation bar allows you to navigate to the [Cluster Overview page](admin-ui-access-and-navigate.html), [cluster metrics dashboards](admin-ui-overview.html), [Databases page](admin-ui-databases-page.html), and [Jobs page](admin-ui-jobs-page.html).
 
 The main panel displays changes for each page:
 
@@ -110,7 +112,8 @@ You can hover over each graph to see actual point-in-time values.
 
 <img src="{{ 'images/v2.1/admin_ui_hovering.gif' | relative_url }}" alt="CockroachDB Admin UI" style="border:1px solid #eee;max-width:100%" />
 
-{{site.data.alerts.callout_info}}By default, CockroachDB stores timeseries metrics for the last 30 days, but you can reduce the interval for timeseries storage. Alternately, if you are exclusively using a third-party tool such as <a href="monitor-cockroachdb-with-prometheus.html">Prometheus</a> for timeseries monitoring, you can disable timeseries storage entirely. For more details, see this <a href="operational-faqs.html#can-i-reduce-or-disable-the-storage-of-timeseries-data">FAQ</a>.
+{{site.data.alerts.callout_info}}
+By default, CockroachDB stores timeseries metrics for the last 30 days, but you can reduce the interval for timeseries storage. Alternately, if you are exclusively using a third-party tool such as [Prometheus](monitor-cockroachdb-with-prometheus.html) for timeseries monitoring, you can disable timeseries storage entirely. For more details, see this [FAQ](operational-faqs.html#can-i-reduce-or-disable-the-storage-of-timeseries-data).
 {{site.data.alerts.end}}
 
 #### Change time range
@@ -175,7 +178,9 @@ The following types of events are listed:
 
 By default, CockroachDB allows all users to access and view the Admin UI. However, for secure clusters, you can choose to enable user authentication</a> to restrict access to authorized users.
 
-{{site.data.alerts.callout_danger}}<strong>This feature is a work in progress</strong>. It will change leading up to the v2.1 release.{{site.data.alerts.end}}
+{{site.data.alerts.callout_danger}}
+**This feature is a work in progress**. It will change leading up to the v2.1 release.
+{{site.data.alerts.end}}
 
 1. Start a secure cluster as described in our [deployment tutorials](manual-deployment.html).
 
@@ -190,3 +195,9 @@ By default, CockroachDB allows all users to access and view the Admin UI. Howeve
 2. For each user who should have access to the Admin UI, [create a user with a password](create-user.html).
 
     On accessing the Admin UI, these users will see a Login screen, where they will need to enter their usernames and passwords.
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-custom-chart-debug-page.md

@@ -40,8 +40,8 @@ Options include:
 
 To compare system vs. userspace CPU usage, select the following values under **Metric Name**:
 
-+ `sys.cpu.sys.percent`
-+ `sys.cpu.user.percent`
+- `sys.cpu.sys.percent`
+- `sys.cpu.user.percent`
 
 The Y-axis label is the **Count**. A count of 1 represents 100% utilization. The **Aggregator** of **Sum** can show the count to be above 1, which would mean CPU utilization is greater than 100%.
 
@@ -57,6 +57,6 @@ This list is taken directly from the source code and is subject to change. Some
 
 ## See also
 
-+ [Troubleshooting Overview](troubleshooting-overview.html)
-+ [Support Resources](support-resources.html)
-+ [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-databases-page.md

@@ -30,3 +30,9 @@ The **Grants** view shows the [privileges](privileges.html) granted to users for
 For more details about grants and privileges, see [Grants](grant.html).
 
 <img src="{{ 'images/v2.1/admin_ui_database_grants_view.png' | relative_url }}" alt="CockroachDB Admin UI Database Grants View" style="border:1px solid #eee;max-width:100%" />
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-jobs-page.md

@@ -24,3 +24,9 @@ Filter By | Description
 Job Status | From the **Status** menu, select the required status filter.
 Job Type | From the **Type** menu, select **Backups**, **Restores**, **Imports**, or **Schema Changes**.
 Jobs Shown | From the **Show** menu, select **First 50** or **All**.
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-overview-dashboard.md

@@ -40,7 +40,9 @@ Ranges are subsets of your data, which are replicated to ensure survivability. R
 
 For details about how to control the number and location of replicas, see [Configure Replication Zones](configure-replication-zones.html).
 
-{{site.data.alerts.callout_info}}The timeseries data used to power the graphs in the Admin UI is stored within the cluster and accumulates for 30 days before it starts getting truncated. As a result, for the first 30 days or so of a cluster's life, you will see a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster yourself. For more details, see this <a href="operational-faqs.html#why-is-disk-usage-increasing-despite-lack-of-writes">FAQ</a>.{{site.data.alerts.end}}
+{{site.data.alerts.callout_info}}
+The timeseries data used to power the graphs in the Admin UI is stored within the cluster and accumulates for 30 days before it starts getting truncated. As a result, for the first 30 days or so of a cluster's life, you will see a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster yourself. For more details, see this [FAQ](operational-faqs.html#why-is-disk-usage-increasing-despite-lack-of-writes).
+{{site.data.alerts.end}}
 
 ## Capacity
 
@@ -63,3 +65,9 @@ Used | Disk space used by the data in the CockroachDB store. Note that this valu
 {{site.data.alerts.callout_info}}
 {% include available-capacity-metric.md %}
 {{site.data.alerts.end}}
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-overview.md

@@ -25,4 +25,12 @@ Area | Description
 
 The Admin UI also provides details about the way data is **Distributed**, the state of specific **Queues**, and metrics for **Slow Queries**, but these details are largely internal and intended for use by CockroachDB developers.
 
-{{site.data.alerts.callout_info}}By default, the Admin UI shares anonymous usage details with Cockroach Labs. For information about the details shared and how to opt-out of reporting, see <a href="diagnostics-reporting.html">Diagnostics Reporting</a>.{{site.data.alerts.end}}
+{{site.data.alerts.callout_info}}
+By default, the Admin UI shares anonymous usage details with Cockroach Labs. For information about the details shared and how to opt-out of reporting, see [Diagnostics Reporting](diagnostics-reporting.html).
+{{site.data.alerts.end}}
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-replication-dashboard.md

@@ -90,3 +90,9 @@ The **Replication** dashboard shows other time series graphs that are important
 - Range Operations
 
 For monitoring CockroachDB, it is sufficient to use the [**Ranges**](#ranges), [**Replicas per Store**](#replicas-per-store), and [**Replica Quiescence**](#replica-quiescence) graphs.
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-runtime-dashboard.md

@@ -68,3 +68,9 @@ The **Runtime** dashboard shows other time series graphs that are important for
 - GC Pause Time
 
 For monitoring CockroachDB, it is sufficient to use the [**Live Node Count**](#live-node-count), [**Memory Usage**](#memory-usage), [**CPU Time**](#cpu-time), and [**Clock Offset**](#clock-offset) graphs.
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)

v2.1/admin-ui-sql-dashboard.md

@@ -67,3 +67,9 @@ The **SQL** dashboard shows other time series graphs that are important for Cock
 - Schema Changes
 
 For monitoring CockroachDB, it is sufficient to use the [**SQL Connections**](#sql-connections), [**SQL Byte Traffic**](#sql-byte-traffic), [**SQL Queries**](#sql-queries), [**Service Latency**](#service-latency), and [**Transactions**](#transactions) graphs.
+
+## See also
+
+- [Troubleshooting Overview](troubleshooting-overview.html)
+- [Support Resources](support-resources.html)
+- [Raw Status Endpoints](monitoring-and-alerting.html#raw-status-endpoints)