Rework sidenav / page titles to better match (#17607)

* Rework sidenav / page titles to better match Closes DOC-8393 * Fix code format * Edits based on feedback
cockroachdb · Aug 8, 2023 · de8029c · de8029c
1 parent 9e3b26f
commit de8029c
Show file tree

Hide file tree

Showing 75 changed files with 154 additions and 154 deletions.
diff --git a/src/current/_includes/sidebar-all-releases.json b/src/current/_includes/sidebar-all-releases.json
@@ -1,7 +1,7 @@
 {%- assign versions = site.data.versions | where_exp: "versions", "versions.major_version != site.versions['dev']" | where_exp: "versions", "versions.major_version != site.versions['stable']" | map: "major_version" -%}
 {%- comment -%} versions iterates through the list of major versions (e.g., v21.2) in _data/versions.csv and returns all releases that are not dev or stable. We then pull only the major version name instead of the whole dictionary with map: "major_version" {%- endcomment -%}
 {
-  "title": "All CockroachDB Releases",
+  "title": "CockroachDB Releases",
   "urls": [
     "/releases/index.html",
     "/releases/"

diff --git a/src/current/_includes/sidebar-data-v23.1.json b/src/current/_includes/sidebar-data-v23.1.json
@@ -22,6 +22,6 @@
   {% include_cached v23.1/sidebar-data/sql.json %},
   {% include_cached v23.1/sidebar-data/reference.json %},
   {% include_cached v23.1/sidebar-data/faqs.json %},
-  {% include_cached v23.1/sidebar-data/all-releases.json %},
+  {% include_cached v23.1/sidebar-data/releases.json %},
   {% include_cached sidebar-data-cockroach-university.json %}
 ]
diff --git a/src/current/_includes/v23.1/prod-deployment/use-cluster.md b/src/current/_includes/v23.1/prod-deployment/use-cluster.md
@@ -5,7 +5,7 @@ Now that your deployment is working, you can:
 1. [Connect your application](install-client-drivers.html). Be sure to connect your application to the load balancer, not to a CockroachDB node.
 1. [Take backups](take-full-and-incremental-backups.html) of your data.
 
-You may also want to adjust the way the cluster replicates data. For example, by default, a multi-node cluster replicates all data 3 times; you can change this replication factor or create additional rules for replicating individual databases and tables differently. For more information, see [Configure Replication Zones](configure-replication-zones.html).
+You may also want to adjust the way the cluster replicates data. For example, by default, a multi-node cluster replicates all data 3 times; you can change this replication factor or create additional rules for replicating individual databases and tables differently. For more information, see [Replication Controls](configure-replication-zones.html).
 
 {{site.data.alerts.callout_danger}}
 When running a cluster of 5 nodes or more, it's safest to [increase the replication factor for important internal data](configure-replication-zones.html#create-a-replication-zone-for-a-system-range) to 5, even if you do not do so for user data. For the cluster as a whole to remain available, the ranges for this internal data must always retain a majority of their replicas.

diff --git a/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json b/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json
@@ -24,7 +24,7 @@
                 ]
             },
             {
-                "title": "Create a CockroachDB Serverless Cluster",
+                "title": "Create a Serverless Cluster",
                 "urls": [
                     "/cockroachcloud/create-a-serverless-cluster.html"
                 ]
@@ -54,7 +54,7 @@
                 ]
             },
             {
-                "title": "Optimize Your CockroachDB Serverless Workload",
+                "title": "Optimize Your Serverless Workload",
                 "urls": [
                     "/cockroachcloud/optimize-serverless-workload.html"
                 ]
@@ -163,7 +163,7 @@
             "title": "Compliance",
             "items": [
                 {
-                    "title": "CockroachDB Dedicated Compliance Overview",
+                    "title": "Compliance in Dedicated",
                     "urls": [
                       "/cockroachcloud/compliance.html"
                     ]
@@ -180,13 +180,13 @@
             "title": "Authentication",
                 "items": [
                     {
-                        "title": "Authentication Overview",
+                        "title": "Overview",
                         "urls": [
                             "/cockroachcloud/authentication.html"
                         ]
                     },
                     {
-                        "title": "Single Sign-On (SSO) for CockroachDB Cloud Organizations",
+                        "title": "SSO for Cloud Organizations",
                         "urls": [
                             "/cockroachcloud/cloud-org-sso.html"
                         ]
@@ -204,13 +204,13 @@
                         ]
                     },
                     {
-                        "title": "Cluster Single Sign-On (SSO) using CockroachDB Cloud Console",
+                        "title": "Cluster SSO using the Cloud Console",
                         "urls": [
                         "/cockroachcloud/cloud-sso-sql.html"
                         ]
                     },
                     {
-                        "title": "Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters",
+                        "title": "Certificate Authentication for SQL Clients in Dedicated Clusters",
                         "urls": [
                         "/cockroachcloud/client-certs-dedicated.html"
                         ]
@@ -221,7 +221,7 @@
                 "title": "Authorization",
                 "items": [
                     {
-                        "title": "Authorization Overview",
+                        "title": "Overview",
                         "urls": [
                             "/cockroachcloud/authorization.html"
                         ]
@@ -273,7 +273,7 @@
                         ]
                     },
                     {
-                        "title": "Export Logs From {{ site.data.products.dedicated }}",
+                        "title": "Export Logs From Dedicated",
                         "urls": [
                         "/cockroachcloud/export-logs.html"
                         ]
@@ -284,7 +284,7 @@
                 "title": "Security Tutorials",
                 "items": [
                     {
-                        "title": "Configure SQL Authentication for Hardened Serverless Cluster Security",
+                        "title": "Configure SQL Authentication",
                         "urls": [
                             "/${VERSION}/security-reference/config-secure-hba.html"
                         ]
@@ -321,7 +321,7 @@
                     ]
                   },
                   {
-                    "title": "Monitoring Page",
+                    "title": "Tools Page",
                     "urls": [
                       "/cockroachcloud/tools-page.html"
                     ]
@@ -374,7 +374,7 @@
                     ]
                   },
                   {
-                    "title": "Export Metrics From a {{ site.data.products.dedicated }} Cluster",
+                    "title": "Export Metrics From a Dedicated Cluster",
                     "urls": [
                       "/cockroachcloud/export-metrics.html"
                     ]
@@ -399,7 +399,7 @@
                 ]
               },
               {
-                "title": "CockroachDB Cloud Billing",
+                "title": "Billing Management",
                 "urls": [
                    "/cockroachcloud/billing-management.html"
                 ]

diff --git a/src/current/_includes/v23.1/sidebar-data/connect-to-cockroachdb.json b/src/current/_includes/v23.1/sidebar-data/connect-to-cockroachdb.json
@@ -21,7 +21,7 @@
             ]
           },
           {
-            "title": "Use Connection Pools",
+            "title": "Connection Pooling",
             "urls": [
               "/${VERSION}/connection-pooling.html"
             ]

diff --git a/src/current/_includes/v23.1/sidebar-data/migrate.json b/src/current/_includes/v23.1/sidebar-data/migrate.json
@@ -3,7 +3,7 @@
   "is_top_level": true,
   "items": [
     {
-      "title": "Migration Overview",
+      "title": "Overview",
       "urls": [
         "/${VERSION}/migration-overview.html"
       ]

diff --git a/src/current/_includes/v23.1/sidebar-data/reads-and-writes.json b/src/current/_includes/v23.1/sidebar-data/reads-and-writes.json
@@ -12,7 +12,7 @@
       "title": "Read Data",
       "items": [
         {
-          "title": "Select Rows of Data",
+          "title": "Query Data",
           "urls": [
             "/${VERSION}/query-data.html"
           ]
@@ -112,7 +112,7 @@
       "title": "Transactions",
       "items": [
         {
-          "title": "Transactions Overview",
+          "title": "Overview",
           "urls": [
             "/${VERSION}/transactions.html"
           ]

diff --git a/src/current/_includes/v23.1/sidebar-data/reference.json b/src/current/_includes/v23.1/sidebar-data/reference.json
@@ -12,7 +12,7 @@
         "title": "Architecture",
         "items": [
           {
-            "title": "Architecture Overview",
+            "title": "Overview",
             "urls": [
               "/${VERSION}/architecture/overview.html"
             ]
@@ -303,7 +303,7 @@
             ]
           },
           {
-            "title": "Unsupported Features in CockroachDB Serverless",
+            "title": "Unsupported Features in Serverless",
             "urls": [
               "/cockroachcloud/serverless-unsupported-features.html"
             ]
@@ -320,19 +320,19 @@
         "title": "Third-Party Support",
         "items": [
           {
-            "title": "Tools Supported by Cockroach Labs",
+            "title": "Supported Tools",
             "urls": [
               "/${VERSION}/third-party-database-tools.html"
             ]
           },
           {
-            "title": "Third-Party Monitoring Integrations",
+            "title": "Monitoring Integrations",
             "urls": [
               "/${VERSION}/third-party-monitoring-tools.html"
             ]
           },
           {
-            "title": "Tools Supported by the Community",
+            "title": "Community-supported Tools",
             "urls": [
               "/${VERSION}/community-tooling.html"
             ]
@@ -378,7 +378,7 @@
             ]
           },
           {
-            "title": "Public Key Infrastructure (PKI) and Transport Layer Security (TLS)",
+            "title": "PKI and TLS",
             "urls": [
               "/${VERSION}/security-reference/transport-layer-security.html"
             ]

diff --git a/...udes/v23.1/sidebar-data/all-releases.json → ...includes/v23.1/sidebar-data/releases.json b/...udes/v23.1/sidebar-data/all-releases.json → ...includes/v23.1/sidebar-data/releases.json
@@ -1,5 +1,5 @@
 {
-    "title": "All Releases",
+    "title": "CockroachDB Releases",
     "is_top_level": true,
     "items": [
       {% include_cached sidebar-all-releases.json %}

diff --git a/src/current/_includes/v23.1/sidebar-data/schema-design.json b/src/current/_includes/v23.1/sidebar-data/schema-design.json
@@ -32,7 +32,7 @@
         ]
       },
       {
-        "title": "Group Columns into Families",
+        "title": "Column Families",
         "urls": [
           "/${VERSION}/column-families.html"
         ]
@@ -53,43 +53,43 @@
             ]
           },
           {
-            "title": "Index a Subset of Rows",
+            "title": "Partial Indexes",
             "urls": [
               "/${VERSION}/partial-indexes.html"
             ]
           },
           {
-            "title": "Index Sequential Keys",
+            "title": "Hash-sharded Indexes",
             "urls": [
               "/${VERSION}/hash-sharded-indexes.html"
             ]
           },
           {
-            "title": "Index JSON and Array Data",
+            "title": "Generalized Inverted Indexes",
             "urls": [
               "/${VERSION}/inverted-indexes.html"
             ]
           },
           {
-            "title": "Index Full Text",
+            "title": "Full-Text Search",
             "urls": [
               "/${VERSION}/full-text-search.html"
             ]
           },
           {
-            "title": "Index Trigrams",
+            "title": "Trigram Indexes",
             "urls": [
               "/${VERSION}/trigram-indexes.html"
             ]
           },
           {
-            "title": "Index Expressions",
+            "title": "Expression Indexes",
             "urls": [
               "/${VERSION}/expression-indexes.html"
             ]
           },
           {
-            "title": "Index Spatial Data",
+            "title": "Spatial Indexes",
             "urls": [
               "/${VERSION}/spatial-indexes.html"
             ]

diff --git a/src/current/_includes/v23.1/sidebar-data/self-hosted-deployments.json b/src/current/_includes/v23.1/sidebar-data/self-hosted-deployments.json
@@ -12,7 +12,7 @@
             "title": "Deploy Locally",
             "items": [
               {
-                "title": "Deploy From Binary",
+                "title": "Deploy from Binary",
                 "urls": [
                   "/${VERSION}/secure-a-cluster.html",
                   "/${VERSION}/start-a-local-cluster.html"
@@ -185,6 +185,18 @@
                     "/${VERSION}/topology-basic-production.html"
                     ]
                 },
+                {
+                  "title": "Follower Reads Topology",
+                  "urls": [
+                  "/${VERSION}/topology-follower-reads.html"
+                  ]
+              },
+              {
+                  "title": "Follow-the-Workload Topology",
+                  "urls": [
+                  "/${VERSION}/topology-follow-the-workload.html"
+                  ]
+              },
                 {
                     "title": "Regional Tables",
                     "urls": [
@@ -196,18 +208,6 @@
                     "urls": [
                     "/${VERSION}/global-tables.html"
                     ]
-                },
-                {
-                    "title": "Follower Reads",
-                    "urls": [
-                    "/${VERSION}/topology-follower-reads.html"
-                    ]
-                },
-                {
-                    "title": "Follow-the-Workload",
-                    "urls": [
-                    "/${VERSION}/topology-follow-the-workload.html"
-                    ]
                 }
             ] 
           },
@@ -274,13 +274,13 @@
                     ]
                   },
                   {
-                    "title": "Cluster Single Sign-on (SSO) using JSON web tokens (JWT)",
+                    "title": "Cluster SSO using JWT",
                     "urls": [
                       "/${VERSION}/sso-sql.html"
                     ]
                   },
                   {
-                    "title": "Single Sign-on (SSO) for DB Console",
+                    "title": "SSO for DB Console",
                     "urls": [
                       "/${VERSION}/sso-db-console.html"
                     ]
@@ -308,7 +308,7 @@
             "title": "Monitoring and Alerting",
             "items": [
                 {
-                    "title": "Monitoring Clusters Overview",
+                    "title": "Overview",
                     "urls": [
                       "/${VERSION}/monitoring-and-alerting.html"
                     ]
@@ -332,19 +332,19 @@
                     ]
                   },
                   {
-                    "title": "Monitor {{ site.data.products.core }} with Datadog",
+                    "title": "Monitor with Datadog",
                     "urls": [
                       "/${VERSION}/datadog.html"
                     ]
                   },
                   {
-                    "title": "Monitor {{ site.data.products.core }} with DBmarlin",
+                    "title": "Monitor with DBmarlin",
                     "urls": [
                       "/${VERSION}/dbmarlin.html"
                     ]
                   },
                   {
-                    "title": "Monitor {{ site.data.products.core }} with Kibana",
+                    "title": "Monitor with Kibana",
                     "urls": [
                       "/${VERSION}/kibana.html"
                     ]