docs: sort feature section alphabetically (datahub-project#10400)

acryldata · May 13, 2024 · 3dc5326 · 3dc5326
1 parent b8b7928
commit 3dc5326
Show file tree

Hide file tree

Showing 16 changed files with 134 additions and 71 deletions.
diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js
@@ -43,75 +43,138 @@ module.exports = {
         description: "Learn about the features of DataHub.",
       },
       items: [
-        "docs/ui-ingestion",
-        "docs/how/search",
-        "docs/schema-history",
         // "docs/how/ui-tabs-guide",
-        "docs/domains",
-        "docs/dataproducts",
-        "docs/glossary/business-glossary",
-        "docs/tags",
-        "docs/ownership/ownership-types",
-        "docs/authorization/access-policies-guide",
-        "docs/features/dataset-usage-and-query-history",
-        "docs/posts",
-        "docs/sync-status",
-        "docs/incidents/incidents",
-        "docs/generated/lineage/lineage-feature-guide",
-        "docs/businessattributes",
         {
+          label: "Assertions",
+          type: "category",
+          link: { type: "doc", id: "docs/managed-datahub/observe/assertions" },
+          items: [
+            {
+              label: "Column Assertions",
+              type: "doc",
+              id: "docs/managed-datahub/observe/column-assertions",
+              className: "saasOnly",
+            },
+            {
+              label: "Custom SQL Assertions",
+              type: "doc",
+              id: "docs/managed-datahub/observe/custom-sql-assertions",
+              className: "saasOnly",
+            },
+            {
+              label: "Freshness Assertions",
+              type: "doc",
+              id: "docs/managed-datahub/observe/freshness-assertions",
+              className: "saasOnly",
+            },
+            {
+              label: "Volume Assertions",
+              type: "doc",
+              id: "docs/managed-datahub/observe/volume-assertions",
+              className: "saasOnly",
+            },
+          ],
+        },
+        {
+          label: "Business Attributes",
           type: "doc",
-          id: "docs/tests/metadata-tests",
-          className: "saasOnly",
+          id: "docs/businessattributes",
+        },
+        {
+          label: "Business Glossary",
+          type: "doc",
+          id: "docs/glossary/business-glossary",
+        },
+        {
+          label: "Data Contract",
+          type: "doc",
+          id: "docs/managed-datahub/observe/data-contract",
+        },
+        {
+          label: "Data Products",
+          type: "doc",
+          id: "docs/dataproducts",
+        },
+        {
+          label: "Dataset Usage and Query History",
+          type: "doc",
+          id: "docs/features/dataset-usage-and-query-history",
+        },
+        {
+          label: "Domains",
+          type: "doc",
+          id: "docs/domains",
+        },
+        {
+          label: "Incidents",
+          type: "doc",
+          id: "docs/incidents/incidents",
+        },
+        {
+          label: "Ingestion",
+          type: "doc",
+          id: "docs/ui-ingestion",
         },
-        "docs/act-on-metadata/impact-analysis",
         {
-          label: "Observability",
+          label: "Lineage",
           type: "category",
+          link: {
+            type: "doc",
+            id: "docs/generated/lineage/lineage-feature-guide",
+          },
           items: [
             {
-              label: "Assertions",
-              type: "category",
-              link: {
-                type: "doc",
-                id: "docs/managed-datahub/observe/assertions",
-              },
-              items: [
-                {
-                  type: "doc",
-                  id: "docs/managed-datahub/observe/freshness-assertions",
-                  className: "saasOnly",
-                },
-                {
-                  type: "doc",
-                  id: "docs/managed-datahub/observe/volume-assertions",
-                  className: "saasOnly",
-                },
-                {
-                  type: "doc",
-                  id: "docs/managed-datahub/observe/custom-sql-assertions",
-                  className: "saasOnly",
-                },
-                {
-                  type: "doc",
-                  id: "docs/managed-datahub/observe/column-assertions",
-                  className: "saasOnly",
-                },
-                {
-                  type: "doc",
-                  id: "docs/managed-datahub/observe/schema-assertions",
-                  className: "saasOnly",
-                },
-              ],
+              label: "Lineage Impact analysis",
+              type: "doc",
+              id: "docs/act-on-metadata/impact-analysis",
             },
             {
+              label: "Managing Lineage via UI",
               type: "doc",
-              id: "docs/managed-datahub/observe/data-contract",
+              id: "docs/features/feature-guides/ui-lineage",
             },
           ],
         },
         {
-          Guides: ["docs/features/feature-guides/ui-lineage"],
+          label: "Metadata Tests",
+          type: "doc",
+          id: "docs/tests/metadata-tests",
+          className: "saasOnly",
+        },
+        {
+          label: "Ownership",
+          type: "doc",
+          id: "docs/ownership/ownership-types",
+        },
+        {
+          label: "Policies",
+          type: "doc",
+          id: "docs/authorization/access-policies-guide",
+        },
+        {
+          label: "Posts",
+          type: "doc",
+          id: "docs/posts",
+        },
+        {
+          label: "Schema history",
+          type: "doc",
+          id: "docs/schema-history",
+        },
+        {
+          label: "Search",
+          type: "doc",
+          id: "docs/how/search",
+        },
+        {
+          label: "Sync Status",
+          type: "doc",
+          id: "docs/sync-status",
+        },
+        {
+          label: "Tags",
+          type: "doc",
+          id: "docs/tags",
         },
       ],
     },

diff --git a/docs/_feature-guide-template.md b/docs/_feature-guide-template.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub [Feature Name]
+# [Feature Name]
 
 <!-- All Feature Guides should begin with `About DataHub ` to improve SEO -->
 

diff --git a/docs/act-on-metadata/impact-analysis.md b/docs/act-on-metadata/impact-analysis.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Lineage Impact Analysis
+# Lineage Impact Analysis
 
 <FeatureAvailability/>
 

diff --git a/docs/authentication/personal-access-tokens.md b/docs/authentication/personal-access-tokens.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Personal Access Tokens
+# Personal Access Tokens
 
 <FeatureAvailability/>
 

diff --git a/docs/authorization/access-policies-guide.md b/docs/authorization/access-policies-guide.md
@@ -1,4 +1,4 @@
-# About DataHub Access Policies
+# Access Policies
 
 <FeatureAvailability/>
 

diff --git a/docs/authorization/roles.md b/docs/authorization/roles.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Roles
+# Roles
 
 <FeatureAvailability/>
 

diff --git a/docs/domains.md b/docs/domains.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Domains
+# Domains
 
 <FeatureAvailability/>
 

diff --git a/docs/features/dataset-usage-and-query-history.md b/docs/features/dataset-usage-and-query-history.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Dataset Usage & Query History
+# Dataset Usage & Query History
 
 <FeatureAvailability/>
 

diff --git a/docs/glossary/business-glossary.md b/docs/glossary/business-glossary.md
@@ -4,7 +4,7 @@ title: Business Glossary
 
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Business Glossary
+# Business Glossary
 
 <FeatureAvailability/>
 

diff --git a/docs/how/search.md b/docs/how/search.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Search
+# Search
 
 <FeatureAvailability/>
 

diff --git a/docs/incidents/incidents.md b/docs/incidents/incidents.md
@@ -4,7 +4,7 @@ description: This page provides an overview of working with the DataHub Incident
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
 
-# About Incidents
+# Incidents
 
 <FeatureAvailability/>
 
@@ -14,8 +14,8 @@ import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
 A couple scenarios in which incidents can be useful are
 
-1**Communicating Assets with Ongoing Issues**: You can mark a known-bad data asset as under an ongoing incident so consumers and stakeholders can be informed about the health status of a data asset via the DataHub UI. Moreover, they can follow the incident as it progresses toward resolution.
-2**Pipeline Circuit Breaking (advanced):** You can use Incidents as a basis for orchestrating and blocking data pipelines that have inputs with active issues to avoid propagating bad data downstream.
+1. **Communicating Assets with Ongoing Issues**: You can mark a known-bad data asset as under an ongoing incident so consumers and stakeholders can be informed about the health status of a data asset via the DataHub UI. Moreover, they can follow the incident as it progresses toward resolution.
+2. **Pipeline Circuit Breaking (advanced):** You can use Incidents as a basis for orchestrating and blocking data pipelines that have inputs with active issues to avoid propagating bad data downstream.
 
 In the next section, we'll walk through how to
 

diff --git a/docs/managed-datahub/approval-workflows.md b/docs/managed-datahub/approval-workflows.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Approval Workflows
+# Approval Workflows
 
 <FeatureAvailability saasOnly />
 

diff --git a/docs/posts.md b/docs/posts.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Posts
+# Posts
 
 <FeatureAvailability/>
 DataHub allows users to make Posts that can be displayed on the app. Currently, Posts are only supported on the Home Page, but may be extended to other surfaces of the app in the future. Posts can be used to accomplish the following:

diff --git a/docs/schema-history.md b/docs/schema-history.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Schema History
+# Schema History
 
 <FeatureAvailability/>
 

diff --git a/docs/sync-status.md b/docs/sync-status.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Sync Status
+# Sync Status
 
 <FeatureAvailability/>
 

diff --git a/docs/tags.md b/docs/tags.md
@@ -1,6 +1,6 @@
 import FeatureAvailability from '@site/src/components/FeatureAvailability';
 
-# About DataHub Tags
+# Tags
 
 <FeatureAvailability/>