20260312 doc 16273 page deletion batch 4#23109
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
…:cockroachdb/docs into 20260312-doc-16273-page-deletion-batch-4
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
LGTM overall (various mostly non-blocking comments) but i think you should bring in Biplav on this review since AFAICT the Vault stuff is a partnership and they link to our docs (see my comment elsewhere)
| <a id="replicationsource"></a>`REPLICATIONSOURCE` | Table | Grants the ability to run logical data replication from a table on the source cluster. For more details, refer to the [Set Up Logical Data Replication]({% link {{ page.version.version }}/set-up-logical-data-replication.md %}) tutorial. | ||
| `RESTORE` | System, Database | Grants the ability to restore [backups]({% link {{ page.version.version }}/backup-and-restore-overview.md %}) at the system or database level. Refer to `RESTORE` [Required privileges]({% link {{ page.version.version }}/restore.md %}#required-privileges) for more details. | ||
| `SELECT` | Table, Sequence | Grants the ability to run [selection queries]({% link {{ page.version.version }}/query-data.md %}) at the table or sequence level. | ||
| `SELECT` | Table, Sequence | Grants the ability to run selection queries at the table or sequence level. |
There was a problem hiding this comment.
we have an even better link for "selection queries"! https://www.cockroachlabs.com/docs/v26.1/selection-queries.html
| <a id="replicationsource"></a>`REPLICATIONSOURCE` | Table | Grants the ability to run logical data replication from a table on the source cluster. For more details, refer to the [Set Up Logical Data Replication]({% link {{ page.version.version }}/set-up-logical-data-replication.md %}) tutorial. | ||
| `RESTORE` | System, Database | Grants the ability to restore [backups]({% link {{ page.version.version }}/backup-and-restore-overview.md %}) at the system or database level. Refer to `RESTORE` [Required privileges]({% link {{ page.version.version }}/restore.md %}#required-privileges) for more details. | ||
| `SELECT` | Table, Sequence | Grants the ability to run [selection queries]({% link {{ page.version.version }}/query-data.md %}) at the table or sequence level. | ||
| `SELECT` | Table, Sequence | Grants the ability to run selection queries at the table or sequence level. |
There was a problem hiding this comment.
suggest making "selection queries" a link to https://www.cockroachlabs.com/docs/v26.1/selection-queries.html
|
|
||
| - As [Dynamic Secrets](https://www.vaultproject.io/use-cases/dynamic-secrets), meaning that credentials are generated and issued on demand from pre-configured templates, rather than created and persisted. Credentials are issued for specific clients and for short validity durations, further minimizing both the likelihood of a credential compromise, and the possible impact of any compromise that might occur. | ||
|
|
||
| Try the tutorial: [Using HashiCorp Vault's Dynamic Secrets for Enhanced Database Credential Security in CockroachDB]({% link {{ page.version.version }}/vault-db-secrets-tutorial.md %}) |
There was a problem hiding this comment.
suggest getting a review from @biplav-crl on the Hashicorp Vault piece of this PR, it looks like we may not be able to delete this page since we have a partnership with them where they link to our docs, e.g. https://www.hashicorp.com/en/partners/tech/cockroach-labs.
Unfortunately their partner page for us links to a very old version of our docs (v22.1) that has since been archived, so those links are all 404ing right now. We should tell them to link to a stable URL that won't break, like https://www.cockroachlabs.com/docs/stable/hashicorp-integration.html
There was a problem hiding this comment.
Thanks- reached out to Biplav
|
|
||
| For a full reference on tracking metrics with labels, refer to the [Multi-dimensional Metrics]({% link {{ page.version.version }}/multi-dimensional-metrics.md %}#clusters-with-logical-data-replication-jobs) page. | ||
|
|
||
| ### Datadog |
There was a problem hiding this comment.
i don't think this whole section should be deleted, users still need to know they can export the metrics to Datadog even if we just point them at the Datadog docs for the CockroachDB integration
| #### Fix suboptimal primary keys | ||
|
|
||
| Evaluate the schema of your table to see if you can redistribute data more evenly across multiple ranges. Specifically, make sure you have followed [best practices when selecting your primary key]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices). | ||
| Evaluate the schema of your table to see if you can redistribute data more evenly across multiple ranges. Specifically, make sure you have followed best practices when selecting your primary key. |
There was a problem hiding this comment.
suggest making "best practices when selecting your primary key" a link to https://www.cockroachlabs.com/docs/v26.1/performance-best-practices-overview.html#unique-id-best-practices
| #### Fix suboptimal primary keys | ||
|
|
||
| Evaluate the schema of your table to see if you can redistribute data more evenly across multiple ranges. Specifically, make sure you have followed [best practices when selecting your primary key]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices). | ||
| Evaluate the schema of your table to see if you can redistribute data more evenly across multiple ranges. Specifically, make sure you have followed best practices when selecting your primary key. |
There was a problem hiding this comment.
see other comment re: linking PK best practices to https://www.cockroachlabs.com/docs/v26.1/performance-best-practices-overview.html#unique-id-best-practices
|
|
||
| All CockroachDB clusters include a preloaded database named `defaultdb`. Rather than using the `defaultdb` database, we recommend creating your own database. | ||
|
|
||
| For guidance on creating databases, see [Create a Database]({% link {{ page.version.version }}/schema-design-database.md %}). |
There was a problem hiding this comment.
see other comment re: this could become a link to CREATE DATABASE docs
|
|
||
| Tables contain *rows* of data. Each value in a row of data belongs to a particular *column*. Each column allows values of data of a single data type. Columns can be further qualified with [column-level constraints]({% link {{ page.version.version }}/constraints.md %}), or computed with [scalar expressions]({% link {{ page.version.version }}/computed-columns.md %}). | ||
|
|
||
| For guidance on defining tables, see [Tables]({% link {{ page.version.version }}/schema-design-table.md %}). |
There was a problem hiding this comment.
see other comment re: this could be rephrased and link to CREATE TABLE docs
| The two main types of indexes are the primary index, an index on the row-identifying [primary key columns]({% link {{ page.version.version }}/primary-key.md %}), and the secondary index, an index created on non-primary-key columns of your choice. | ||
|
|
||
| For guidance on defining primary keys, see [Select primary key columns]({% link {{ page.version.version }}/schema-design-table.md %}#select-primary-key-columns). For guidance on defining secondary indexes, see [Secondary Indexes]({% link {{ page.version.version }}/schema-design-indexes.md %}). | ||
| For guidance on defining secondary indexes, see [Secondary Indexes]({% link {{ page.version.version }}/schema-design-indexes.md %}). |
There was a problem hiding this comment.
see other comment re: suggest re-adding the PK sentence and having it link to https://www.cockroachlabs.com/docs/v26.1/performance-best-practices-overview.html#unique-id-best-practices
|
|
||
| {{site.data.alerts.callout_success}} | ||
| You can use the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}), the SQL shell, [Metrics Export]({% link {{ page.version.version }}/datadog.md %}#enable-metrics-collection) with Prometheus and Datadog, and [labels with some LDR metrics]({% link {{ page.version.version }}/multi-dimensional-metrics.md %}) to monitor the job. | ||
| You can use the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}), the SQL shell, Metrics Export with Prometheus and Datadog, and [labels with some LDR metrics]({% link {{ page.version.version }}/multi-dimensional-metrics.md %}) to monitor the job. |
There was a problem hiding this comment.
suggest downcasing "Metrics Export"
2 participants
Fixes: DOC-16273
Deleted:
stable/topology-development.md
stable/vault-db-secrets-tutorial.md
stable/datadog.md
stable/dbmarlin.md
stable/kibana.md
stable/schema-design-database.md
stable/schema-design-schema.md
stable/schema-design-table.md
stable/schema-design-update.md
stable/query-data.md