docs changes (open-metadata#14267)

MrVinegar · Dec 12, 2023 · cea0a15 · cea0a15
1 parent c90132f
commit cea0a15
Show file tree

Hide file tree

Showing 64 changed files with 312 additions and 370 deletions.
diff --git a/...-to-guides/feature-configurations/bots.md → .../v1.0.x/how-to-guides/admin-guide/bots.md b/...-to-guides/feature-configurations/bots.md → .../v1.0.x/how-to-guides/admin-guide/bots.md
@@ -1,6 +1,6 @@
 ---
 title: How to set up bots
-slug: /how-to-guides/feature-configurations/bots
+slug: /how-to-guides/admin-guide/bots
 ---
 
 # How to set up bots when SSO is configured

diff --git a/...es/cli-ingestion-with-basic-auth/index.md → ...in-guide/cli-ingestion-with-basic-auth.md b/...es/cli-ingestion-with-basic-auth/index.md → ...in-guide/cli-ingestion-with-basic-auth.md
@@ -1,6 +1,6 @@
 ---
 title: How To Run Ingestion Pipeline Via CLI with Basic Auth
-slug: /how-to-guides/cli-ingestion-with-basic-auth
+slug: /how-to-guides/admin-guide/cli-ingestion-with-basic-auth
 ---
 
 # How To Run Ingestion Pipeline Via CLI with Basic Auth

diff --git a/...v1.0.x/how-to-guides/custom-properties.md → ...o-guides/admin-guide/custom-properties.md b/...v1.0.x/how-to-guides/custom-properties.md → ...o-guides/admin-guide/custom-properties.md
@@ -1,6 +1,6 @@
 ---
-title: How to add a custom property to an entity
-slug: /how-to-guides/how-to-add-custom-property-to-an-entity
+title: How to Add a Custom Property to an Entity
+slug: /how-to-guides/admin-guide/how-to-add-custom-property-to-an-entity
 ---
 
 # How to add a custom property to an entity with API

diff --git a/...x/how-to-guides/how-to-add-custom-logo.md → ...des/admin-guide/how-to-add-custom-logo.md b/...x/how-to-guides/how-to-add-custom-logo.md → ...des/admin-guide/how-to-add-custom-logo.md
@@ -1,6 +1,6 @@
 ---
-title: How to change the Login Page and Nav Bar Logo
-slug: /how-to-guides/how-to-add-custom-logo
+title: How to Add Custom Logo
+slug: /how-to-guides/admin-guide/how-to-add-custom-logo
 ---
 
 # How to add a custom logo for the application

diff --git a/...-to-guides/how-to-add-language-support.md → ...dmin-guide/how-to-add-language-support.md b/...-to-guides/how-to-add-language-support.md → ...dmin-guide/how-to-add-language-support.md
@@ -1,6 +1,6 @@
 ---
 title: How to Add Language Support
-slug: /how-to-guides/how-to-add-language-support
+slug: /how-to-guides/admin-guide/how-to-add-language-support
 ---
 
 # How to Add Language Support

diff --git a/...-users/how-to-organise-teams-and-users.md → ...-guide/how-to-organise-teams-and-users.md b/...-users/how-to-organise-teams-and-users.md → ...-guide/how-to-organise-teams-and-users.md
@@ -1,9 +1,9 @@
 ---
-title: How To Organise Teams And users
-slug: /how-to-guides/teams-and-users/how-to-organise-teams-and-users
+title: How to Organise Teams and Users
+slug: /how-to-guides/admin-guide/how-to-organise-teams-and-users
 ---
 
-# How To Organise Teams And users
+# How To Organise Teams And Users
 
 ## Team structure in OpenMetadata
 

diff --git a/openmetadata-docs/content/v1.0.x/how-to-guides/admin-guide/index.md b/openmetadata-docs/content/v1.0.x/how-to-guides/admin-guide/index.md
@@ -0,0 +1,47 @@
+---
+title: Admin Guide
+slug: /how-to-guides/admin-guide
+---
+
+# Admin Guide
+
+Admin users have access to manage all the data assets. They can manage all the functions to create, edit, or delete. Admins can manage Roles, Policies, Services, Notifications, Custom Properties, Data Insights and more. They can add other users, or create teams to onboard users. An organization can have multiple Admins so that separate Admins can effectively manage different teams and departments.
+
+{%inlineCalloutContainer%}
+ {%inlineCallout
+  color="violet-70"
+  bold="Run Ingestion Pipeline Via CLI with Basic Auth"
+  icon="MdArrowForward"
+  href="/how-to-guides/admin-guide/cli-ingestion-with-basic-auth"%}
+ {%/inlineCallout%}
+ {%inlineCallout
+  color="violet-70"
+  bold="How to Add Custom Logo"
+  icon="MdArrowForward"
+  href="/how-to-guides/admin-guide/how-to-add-custom-logo"%}
+ {%/inlineCallout%}
+ {%inlineCallout
+  color="violet-70"
+  bold="Add a Custom Property to an Entity"
+  icon="MdArrowForward"
+  href="/how-to-guides/admin-guide/how-to-add-custom-property-to-an-entity"%}
+ {%/inlineCallout%}
+ {%inlineCallout
+  color="violet-70"
+  bold="Add Language Support"
+  icon="MdArrowForward"
+  href="/how-to-guides/admin-guide/how-to-add-language-support"%}
+ {%/inlineCallout%}
+  {%inlineCallout
+  color="violet-70"
+  bold="Organise Teams and Users"
+  icon="MdArrowForward"
+  href="/how-to-guides/admin-guide/how-to-organise-teams-and-users"%}
+ {%/inlineCallout%}
+ {%inlineCallout
+  color="violet-70"
+  bold="Bots"
+  icon="MdArrowForward"
+  href="/how-to-guides/admin-guide/bots"%}
+ {%/inlineCallout%}
+{%/inlineCalloutContainer%}
diff --git a/openmetadata-docs/content/v1.0.x/how-to-guides/feature-configurations/index.md b/openmetadata-docs/content/v1.0.x/how-to-guides/feature-configurations/index.md
diff --git a/openmetadata-docs/content/v1.0.x/how-to-guides/index.md b/openmetadata-docs/content/v1.0.x/how-to-guides/index.md
@@ -5,4 +5,21 @@ slug: /how-to-guides
 
 # How to Guides
 
-How to Guides will give you a walk through on `How to do things in OpenMetadata`.
+The How to Guides will give you a walk through on accomplishing the basic to the most advanced things in OpenMetadata. These step-by-step guides will help get an overview of the features and also help explore the various functionalities. 
+
+# Overview of OpenMetadata
+
+## What is OpenMetadata?
+
+OpenMetadata is a **unified platform for discovery, observability, and governance** powered by a central metadata repository, in-depth lineage, and seamless team collaboration. It is one of the fastest-growing open-source projects with a vibrant community and adoption by a diverse set of companies in a variety of industry verticals. Based on Open Metadata Standards and APIs, supporting connectors to a wide range of data services, OpenMetadata enables end-to-end metadata management, giving you the freedom to unlock the value of your data assets.
+
+## Quick Start Guides
+
+{% tilesContainer %}
+{% tile
+    title="Admin Guide"
+    description="Admin users can get started with OpenMetadata with just three quick and easy steps & know-it-all with the advanced guides."
+    link="/how-to-guides/admin-guide"
+    icon="administration"
+/%}
+{% /tilesContainer %}
diff --git a/openmetadata-docs/content/v1.0.x/how-to-guides/teams-and-users/index.md b/openmetadata-docs/content/v1.0.x/how-to-guides/teams-and-users/index.md
diff --git a/openmetadata-docs/content/v1.0.x/menu.md b/openmetadata-docs/content/v1.0.x/menu.md
@@ -643,22 +643,20 @@ site_menu:
     color: violet-70
     icon: openmetadata
 
-  - category: How to Guides / CLI Ingestion with basic auth
-    url: /how-to-guides/cli-ingestion-with-basic-auth
-  - category: How to Guides / Feature configurations
-    url: /how-to-guides/feature-configurations
-  - category: How to Guides / Feature configurations / Bots
-    url: /how-to-guides/feature-configurations/bots
-  - category: How to Guides / Teams and Users
-    url: /how-to-guides/teams-and-users
-  - category: How to Guides / Teams and Users / How to Organise Teams and Users
-    url: /how-to-guides/teams-and-users/how-to-organise-teams-and-users
-  - category: How to Guides / How to add a custom property to an entity
-    url: /how-to-guides/how-to-add-custom-property-to-an-entity
-  - category: How to Guides / How to add Custom Logo
-    url: /how-to-guides/how-to-add-custom-logo
-  - category: How to Guides / How to Add Language Support
-    url: /how-to-guides/how-to-add-language-support
+  - category: How to Guides / Admin Guide
+    url: /how-to-guides/admin-guide
+  - category: How to Guides / Admin Guide / CLI Ingestion with Basic Auth
+    url: /how-to-guides/admin-guide/cli-ingestion-with-basic-auth
+  - category: How to Guides / Admin Guide / How to Add Custom Logo
+    url: /how-to-guides/admin-guide/how-to-add-custom-logo
+  - category: How to Guides / Admin Guide / How to Add a Custom Property to an Entity
+    url: /how-to-guides/admin-guide/how-to-add-custom-property-to-an-entity
+  - category: How to Guides / Admin Guide / How to Add Language Support
+    url: /how-to-guides/admin-guide/how-to-add-language-support
+  - category: How to Guides / Admin Guide / How to Organise Teams and Users
+    url: /how-to-guides/admin-guide/how-to-organise-teams-and-users
+  - category: How to Guides / Admin Guide / Bots
+    url: /how-to-guides/admin-guide/bots
 
   - category: Features
     url: /features

diff --git a/...data/data-collaboration/activity-feeds.md → ...ides/data-collaboration/activity-feeds.md b/...data/data-collaboration/activity-feeds.md → ...ides/data-collaboration/activity-feeds.md
@@ -1,6 +1,6 @@
 ---
 title: Understanding Activity Feeds
-slug: /how-to-guides/openmetadata/data-collaboration/activity-feeds
+slug: /how-to-guides/data-collaboration/activity-feeds
 ---
 
 # Understanding Activity Feeds

diff --git a/...ta/data-collaboration/add-announcement.md → ...es/data-collaboration/add-announcement.md b/...ta/data-collaboration/add-announcement.md → ...es/data-collaboration/add-announcement.md
@@ -1,6 +1,6 @@
 ---
 title: How to Create an Announcement
-slug: /how-to-guides/openmetadata/data-collaboration/add-announcement
+slug: /how-to-guides/data-collaboration/add-announcement
 ---
 
 # How to Create an Announcement

diff --git a/...adata/data-collaboration/announcements.md → ...uides/data-collaboration/announcements.md b/...adata/data-collaboration/announcements.md → ...uides/data-collaboration/announcements.md
@@ -1,6 +1,6 @@
 ---
 title: Overview of Announcements
-slug: /how-to-guides/openmetadata/data-collaboration/announcements
+slug: /how-to-guides/data-collaboration/announcements
 ---
 
 # Overview of Announcements

diff --git a/.../openmetadata/data-collaboration/index.md → ...how-to-guides/data-collaboration/index.md b/.../openmetadata/data-collaboration/index.md → ...how-to-guides/data-collaboration/index.md
@@ -1,6 +1,6 @@
 ---
 title: Data Collaboration
-slug: /how-to-guides/openmetadata/data-collaboration
+slug: /how-to-guides/data-collaboration
 ---
 
 # Overview of Data Collaboration
@@ -23,7 +23,7 @@ Watch the video on how to use the collaboration features in OpenMetadata.
   color="violet-70"
   bold="Understanding Activity Feeds"
   icon="MdConnectWithoutContact"
-  href="/how-to-guides/openmetadata/data-collaboration/activity-feeds"%}
+  href="/how-to-guides/data-collaboration/activity-feeds"%}
   Learn more about the announcements in OpenMetadata
  {%/inlineCallout%}
  {%inlineCallout
@@ -44,14 +44,14 @@ Watch the video on how to use the collaboration features in OpenMetadata.
   color="violet-70"
   bold="Overview of Announcements"
   icon="MdVolumeUp"
-  href="/how-to-guides/openmetadata/data-collaboration/announcements"%}
+  href="/how-to-guides/data-collaboration/announcements"%}
   Learn more about the announcements in OpenMetadata
  {%/inlineCallout%}
  {%inlineCallout
   color="violet-70"
   bold="Create an Announcement"
   icon="MdVolumeUp"
-  href="/how-to-guides/openmetadata/data-collaboration/add-announcement"%}
+  href="/how-to-guides/data-collaboration/add-announcement"%}
   Follow the steps to add an announcement
  {%/inlineCallout%}
 {%/inlineCalloutContainer%}
diff --git a/...data-collaboration/request-description.md → ...data-collaboration/request-description.md b/...data-collaboration/request-description.md → ...data-collaboration/request-description.md
@@ -1,6 +1,6 @@
 ---
 title: Request for Description
-slug: /how-to-guides/openmetadata/data-collaboration/request-description
+slug: /how-to-guides/data-collaboration/request-description
 ---
 
 # How to Request for Description

diff --git a/...tadata/data-collaboration/request-tags.md → ...guides/data-collaboration/request-tags.md b/...tadata/data-collaboration/request-tags.md → ...guides/data-collaboration/request-tags.md
@@ -1,6 +1,6 @@
 ---
 title: How to Request for Tags
-slug: /how-to-guides/openmetadata/data-collaboration/request-tags
+slug: /how-to-guides/data-collaboration/request-tags
 ---
 
 # How to Request for Tags

diff --git a/...s/openmetadata/data-discovery/advanced.md → .../how-to-guides/data-discovery/advanced.md b/...s/openmetadata/data-discovery/advanced.md → .../how-to-guides/data-discovery/advanced.md
@@ -1,6 +1,6 @@
 ---
 title: Add Complex Queries using Advanced Search
-slug: /how-to-guides/openmetadata/data-discovery/advanced
+slug: /how-to-guides/data-discovery/advanced
 ---
 
 # Add Complex Queries using Advanced Search

diff --git a/...es/openmetadata/data-discovery/details.md → ...x/how-to-guides/data-discovery/details.md b/...es/openmetadata/data-discovery/details.md → ...x/how-to-guides/data-discovery/details.md
@@ -1,6 +1,6 @@
 ---
 title: Detailed View of the Data Assets
-slug: /how-to-guides/openmetadata/data-discovery/details
+slug: /how-to-guides/data-discovery/details
 ---
 
 # Detailed View of the Data Assets

diff --git a/...s/openmetadata/data-discovery/discover.md → .../how-to-guides/data-discovery/discover.md b/...s/openmetadata/data-discovery/discover.md → .../how-to-guides/data-discovery/discover.md
@@ -1,6 +1,6 @@
 ---
 title: How to Discover Assets of Interest
-slug: /how-to-guides/openmetadata/data-discovery/discover
+slug: /how-to-guides/data-discovery/discover
 ---
 
 # How to Discover Assets of Interest

diff --git a/...ides/openmetadata/data-discovery/index.md → ...1.x/how-to-guides/data-discovery/index.md b/...ides/openmetadata/data-discovery/index.md → ...1.x/how-to-guides/data-discovery/index.md
@@ -1,6 +1,6 @@
 ---
 title: Data Discovery
-slug: /how-to-guides/openmetadata/data-discovery
+slug: /how-to-guides/data-discovery
 ---
 
 # Overview of Data Discovery
@@ -22,28 +22,28 @@ Watch the video on how easy it is to discovery your data in OpenMetadata.
   color="violet-70"
   bold="How to Discover Assets of Interest"
   icon="MdSearch"
-  href="/how-to-guides/openmetadata/data-discovery/discover"%}
+  href="/how-to-guides/data-discovery/discover"%}
   Discover the right data assets quickly.
  {%/inlineCallout%}
  {%inlineCallout
   color="violet-70"
   bold="Get a Quick Glance of the Data Assets"
   icon="MdSearch"
-  href="/how-to-guides/openmetadata/data-discovery/preview"%}
+  href="/how-to-guides/data-discovery/preview"%}
   Quick preview of the selected data asset.
  {%/inlineCallout%}
  {%inlineCallout
   color="violet-70"
   bold="Data Asset Details"
   icon="MdSearch"
-  href="/how-to-guides/openmetadata/data-discovery/details"%}
+  href="/how-to-guides/data-discovery/details"%}
   Get a holistic view of the data assets.
  {%/inlineCallout%}
  {%inlineCallout
   color="violet-70"
   bold="Advanced Search"
   icon="MdSearch"
-  href="/how-to-guides/openmetadata/data-discovery/advanced"%}
+  href="/how-to-guides/data-discovery/advanced"%}
   Add complex queries using advanced search.
  {%/inlineCallout%}
 {%/inlineCalloutContainer%}

diff --git a/...es/openmetadata/data-discovery/preview.md → ...x/how-to-guides/data-discovery/preview.md b/...es/openmetadata/data-discovery/preview.md → ...x/how-to-guides/data-discovery/preview.md
@@ -1,6 +1,6 @@
 ---
 title: Get a Quick Glance of the Data Assets
-slug: /how-to-guides/openmetadata/data-discovery/preview
+slug: /how-to-guides/data-discovery/preview
 ---
 
 # Get a Quick Glance of the Data Assets

diff --git a/...ernance/glossary-classification/assets.md → ...ernance/glossary-classification/assets.md b/...ernance/glossary-classification/assets.md → ...ernance/glossary-classification/assets.md
@@ -1,6 +1,6 @@
 ---
 title: How to Add Assets to Glossary Terms
-slug: /how-to-guides/openmetadata/data-governance/glossary-classification/assets
+slug: /how-to-guides/data-governance/glossary-classification/assets
 ---
 
 # How to Add Assets to Glossary Terms
@@ -51,6 +51,6 @@ caption="Glossary Term and Tag gets Added to the Data Asset"
   color="violet-70"
   bold="How to Classify Data Assets"
   icon="MdArrowForward"
-  href="/how-to-guides/openmetadata/data-governance/glossary-classification/classify-assets"%}
+  href="/how-to-guides/data-governance/glossary-classification/classify-assets"%}
   Add tags to data assets, or request them and discuss about the same, all within OpenMetadata.
 {%/inlineCallout%}