From 3dc5326e440b2479b06fed9362da0f4c7713b635 Mon Sep 17 00:00:00 2001
From: Hyejin Yoon <0327jane@gmail.com>
Date: Tue, 14 May 2024 08:57:53 +0900
Subject: [PATCH] docs: sort feature section alphabetically (#10400)
---
docs-website/sidebars.js | 171 ++++++++++++------
docs/_feature-guide-template.md | 2 +-
docs/act-on-metadata/impact-analysis.md | 2 +-
docs/authentication/personal-access-tokens.md | 2 +-
docs/authorization/access-policies-guide.md | 2 +-
docs/authorization/roles.md | 2 +-
docs/domains.md | 2 +-
.../dataset-usage-and-query-history.md | 2 +-
docs/glossary/business-glossary.md | 2 +-
docs/how/search.md | 2 +-
docs/incidents/incidents.md | 6 +-
docs/managed-datahub/approval-workflows.md | 2 +-
docs/posts.md | 2 +-
docs/schema-history.md | 2 +-
docs/sync-status.md | 2 +-
docs/tags.md | 2 +-
16 files changed, 134 insertions(+), 71 deletions(-)
diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js
index 326bf804a3f926..64ded2f61c16f2 100644
--- 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
index 63ba258d52d0b3..9c1aead5e13ab3 100644
--- 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]
diff --git a/docs/act-on-metadata/impact-analysis.md b/docs/act-on-metadata/impact-analysis.md
index ae593d09c255f1..3dbf532b2dd842 100644
--- 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
diff --git a/docs/authentication/personal-access-tokens.md b/docs/authentication/personal-access-tokens.md
index ad81caef66f8fa..8488163d85d15a 100644
--- 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
diff --git a/docs/authorization/access-policies-guide.md b/docs/authorization/access-policies-guide.md
index b8c23b0cd79b09..a9a54a762cd815 100644
--- a/docs/authorization/access-policies-guide.md
+++ b/docs/authorization/access-policies-guide.md
@@ -1,4 +1,4 @@
-# About DataHub Access Policies
+# Access Policies
diff --git a/docs/authorization/roles.md b/docs/authorization/roles.md
index b25579072980d3..7e2f1797309df7 100644
--- 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
diff --git a/docs/domains.md b/docs/domains.md
index afaec796d55df3..98e25773870375 100644
--- a/docs/domains.md
+++ b/docs/domains.md
@@ -1,6 +1,6 @@
import FeatureAvailability from '@site/src/components/FeatureAvailability';
-# About DataHub Domains
+# Domains
diff --git a/docs/features/dataset-usage-and-query-history.md b/docs/features/dataset-usage-and-query-history.md
index 2d06b932572b7a..37cbc16cfe74f7 100644
--- 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
diff --git a/docs/glossary/business-glossary.md b/docs/glossary/business-glossary.md
index e10cbed30b9132..9c9daabcb94c7f 100644
--- 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
diff --git a/docs/how/search.md b/docs/how/search.md
index 3b50a0da7fec4a..7012f5321f2ff7 100644
--- 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
diff --git a/docs/incidents/incidents.md b/docs/incidents/incidents.md
index 5f51e421aad3b3..578571289cd2ea 100644
--- 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
@@ -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
index 3853a7c37817fd..75cab458d285d9 100644
--- 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
diff --git a/docs/posts.md b/docs/posts.md
index cdaf9d4325d0fe..c44125bbd00179 100644
--- a/docs/posts.md
+++ b/docs/posts.md
@@ -1,6 +1,6 @@
import FeatureAvailability from '@site/src/components/FeatureAvailability';
-# About DataHub Posts
+# Posts
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
index 120d041960186e..e57b550dd98a7b 100644
--- 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
diff --git a/docs/sync-status.md b/docs/sync-status.md
index a249a324e561ca..2e9fbcdb5b7bd4 100644
--- 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
diff --git a/docs/tags.md b/docs/tags.md
index f626ae79b1a0fd..880e57f8d0a4f1 100644
--- a/docs/tags.md
+++ b/docs/tags.md
@@ -1,6 +1,6 @@
import FeatureAvailability from '@site/src/components/FeatureAvailability';
-# About DataHub Tags
+# Tags