[WIP] Docs updates for new tiers #18318
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Updated the product name variables * trial variable update * Add debug message for context, fix Bash nit * Minor edit on Create Your Cluster node choice and example link * Fixed nit * Fix build script * adding the old variables back for now * Update src/current/cockroachcloud/create-your-cluster.md Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com> * Fixed nit * Update src/current/netlify/build.sh Co-authored-by: Mike Lewis <76072290+mikeCRL@users.noreply.github.com> --------- Co-authored-by: Matt Linville <linville@cockroachlabs.com> Co-authored-by: mikeCRL <mike@cockroachlabs.com> Co-authored-by: Mike Lewis <76072290+mikeCRL@users.noreply.github.com>
Amruta-Ranade
changed the title
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ 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 site configuration. |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
… for Standard clusters (#18241) * Created Export Metrics Standard page, (1) replaced site.data.products.dedicated with site.data.products.standard. (2) replaced instances of nodes with regions. (3) removed repetition in intro sentence for Datadog. (4) modified 2 steps for enabling AWS Cloudwatch. * In sidebar, added link to Export Metrics Standard page.
… Advanced (#18327) * Content and link updates * updated content * Apply suggestions from code review Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com> * Fix broken links after file renames * Apply suggestions from code review Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com> * Updated cloud release notes --------- Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com>
Amruta-Ranade
changed the title
…rics export (#18329) * renamed export-metrics.md to export-metrics-advanced.md * renamed export-metrics-standard.md to export-metrics.md * In Export Metrics for Standard page, added Prometheus scrape sections. * In Export Metrics for Standard page, in Prometheus section removed mention of nodes and added note that an active workload must be running. * incorporated rmloveland feedback
* File renames, redirects, link updates, and trivial content updates * more link updates * Fixed broken links * partially updated the sidebar nav * Fixed broken links * Apply suggestions from code review Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com> --------- Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com>
… Essential Metrics (#18339) * (1) In export-metrics-advanced.md, replaced dedicated variable with advanced and fixed/added links. (2) In tools-page.md, in header replaced dedicated variable with cloud. (3) In export-metrics.md, fixed/added links. (4) In other files, fixed links to export-metrics, export-metrics-advanced and tools-page. * (1) In essential-metrics.md include file, replaced (a) 66 instances of include.deployment == dedicated with include.deployment == advanced, (b) 11 instances of crdb_dedicated with crdb_cloud, (c) KEPT 11 instances of cockroach_dedicated in https://docs.datadoghq.com/integrations/cockroachdb_dedicated. (2) Renamed essential-metrics-dedicated.md to essential-metrics-advanced.md. (3) In other files, fixed links to essential-metrics-advanced.
* Initial content cleanup * Updated links for connect to cluster docs * Initial cleanup for planning docs * more content and link updates * removed commented content * Removed region limitation * Update src/current/cockroachcloud/connect-to-an-advanced-cluster.md * Apply suggestions from code review Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com> --------- Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com>
…and v23.2, replaced site.data.products.serverless with site.data.products.standard in include files. (#18342)
(1) In cluster-overview-page.md, (a) replaced Serverless with Standard/Basic, (b) replaced Dedicated with Advanced, (c) replaced Dedicated Advanced with Advanced with Security add-on. (2) In production-checklist.md, in PCI ready section (a) replaced Dedicated Advanced with Advanced with Security add-on, (b) fixed link. (3) In authorization.md, fixed link. (4) In alerts-page.md, (a) replaced Serverless with Standard/Basic, (b) replaced Dedicated with Advanced, (c) fixed link. (5) In tools-page.md, (a) replaced dedicated with standard and/or advanced, (b) replaced dedicated with cloud, (c) replaced CockroachDB Dedicated Overview dashboard with CockroachDB Cloud Standard and CockroachDB Cloud Advanced dashboards, (d) specified where advanced only, and (e) replaced crdb_dedicated with crdb_cloud. (6) In monitoring-and-alerting.md, (a) replaced dedicated with standard and advanced, (b) moved sentence for clarity. (7) In common-issues-to-monitor.md, (a) replaced dedicated with advanced, (b) updated link format. (8) In ui-overview.md, (a) replaced dedicated with advanced, (b) fixed typo.
(1) In monitor-cockroachdb-with-prometheus.md, (a) added/modified tip for CockroachDB Cloud integration with Prometheus with links to Export Metrics Standard and Advanced. (2) In export-metrics.md, (a) replaced standard with cloud in Datadog link. (3) In export-metrics-advanced.md, (a) replaced advanced with cloud in Datadog link, (b) simplified Datadog intro sentences to remove redundancy. (4) In datadog.md, replaced dedicated with cloud and fixed link format. (5) In kibana.md, replaced dedicated with standard/advanced and fixed link format. (6) In v23.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md, replaced dedicated with standard/advanced and fixed link format. (7) In third-party-monitoring-tools.md, (a) replaced dedicated rows with standard/advanced rows, (b) fixed link format, (c) removed CockroachDB in CockroachDB Deployment column, (d) added rows for Prometheus Platform for standard, advanced, and self-hosted deployments, (e) re-organized with availability matrix and platform sections, (f) added section for GCP Logging Platform.
* update migrations docs for Cloud 2.0
* prod checklist updates * fixed nits * fixing broken links * Apply suggestions from code review Co-authored-by: Kathryn Hancox <44557882+kathancox@users.noreply.github.com> --------- Co-authored-by: Kathryn Hancox <44557882+kathancox@users.noreply.github.com>
* Updated the upgrade docs for Cloud 2.0 * Apply suggestions from code review Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com> * fixing broken links * Apply suggestions from code review Co-authored-by: Kathryn Hancox <44557882+kathancox@users.noreply.github.com> * fixed nit --------- Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com> Co-authored-by: Kathryn Hancox <44557882+kathancox@users.noreply.github.com>
…8431) In metrics.md, (a) added Available on SQL tab for Standard, (b) corrected reference to Amazon CloudWatch.
* Updated quickstart guides for Cloud 2.0 * removed extra config file * Revert "removed extra config file" This reverts commit 4ea84c8. * fixing config file * Worked on feedback
…rverless clusters (#18425) (1) Added export-logs-advanced.md copied from export-logs.md. (2) In sidebar-data/cloud-deployments.json, (a) updated links from Dedicated to Standard, (b) added link to Advanced. (3) In export-logs-advanced.md, (a) replaced dedicated with advanced, (b) fixed organization information link, (c) fixed reference to step 7 arn, (d) corrected references to Amazon CloudWatch. (4) In export-logs.md, (a) replaced dedicated with standard, (b) modified AWS Cloudwatch steps 3 and 4 for standard, (c) removed references to nodes, (d) fixed organization information link, (e) modified GCP Logging steps for standard, (f) corrected references to Amazon CloudWatch. (5) In third-party-monitoring-tools.md, (a) fixed links to export-logs-advanced.md, (b) corrected references to Amazon CloudWatch. (6) Added filter-tabs/export-logs.md include file. (7) incorporated Ryan’s feedback.
…8432) (1) In cloud-deployments.json, replaced link with resource-usage-basic.html. (2) Added filter-tabs/resource-usage.md include file. (3) Added resource-usage-basic.md, (a) copied from resource-usage.md, (b) removed references to standard, (c) removed standard sections. (4) In resource-usage.md, (a) removed references to basic, (c) removed basic sections. (5) incorporated Ryan’s feedback.
* Updated 24.1 develop docs * Updated 23.2 and some 24.1 develop docs * Updated 23.1 develop docs + nits * remove blank space * fixed nit * trying to fix build fail * trying to fix build fail * still trying to fix the build fail
* Updated connect to a database docs * Updated connection pooling docs * Updated the troubleshooting cloud doc * Update src/current/cockroachcloud/troubleshooting-page.md Co-authored-by: Kathryn Hancox <44557882+kathancox@users.noreply.github.com> --------- Co-authored-by: Kathryn Hancox <44557882+kathancox@users.noreply.github.com>
* In tools-page.md, (a) added links to Export Metrics for Standard and Advanced, (b) added link to Differences in Metrics between Third-Party Monitoring Integrations and DB Console, (c) clarified that DB Console is only for Advanced, (d) added section for Amazon CloudWatch, (e) changed Datadog Dashboards to reference Serverless and Dedicated. * incorporated Kevin’s feedback. * incorporated Ryan’s feedback.
…(on cloud-2.0 branch) (#18456) * In export-logs-advanced.md, listed the roles a service account needs. * incorporated Ryan and Matt’s feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cloud 2.0 Docs updates