Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adjust sidebar & create new admin section #9064

Merged
merged 16 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
212 changes: 114 additions & 98 deletions docs-website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,13 @@ module.exports = {

overviewSidebar: [
{
label: "Getting Started",
label: "What Is DataHub?",
type: "category",
collapsed: true,
link: { type: "doc", id: "docs/features" },
items: [
// By the end of this section, readers should understand the core use cases that DataHub addresses,
// target end-users, high-level architecture, & hosting options
{
type: "doc",
label: "Introduction",
id: "docs/features",
},
{
type: "doc",
label: "Quickstart",
Expand All @@ -31,7 +27,6 @@ module.exports = {
href: "https://demo.datahubproject.io/",
},
"docs/what-is-datahub/datahub-concepts",
"docs/saas",
],
},
{
Expand Down Expand Up @@ -161,7 +156,15 @@ module.exports = {
"docs/deploy/azure",
"docker/README",
"docs/deploy/kubernetes",
"docs/deploy/confluent-cloud",
"docs/deploy/environment-vars",
"docs/how/extract-container-logs",
],
},
{
type: "category",
label: "Admin",
items: [
{
Authentication: [
"docs/authentication/README",
Expand Down Expand Up @@ -195,20 +198,91 @@ module.exports = {
"docs/how/restore-indices",
"docs/advanced/db-retention",
"docs/advanced/monitoring",
"docs/how/extract-container-logs",
"docs/deploy/telemetry",
"docs/how/kafka-config",
"docs/deploy/confluent-cloud",
"docs/advanced/no-code-upgrade",
"docs/how/jattach-guide",
],
},
"docs/how/updating-datahub",
],
},
{
API: [
"docs/api/datahub-apis",
Developers: [
// The purpose of this section is to provide developers & technical users with
// concrete tutorials for how to work with the DataHub CLI & APIs
{
Architecture: [
"docs/architecture/architecture",
"docs/components",
"docs/architecture/metadata-ingestion",
"docs/architecture/metadata-serving",
"docs/architecture/docker-containers",
],
},
{
"Metadata Model": [
"docs/modeling/metadata-model",
"docs/modeling/extending-the-metadata-model",
"docs/what/mxe",
{
Entities: [
{
type: "autogenerated",
dirName: "docs/generated/metamodel/entities", // '.' means the current docs folder
},
],
},
],
},
{
"Developing on DataHub": [
"docs/developers",
"docs/docker/development",
"metadata-ingestion/developing",
"docs/api/graphql/graphql-endpoint-development",
{
Modules: [
"datahub-web-react/README",
"datahub-frontend/README",
"datahub-graphql-core/README",
"metadata-service/README",
"metadata-jobs/mae-consumer-job/README",
"metadata-jobs/mce-consumer-job/README",
],
},
],
},
"docs/plugins",
{
Troubleshooting: [
"docs/troubleshooting/quickstart",
"docs/troubleshooting/build",
"docs/troubleshooting/general",
],
},
{
Advanced: [
"metadata-ingestion/docs/dev_guides/reporting_telemetry",
"docs/advanced/mcp-mcl",
"docker/datahub-upgrade/README",
"docs/advanced/no-code-modeling",
"datahub-web-react/src/app/analytics/README",
"docs/how/migrating-graph-service-implementation",
"docs/advanced/field-path-spec-v2",
"metadata-ingestion/adding-source",
"docs/how/add-custom-ingestion-source",
"docs/how/add-custom-data-platform",
"docs/advanced/browse-paths-upgrade",
"docs/browseV2/browse-paths-v2",
],
},
],
},
{
type: "category",
label: "API",
link: { type: "doc", id: "docs/api/datahub-apis" },
items: [
{
"GraphQL API": [
{
Expand Down Expand Up @@ -466,91 +540,14 @@ module.exports = {
],
},
{
Develop: [
// The purpose of this section is to provide developers & technical users with
// concrete tutorials for how to work with the DataHub CLI & APIs
{
"DataHub Metadata Model": [
"docs/modeling/metadata-model",
"docs/modeling/extending-the-metadata-model",
"docs/what/mxe",
{
Entities: [
{
type: "autogenerated",
dirName: "docs/generated/metamodel/entities", // '.' means the current docs folder
},
],
},
],
},
{
Architecture: [
"docs/architecture/architecture",
"docs/components",
"docs/architecture/metadata-ingestion",
"docs/architecture/metadata-serving",
"docs/architecture/docker-containers",
],
},
{
"Developing on DataHub": [
"docs/developers",
"docs/docker/development",
"metadata-ingestion/developing",
"docs/api/graphql/graphql-endpoint-development",
{
Modules: [
"datahub-web-react/README",
"datahub-frontend/README",
"datahub-graphql-core/README",
"metadata-service/README",
"metadata-jobs/mae-consumer-job/README",
"metadata-jobs/mce-consumer-job/README",
],
},
],
},
"docs/plugins",
{
Troubleshooting: [
"docs/troubleshooting/quickstart",
"docs/troubleshooting/build",
"docs/troubleshooting/general",
],
},
{
Advanced: [
"metadata-ingestion/docs/dev_guides/reporting_telemetry",
"docs/advanced/mcp-mcl",
"docker/datahub-upgrade/README",
"docs/advanced/no-code-modeling",
"datahub-web-react/src/app/analytics/README",
"docs/how/migrating-graph-service-implementation",
"docs/advanced/field-path-spec-v2",
"metadata-ingestion/adding-source",
"docs/how/add-custom-ingestion-source",
"docs/how/add-custom-data-platform",
"docs/advanced/browse-paths-upgrade",
"docs/browseV2/browse-paths-v2",
],
},
],
},
{
Community: [
"docs/slack",
"docs/townhalls",
"docs/townhall-history",
"docs/CODE_OF_CONDUCT",
"docs/CONTRIBUTING",
"docs/links",
"docs/rfc",
],
},
{
"Managed DataHub": [
"docs/managed-datahub/managed-datahub-overview",
label: "Managed DataHub",
type: "category",
collapsed: true,
link: {
type: "doc",
id: "docs/managed-datahub/managed-datahub-overview",
},
items: [
"docs/managed-datahub/welcome-acryl",
{
type: "doc",
Expand Down Expand Up @@ -647,7 +644,26 @@ module.exports = {
],
},
{
"Release History": ["releases"],
label: "Community",
type: "category",
collapsed: true,
link: {
type: "generated-index",
title: "Community",
description: "Learn about DataHub community.",
},
items: [
"docs/slack",
"docs/townhalls",
// "docs/townhall-history",
"docs/CODE_OF_CONDUCT",
"docs/CONTRIBUTING",
"docs/links",
"docs/rfc",
],
},
{
"Release History": ["releases", "docs/how/updating-datahub"],
},

// "Candidates for Deprecation": [
Expand Down
2 changes: 1 addition & 1 deletion docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributor Covenant Code of Conduct
# Code of Conduct

## Our Pledge

Expand Down
14 changes: 0 additions & 14 deletions docs/saas.md

This file was deleted.

Loading
Loading