Added documentation changes done in 0.5.0 branch to main (#1168)

* GitBook: [#177] Documentation Update - Airflow * GitBook: [#195] Removing Cron from databaseServices * GitBook: [#196] Added trino * GitBook: [#197] removed cron from config * GitBook: [#198] Added Redash Documentation * GitBook: [#199] Added Bigquery Usage Documentation * GitBook: [#200] Added page link for presto * GitBook: [#201] Added Local Docker documentation * GitBook: [#202] Added Documentation for Local Docker Setup * GitBook: [#203] Added Git Command to clone Openmetadata in docs * GitBook: [#207] links update * GitBook: [#208] Updating Airflow Documentation * GitBook: [#210] Adding Python installation package under Airflow Lineage config * GitBook: [#211] Change the links to 0.5..0 * GitBook: [#213] Move buried connectors page up * GitBook: [#214] Update to connectors page * GitBook: [#215] Removed sub-categories * GitBook: [#212] Adding Discovery tutorial * GitBook: [#220] Updated steps to H2s. * GitBook: [#230] Complex queries * GitBook: [#231] Add lineage to feature overview * GitBook: [#232] Make feature overview headers verbs instead of nouns * GitBook: [#233] Add data reliability to features overview * GitBook: [#234] Add complex data types to feature overview * GitBook: [#235] Simplify and further distinguish discovery feature headers * GitBook: [#236] Add data importance to feature overview * GitBook: [#237] Break Connectors into its own section * GitBook: [#238] Reorganize first section of docs. * GitBook: [#239] Add connectors to feature overview * GitBook: [#240] Organize layout of feature overview into feature categories as agreed with Harsha. * GitBook: [#242] Make overview paragraph more descriptive. * GitBook: [#243] Create a link to Connectors section from feature overview. * GitBook: [#244] Add "discover data through association" to feature overview. * GitBook: [#245] Update importance and owners gifs * GitBook: [#246] Include a little more descriptive documentation for key features. * GitBook: [#248] Small tweaks to intro paragraph. * GitBook: [#249] Clean up data profiler paragraph. * GitBook: [#250] Promote Complex Data Types to its own feature. * GitBook: [#251] Update to advanced search * GitBook: [#252] Update Roadmap * GitBook: [#254] Remove old features page (text and screenshot based). * GitBook: [#255] Remove references to removed page. * GitBook: [#256] Add Descriptions and Tags section to feature overview. * GitBook: [#257] Update title for "Know Your Data" Co-authored-by: Ayush Shah <[email protected]> Co-authored-by: Suresh Srinivas <[email protected]> Co-authored-by: Shannon Bradshaw <[email protected]> Co-authored-by: OpenMetadata <[email protected]>
open-metadata · Nov 13, 2021 · e2578d6 · e2578d6
1 parent 4b253e0
commit e2578d6
Show file tree

Hide file tree

Showing 179 changed files with 2,578 additions and 2,120 deletions.
diff --git a/docs/.gitbook/assets/OpenMetadat-style-guide.pdf b/docs/.gitbook/assets/OpenMetadat-style-guide.pdf
diff --git a/docs/.gitbook/assets/OpenMetadata-style-guide.pdf b/docs/.gitbook/assets/OpenMetadata-style-guide.pdf
diff --git a/docs/.gitbook/assets/add-yourself.png b/docs/.gitbook/assets/add-yourself.png
diff --git a/docs/.gitbook/assets/asset-discovery-dashboards.png b/docs/.gitbook/assets/asset-discovery-dashboards.png
diff --git a/docs/.gitbook/assets/asset-discovery-features.gif b/docs/.gitbook/assets/asset-discovery-features.gif
diff --git a/docs/.gitbook/assets/asset-discovery-pipelines.png b/docs/.gitbook/assets/asset-discovery-pipelines.png
diff --git a/docs/.gitbook/assets/asset-discovery-tables.png b/docs/.gitbook/assets/asset-discovery-tables.png
diff --git a/docs/.gitbook/assets/asset-discovery-topics.png b/docs/.gitbook/assets/asset-discovery-topics.png
diff --git a/docs/.gitbook/assets/asset-importance (1).gif b/docs/.gitbook/assets/asset-importance (1).gif
diff --git a/docs/.gitbook/assets/asset-importance-owners.gif b/docs/.gitbook/assets/asset-importance-owners.gif
diff --git a/docs/.gitbook/assets/asset-importance.gif b/docs/.gitbook/assets/asset-importance.gif
diff --git a/docs/.gitbook/assets/asset-owners (1).gif b/docs/.gitbook/assets/asset-owners (1).gif
diff --git a/docs/.gitbook/assets/asset-owners.gif b/docs/.gitbook/assets/asset-owners.gif
diff --git a/docs/.gitbook/assets/assets-using-name-redshift.png b/docs/.gitbook/assets/assets-using-name-redshift.png
diff --git a/docs/.gitbook/assets/complex-data-types.gif b/docs/.gitbook/assets/complex-data-types.gif
diff --git a/docs/.gitbook/assets/complex-queries.gif b/docs/.gitbook/assets/complex-queries.gif
diff --git a/docs/.gitbook/assets/complex-query.png b/docs/.gitbook/assets/complex-query.png
diff --git a/docs/.gitbook/assets/connectors-feature.gif b/docs/.gitbook/assets/connectors-feature.gif
diff --git a/docs/.gitbook/assets/dashboards.png b/docs/.gitbook/assets/dashboards.png
diff --git a/docs/.gitbook/assets/data-profiler-feature.gif b/docs/.gitbook/assets/data-profiler-feature.gif
diff --git a/docs/.gitbook/assets/descriptions-tags.gif b/docs/.gitbook/assets/descriptions-tags.gif
diff --git a/docs/.gitbook/assets/discover-association.gif b/docs/.gitbook/assets/discover-association.gif
diff --git a/docs/.gitbook/assets/etl-description.png b/docs/.gitbook/assets/etl-description.png
diff --git a/docs/.gitbook/assets/fact-order-description.jpeg b/docs/.gitbook/assets/fact-order-description.jpeg
diff --git a/docs/.gitbook/assets/fact-order.png b/docs/.gitbook/assets/fact-order.png
diff --git a/docs/.gitbook/assets/fact-sale-description.jpeg b/docs/.gitbook/assets/fact-sale-description.jpeg
diff --git a/docs/.gitbook/assets/fact-sale-description.png b/docs/.gitbook/assets/fact-sale-description.png
diff --git a/docs/.gitbook/assets/fact-sale-fields.png b/docs/.gitbook/assets/fact-sale-fields.png
diff --git a/docs/.gitbook/assets/fact-sale.png b/docs/.gitbook/assets/fact-sale.png
diff --git a/docs/.gitbook/assets/fork-github (1) (1).png b/docs/.gitbook/assets/fork-github (1) (1).png
diff --git a/docs/.gitbook/assets/fork-github (2).png b/docs/.gitbook/assets/fork-github (2).png
diff --git a/docs/.gitbook/assets/fork-github (3).png b/docs/.gitbook/assets/fork-github (3).png
diff --git a/docs/.gitbook/assets/frequently-joined-tables.png b/docs/.gitbook/assets/frequently-joined-tables.png
diff --git a/docs/.gitbook/assets/lineage-feature.gif b/docs/.gitbook/assets/lineage-feature.gif
diff --git a/docs/.gitbook/assets/link-fact-sale.png b/docs/.gitbook/assets/link-fact-sale.png
diff --git a/docs/.gitbook/assets/location.png b/docs/.gitbook/assets/location.png
diff --git a/docs/.gitbook/assets/log-in-with-google.png b/docs/.gitbook/assets/log-in-with-google.png
diff --git a/docs/.gitbook/assets/login-select-teams.png b/docs/.gitbook/assets/login-select-teams.png
diff --git a/docs/.gitbook/assets/my-data.png b/docs/.gitbook/assets/my-data.png
diff --git a/docs/.gitbook/assets/openmetadata-style-guide (3).pdf b/docs/.gitbook/assets/openmetadata-style-guide (3).pdf
diff --git a/docs/.gitbook/assets/owner.png b/docs/.gitbook/assets/owner.png
diff --git a/docs/.gitbook/assets/pipeline-description.png b/docs/.gitbook/assets/pipeline-description.png
diff --git a/docs/.gitbook/assets/pipeline-visual.png b/docs/.gitbook/assets/pipeline-visual.png
diff --git a/docs/.gitbook/assets/redshift-filter.png b/docs/.gitbook/assets/redshift-filter.png
diff --git a/docs/.gitbook/assets/redshift-service-assets.png b/docs/.gitbook/assets/redshift-service-assets.png
diff --git a/docs/.gitbook/assets/region.png b/docs/.gitbook/assets/region.png
diff --git a/docs/.gitbook/assets/sales-search-v2.png b/docs/.gitbook/assets/sales-search-v2.png
diff --git a/docs/.gitbook/assets/sales-search.png b/docs/.gitbook/assets/sales-search.png
diff --git a/docs/.gitbook/assets/sample-data.png b/docs/.gitbook/assets/sample-data.png
diff --git a/docs/.gitbook/assets/sandbox (1).png b/docs/.gitbook/assets/sandbox (1).png
diff --git a/docs/.gitbook/assets/sandbox.png b/docs/.gitbook/assets/sandbox.png
diff --git a/...nshot-from-2021-07-26-21-08-17 (1) (2) (2) (2) (3) (4) (4) (5) (3) (1) (11).png b/...nshot-from-2021-07-26-21-08-17 (1) (2) (2) (2) (3) (4) (4) (5) (3) (1) (11).png
diff --git a/...nshot-from-2021-07-26-21-08-17 (1) (2) (2) (2) (3) (4) (4) (5) (3) (1) (12).png b/...nshot-from-2021-07-26-21-08-17 (1) (2) (2) (2) (3) (4) (4) (5) (3) (1) (12).png
diff --git a/...nshot-from-2021-07-26-21-08-17 (1) (2) (2) (2) (3) (4) (4) (5) (3) (1) (13).png b/...nshot-from-2021-07-26-21-08-17 (1) (2) (2) (2) (3) (4) (4) (5) (3) (1) (13).png
diff --git a/docs/.gitbook/assets/screenshot-from-2021-09-20-14-11-53 (1).png b/docs/.gitbook/assets/screenshot-from-2021-09-20-14-11-53 (1).png
diff --git a/docs/.gitbook/assets/screenshot-from-2021-09-20-14-11-53.png b/docs/.gitbook/assets/screenshot-from-2021-09-20-14-11-53.png
diff --git a/docs/.gitbook/assets/screenshot-from-2021-09-20-14-14-14.png b/docs/.gitbook/assets/screenshot-from-2021-09-20-14-14-14.png
diff --git a/docs/.gitbook/assets/screenshot-from-2021-09-20-14-56-55.png b/docs/.gitbook/assets/screenshot-from-2021-09-20-14-56-55.png
diff --git a/docs/.gitbook/assets/screenshot-from-2021-09-20-14-59-07.png b/docs/.gitbook/assets/screenshot-from-2021-09-20-14-59-07.png
diff --git a/docs/.gitbook/assets/search-results-v2.png b/docs/.gitbook/assets/search-results-v2.png
diff --git a/docs/.gitbook/assets/search-results.png b/docs/.gitbook/assets/search-results.png
diff --git a/docs/.gitbook/assets/select-owner.png b/docs/.gitbook/assets/select-owner.png
diff --git a/docs/.gitbook/assets/service-in-asset-view.png b/docs/.gitbook/assets/service-in-asset-view.png
diff --git a/docs/.gitbook/assets/settings-tags-menu.png b/docs/.gitbook/assets/settings-tags-menu.png
diff --git a/docs/.gitbook/assets/simple-query.png b/docs/.gitbook/assets/simple-query.png
diff --git a/docs/.gitbook/assets/sort-by-weekly-usage.png b/docs/.gitbook/assets/sort-by-weekly-usage.png
diff --git a/docs/.gitbook/assets/sorted-by-weekly-usage (1).png b/docs/.gitbook/assets/sorted-by-weekly-usage (1).png
diff --git a/docs/.gitbook/assets/sorted-by-weekly-usage.png b/docs/.gitbook/assets/sorted-by-weekly-usage.png
diff --git a/docs/.gitbook/assets/tier-1-documentation-v2.png b/docs/.gitbook/assets/tier-1-documentation-v2.png
diff --git a/docs/.gitbook/assets/tier-1.png b/docs/.gitbook/assets/tier-1.png
diff --git a/docs/.gitbook/assets/tier-documentation-v2.png b/docs/.gitbook/assets/tier-documentation-v2.png
diff --git a/docs/.gitbook/assets/tier-documentation.png b/docs/.gitbook/assets/tier-documentation.png
diff --git a/docs/.gitbook/assets/tier1-results.png b/docs/.gitbook/assets/tier1-results.png
diff --git a/docs/.gitbook/assets/tiers.png b/docs/.gitbook/assets/tiers.png
diff --git a/docs/.gitbook/assets/variant-tables.png b/docs/.gitbook/assets/variant-tables.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,11 +1,10 @@
 # Introduction
 
-Metadata enables you to unlock the value of data assets in the common use cases of data discovery and governance, but also in emerging use cases related to data quality, observability, and people collaboration. However, poorly organized and managed metadata leads to redundant efforts within organizations and other inefficiencies that are expensive in time and dollars.  
-
+Metadata enables you to unlock the value of data assets in the common use cases of data discovery and governance, but also in emerging use cases related to data quality, observability, and people collaboration. However, poorly organized and managed metadata leads to redundant efforts within organizations and other inefficiencies that are expensive in time and dollars.
 
 ### **OpenMetadata is an open standard with a centralized metadata store that unifies all your data assets end-to-end to enable data discovery, user collaboration, and tool interoperability.**
 
-![](<../.gitbook/assets/openmetadata-overview (1).png>)
+![](<.gitbook/assets/openmetadata-overview (1).png>)
 
 OpenMetadata includes the following:
 

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,10 +1,37 @@
 # Table of contents
 
 * [Introduction](README.md)
-* [Try OpenMetadata](take-it-for-a-spin.md)
+* [Features](features.md)
 * [Roadmap](roadmap.md)
+* [Try OpenMetadata](take-it-for-a-spin.md)
+* [Tutorials](tutorials/README.md)
+  * [Tutorial: Data Discovery with OpenMetadata](tutorials/tutorial-data-discovery-with-openmetadata.md)
+* [Connectors](install/metadata-ingestion/connectors/README.md)
+  * [Athena](openmetadata/connectors/athena.md)
+  * [BigQuery](openmetadata/connectors/bigquery.md)
+  * [BigQuery Usage](openmetadata/connectors/bigquery-usage.md)
+  * [ElasticSearch](openmetadata/connectors/elastic-search.md)
+  * [Hive](openmetadata/connectors/hive.md)
+  * [Kafka](openmetadata/connectors/kafka.md)
+  * [Looker](openmetadata/connectors/looker.md)
+  * [MsSQL](openmetadata/connectors/mssql.md)
+  * [MySQL](openmetadata/connectors/mysql.md)
+  * [Oracle](openmetadata/connectors/oracle.md)
+  * [PII](openmetadata/connectors/pii.md)
+  * [Postgres](openmetadata/connectors/postgres.md)
+  * [Presto](openmetadata/connectors/presto.md)
+  * [Redash](openmetadata/connectors/redash.md)
+  * [Redshift](openmetadata/connectors/redshift.md)
+  * [Redshift Usage](openmetadata/connectors/redshift-usage.md)
+  * [Salesforce](openmetadata/connectors/salesforce.md)
+  * [Snowflake](openmetadata/connectors/snowflake.md)
+  * [Snowflake Usage](openmetadata/connectors/snowflake-usage.md)
+  * [Superset](openmetadata/connectors/superset.md)
+  * [Tableau](openmetadata/connectors/tableau.md)
+  * [Trino](openmetadata/connectors/trino.md)
+  * [Vertica](openmetadata/connectors/vertica.md)
 
-## OpenMetadata APIs
+## OpenMetadata
 
 * [Schemas](openmetadata-apis/schemas/README.md)
   * [JSON Schema](openmetadata-apis/schemas/schema-language.md)
@@ -46,7 +73,6 @@
   * [Overview](openmetadata-apis/apis/overview.md)
   * [API Organization](openmetadata-apis/apis/api-organization.md)
   * [Implementation notes](openmetadata-apis/apis/implementation-notes.md)
-
 
 ## Install
 
@@ -71,33 +97,9 @@
     * [Configure Ingestion](install/enable-security/auth0-sso/configure-security-ingestion.md)
 * [Metadata Ingestion](install/metadata-ingestion/README.md)
   * [Ingest Sample Data](install/metadata-ingestion/ingest-sample-data.md)
-  * [Connectors](install/metadata-ingestion/connectors/README.md)
-    * [Dashboard Services](install/metadata-ingestion/connectors/dashboard-services/README.md)
-      * [Looker](install/metadata-ingestion/connectors/dashboard-services/looker.md)
-      * [Superset](install/metadata-ingestion/connectors/dashboard-services/superset.md)
-      * [Tableau](install/metadata-ingestion/connectors/dashboard-services/tableau.md)
-    * [Database Services](install/metadata-ingestion/connectors/database-services/README.md)
-      * [Athena](install/metadata-ingestion/connectors/database-services/athena.md)
-      * [BigQuery](install/metadata-ingestion/connectors/database-services/bigquery.md)
-      * [ElasticSearch](install/metadata-ingestion/connectors/database-services/elastic-search.md)
-      * [MSSQL](install/metadata-ingestion/connectors/database-services/mssql.md)
-      * [MySQL](install/metadata-ingestion/connectors/database-services/mysql.md)
-      * [Hive](install/metadata-ingestion/connectors/database-services/hive.md)
-      * [Oracle](install/metadata-ingestion/connectors/database-services/oracle.md)
-      * [Postgres](install/metadata-ingestion/connectors/database-services/postgres.md)
-      * [Presto](install/metadata-ingestion/connectors/database-services/presto.md)
-      * [Redshift](install/metadata-ingestion/connectors/database-services/redshift.md)
-      * [Redshift Usage](install/metadata-ingestion/connectors/database-services/redshift-usage.md)
-      * [Salesforce](install/metadata-ingestion/connectors/database-services/salesforce.md)
-      * [Snowflake](install/metadata-ingestion/connectors/database-services/snowflake.md)
-      * [Snowflake Usage](install/metadata-ingestion/connectors/database-services/snowflake-usage.md)
-      * [Trino](install/metadata-ingestion/connectors/database-services/trino.md)
-      * [Vertica](install/metadata-ingestion/connectors/database-services/vertica.md)
-    * [Messaging Services](install/metadata-ingestion/connectors/messaging-services/README.md)
-      * [Kafka](install/metadata-ingestion/connectors/messaging-services/kafka.md)
-    * [Processors](install/metadata-ingestion/connectors/processors/README.md)
-      * [PII](install/metadata-ingestion/connectors/processors/pii.md)
-  * [Airflow](install/metadata-ingestion/airflow.md)
+  * [Airflow](install/metadata-ingestion/airflow/README.md)
+    * [Run Metadata Ingestion](install/metadata-ingestion/airflow/run-metadata-ingestion.md)
+    * [Configure Airflow Lineage](install/metadata-ingestion/airflow/configure-airflow-lineage.md)
 
 ## Open Source Community
 

diff --git a/docs/features.md b/docs/features.md
@@ -0,0 +1,83 @@
+---
+description: >-
+  OpenMetadata includes a rapidly growing set of features to address common
+  needs in data discovery, quality, observability, and collaboration.
+---
+
+# Features
+
+### Discover Your Data
+
+OpenMetadata enables you to discover your data using a variety of strategies, including: keyword search, data associations (e.g., frequently joined tables, lineage), and complex queries. Using OpenMetadata you can search across tables, topics, dashboards, pipelines, and services. The OpenMetadata standard and discovery UI provides for fine-grained and detailed metadata for assets and a their components (e.g., columns, charts), including support for complex data types such as arrays and structs.
+
+#### Keyword Search
+
+Find assets based on name, description, component metadata (e.g., for columns, charts), and the containing service.
+
+![](.gitbook/assets/asset-discovery-features.gif)
+
+#### Discover Data through Association
+
+Discover assets through frequently joined tables and columns as measured by the data profiler. You can also discover assets through relationships based on data lineage.
+
+![](.gitbook/assets/discover-association.gif)
+
+#### Advanced Search
+
+Find assets matching strict criteria on metadata properties and Boolean operators.
+
+![](.gitbook/assets/complex-queries.gif)
+
+### Know Your Data
+
+Add descriptions and tags to tables, columns, and other assets. OpenMetadata indexes assets based on descriptions, tags, names, and other metadata to enable keyword, advanced search, and filtering to enable you and others in your organization to discover your data.
+
+![](.gitbook/assets/descriptions-tags.gif)
+
+### Complex Data Types
+
+Add descriptions and tags to nested fields in complex data types like arrays and structs. Locate these assets using keyword search or advanced search.
+
+![](.gitbook/assets/complex-data-types.gif)
+
+### Importance & Owners
+
+Tier tags enable you to annotate assets with their importance relative to other assets. The Explore UI enables you to filter assets based on importance.
+
+Use ownership metadata to determine the primary points of contact for any assets of interest in order to get help with any questions you might have.
+
+#### Filter Assets by Importance
+
+User Tier tags and usage data to identify the relative importance of data assets.
+
+![](<.gitbook/assets/asset-importance (1).gif>)
+
+#### Identify Asset Owners
+
+Identify owners who can help with questions about an asset.
+
+![](.gitbook/assets/asset-owners.gif)
+
+### Data Lineage
+
+Trace the path of data across tables, pipelines, and dashboards.
+
+![](.gitbook/assets/lineage-feature.gif)
+
+### Data Reliability
+
+Build trust in your data by creating tests to monitor that the data is complete, fresh, and accurate.
+
+#### Data Profiler
+
+Enable the data profiler to capture table usage statistics over a period of time. This happens as part of metadata ingestion. Data profiles enable you to check for null values in non-null columns, for duplicates in a unique column, etc. You can gain a better understanding of column data distributions through descriptive statistics provided.
+
+![](.gitbook/assets/data-profiler-feature.gif)
+
+### Service Connectors
+
+Integrate your database, dashboard, messaging, and pipeline services with OpenMetadata.
+
+![](.gitbook/assets/connectors-feature.gif)
+
+See the [Connectors](install/metadata-ingestion/connectors/) documentation for information on available connectors and how to integrate your services with OpenMetadata.
diff --git a/docs/install/configuration.md b/docs/install/configuration.md
@@ -4,7 +4,7 @@ description: This document describes OpenMetadata Server Configuration
 
 # Configuration
 
-```text
+```
 swagger:
   resourcePackage: org.openmetadata.catalog.resources
 
@@ -70,7 +70,7 @@ health:
 
 ## Server Port
 
-```text
+```
 server:
   rootPath: '/api/*'
   applicationConnectors:
@@ -85,7 +85,7 @@ By default, the OpenMetadata server runs on port 8585. It uses Jetty Server. The
 
 ## Database
 
-```text
+```
 database:
   # the name of the JDBC driver, mysql in our case
   driverClass: com.mysql.cj.jdbc.Driver
@@ -100,7 +100,7 @@ The above section is database connection details to MySQL database. We recommend
 
 ## ElasticSearch
 
-```text
+```
 elasticsearch:
   host: localhost
   port: 9200
@@ -110,18 +110,18 @@ ElasticSearch is one of the pre-requisites to run OpenMetadata. Default configur
 
 ## EventHandlers
 
-```text
+```
 eventHandlerConfiguration:
   eventHandlerClassNames:
     - "org.openmetadata.catalog.events.AuditEventHandler"
     - "org.openmetadata.catalog.events.ElasticSearchEventHandler"
 ```
 
-EventHandler configuration is optional. It will update the AuditLog in MySQL DB and also ElasticSearch indexes whenever any entity is updated either through UI or API interactions. We recommend you to leave it there as it enhances the user experience.
+EventHandler configuration is optional. It will update the AuditLog in MySQL DB and also ElasticSearch indexes whenever any entity is updated either through UI or API interactions. We recommend you leave it there as it enhances the user experience.
 
 ## Healthcheck
 
-```text
+```
 health:
   delayedShutdownHandlerEnabled: true
   shutdownWaitPeriod: 1s
@@ -140,5 +140,4 @@ Healthcheck API provides an API endpoint to check the OpenMetadata server health
 
 ## Security
 
-Please follow our [Enable Security Guide](https://github.com/open-metadata/OpenMetadata/tree/63c66391cf27d4d77c4b5c21750d9c09bfa44049/install/enable-security.md) guide to configure security for your OpenMetadata installation.
-
+Please follow our [Enable Security Guide](https://docs.open-metadata.org/install/enable-security) guide to configure security for your OpenMetadata installation.
diff --git a/docs/install/enable-security/README.md b/docs/install/enable-security/README.md
@@ -2,6 +2,5 @@
 
 OpenMetadata has support for Google SSO and Okta SSO as identity providers. Please see the next sections about how to configure them.
 
-Enabling Security is only required for your production installation. If you are testing OpenMetadata it will be easier and faster to setup without security.   
+Enabling Security is only required for your production installation. If you are testing OpenMetadata it will be easier and faster to set up without security.\
 Please refer to our ["Run OpenMetadata Guide"](https://docs.open-metadata.org/install/run-openmetadata).
-
diff --git a/docs/install/enable-security/auth0-sso/auth0-config.md b/docs/install/enable-security/auth0-sso/auth0-config.md
@@ -2,11 +2,11 @@
 
 ## Update conf/openmetadata-security.yaml
 
-* Once the `Client Id` and `Client secret` is generated.
+*   Once the `Client Id` and `Client secret` is generated.
 
-  Add the `Client Id` in openmetadata-security.yaml file in `client_id` field.
+    Add the `Client Id` in openmetadata-security.yaml file in `client_id` field.
 
-```text
+```
 authenticationConfiguration:
   provider: "auth0"
   publicKey: "https://parth-panchal.us.auth0.com/.well-known/jwks.json"
@@ -17,7 +17,7 @@ authenticationConfiguration:
 
 * Update authorizerConfiguration to add adminPrincipals
 
-```text
+```
 authorizerConfiguration:
   className: "org.openmetadata.catalog.security.DefaultCatalogAuthorizer"
   # JWT Filter
@@ -26,6 +26,5 @@ authorizerConfiguration:
     - "suresh"
   botPrincipals:
     - "ingestion-bot"
-  principalDomain: "open-metadata.org"
+  prinicipalDomain: "open-metadata.org"
 ```
-
diff --git a/docs/install/enable-security/auth0-sso/auth0-server-creds.md b/docs/install/enable-security/auth0-sso/auth0-server-creds.md
@@ -3,7 +3,7 @@
 ## Step 1: Create the account
 
 * If you don't have an account, [Sign up](https://auth0.com/signup) to create one.
-* Select the Accout Type, click `I need advanced settings` and click `next`.
+* Select the Account Type, click `I need advanced settings` and click `next`.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130019106-366f192e-6591-470c-85f1-def0c821fe7b.png)
 
@@ -17,9 +17,9 @@
 
 ## Step 2: Create a new Application
 
-* Once you are on the Dashboard Page, click on `Application > Application` \
+*   Once you are on the Dashboard page, click on `Application > Application` \\
 
-  available on the left-hand side panel.
+    available on the left-hand side panel.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130019122-2435ada0-3321-46a6-a17b-dfb6bb589182.png)
 
@@ -40,4 +40,3 @@
 * You will find you `Client ID`, `Client Secret` and `Domain`.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130020071-63828d70-a809-4869-b7c1-7284d648bd59.png)
-
diff --git a/docs/install/enable-security/auth0-sso/create-ingestion-service-account.md b/docs/install/enable-security/auth0-sso/create-ingestion-service-account.md
@@ -26,7 +26,7 @@ description: This is a guide to create ingestion bot service account.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130190048-7c19da03-6d05-4217-ab7f-5e5348561174.png)
 
-* Now scroll further down util you see `Addition Settings`.
+* Now scroll further down until you see `Addition Settings`.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130190051-a3b7e740-6e4a-4dad-b95b-33eb7568f496.png)
 
@@ -58,7 +58,7 @@ description: This is a guide to create ingestion bot service account.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130190088-a4a1931d-a6e7-48ee-a9ed-201bca85f2f3.png)
 
-* You will see you application listed below
+* You will see your application listed below
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130190073-ad31b0aa-fcf1-494c-9313-6eb6ddc86858.png)
 
@@ -70,9 +70,8 @@ description: This is a guide to create ingestion bot service account.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130190090-b0458fc0-7642-46f1-9344-ad8706dd2625.png)
 
-* Select which permissions \(scopes\) should be granted to the client. \
+*   Select which permissions (scopes) should be granted to the client. \\
 
-  Click on `Update`.
+    Click on `Update`.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/130190076-28e2e11a-273d-491e-b998-db81bf1fb813.png)
-
diff --git a/docs/install/enable-security/google-sso/create-ingestion-service-account.md b/docs/install/enable-security/google-sso/create-ingestion-service-account.md
@@ -14,7 +14,7 @@ description: This is a guide to create ingestion bot service account.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/125935630-254cc611-f959-4c5e-b33d-73c1a09cc384.png)
 
-* Click on **Manage service accounts** available on the center-right side.
+* Click on **Manage service accounts** available on the centre-right side.
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/125935633-cfcc4c3f-3a68-4886-a291-fd98521bc3ad.png)
 
@@ -28,7 +28,7 @@ description: This is a guide to create ingestion bot service account.
 Make sure the Service Account Id is **ingestion-bot** and click on **CREATE AND CONTINUE**. If you chose a different Service Account Id, add it to the default bots list in [Configure OpenMetadata Server](https://github.com/StreamlineData/catalog/tree/3d53fa7c645ea55f846b06d0210ac63f8c38463f/docs/install/install/google-catalog-config.md)
 {% endhint %}
 
-![](../../../../.gitbook/assets/ingestion-bot-service-account.png)
+![](../../../.gitbook/assets/ingestion-bot-service-account.png)
 
 * Click on **Select a role** and give the **Owner** role. Then click **Continue.**
 
@@ -62,7 +62,7 @@ Make sure the Service Account Id is **ingestion-bot** and click on **CREATE AND
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/125935657-df55ad24-303f-4c65-931b-39ebf65acf09.png)
 
-* Click on **ADD KEY** and then **Create new key**
+* Click on **ADD KEY** and then **Create a new key**
 
 ![Alt text](https://user-images.githubusercontent.com/83201188/125935661-ce32b714-a67a-42fa-b989-395a29678e84.png)