OpenMetadata/docs/SUMMARY.md

208 lines
14 KiB
Markdown
Raw Normal View History

2021-08-01 14:27:44 -07:00
# Table of contents
* [Introduction](README.md)
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 <ayush.shah@deuexsolutions.com> Co-authored-by: Suresh Srinivas <suresh@getcollate.io> Co-authored-by: Shannon Bradshaw <shannon.bradshaw@arrikto.com> Co-authored-by: OpenMetadata <github@harsha.io>
2021-11-13 23:03:20 +05:30
* [Features](features.md)
* [Roadmap](roadmap.md)
2022-03-10 08:59:13 +00:00
* [Try OpenMetadata](../try-openmetadata/README.md)
* [Try OpenMetadata in our Public Sandbox](../try-openmetadata/take-it-for-a-spin.md)
* [Try OpenMetadata in Docker](try-openmetadata/run-openmetadata/README.md)
* [Enable Security](try-openmetadata/run-openmetadata/enable-security.md)
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 <ayush.shah@deuexsolutions.com> Co-authored-by: Suresh Srinivas <suresh@getcollate.io> Co-authored-by: Shannon Bradshaw <shannon.bradshaw@arrikto.com> Co-authored-by: OpenMetadata <github@harsha.io>
2021-11-13 23:03:20 +05:30
* [Tutorials](tutorials/README.md)
* [Tutorial: Data Discovery with OpenMetadata](tutorials/tutorial-data-discovery-with-openmetadata.md)
2021-08-01 14:27:44 -07:00
2022-03-10 08:59:13 +00:00
## Integrations
* [Connectors](integrations/connectors/README.md)
* [Airflow](integrations/connectors/airflow/README.md)
* [Airflow Metadata Ingestion](integrations/connectors/airflow/airflow.md)
* [Airflow Lineage](integrations/connectors/airflow/airflow-lineage.md)
* [Athena](integrations/connectors/athena.md)
* [Azure SQL](integrations/connectors/azure-sql.md)
* [BigQuery](integrations/connectors/bigquery/README.md)
* [BigQuery Metadata Extraction](integrations/connectors/bigquery/bigquery-metadata-extraction.md)
* [BigQuery Usage](integrations/connectors/bigquery-usage.md)
* [Databricks](integrations/connectors/databricks.md)
* [Delta Lake](integrations/connectors/delta-lake.md)
* [DynamoDB](integrations/connectors/dynamodb.md)
* [Elasticsearch](integrations/connectors/elastic-search.md)
* [Glue Catalog](integrations/connectors/glue-catalog/README.md)
* [Glue Metadata Extraction](integrations/connectors/glue-catalog/glue-metadata-extraction.md)
* [Hive](integrations/connectors/hive.md)
* [IBM Db2](integrations/connectors/ibm-db2.md)
* [Kafka](integrations/connectors/kafka.md)
* [Looker](integrations/connectors/looker.md)
* [MariaDB](integrations/connectors/mariadb.md)
* [Metabase](integrations/connectors/metabase.md)
* [MLflow](integrations/connectors/mlflow/README.md)
* [MLflow Metadata Extraction](integrations/connectors/mlflow/mlflow-metadata-extraction.md)
* [MSSQL](integrations/connectors/mssql/README.md)
* [MSSQL Metadata Extraction](integrations/connectors/mssql/mssql-metadata-extraction.md)
* [MySQL](integrations/connectors/mysql/README.md)
* [MySQL Metadata Extraction](integrations/connectors/mysql/mysql.md)
* [Oracle](integrations/connectors/oracle.md)
* [Postgres](integrations/connectors/postgres/README.md)
* [Postgres Metadata Extraction](integrations/connectors/postgres/postgres-metadata-extraction.md)
* [Presto](integrations/connectors/presto.md)
* [Redash](integrations/connectors/redash.md)
* [Redshift](integrations/connectors/redshift/README.md)
* [Redshift Metadata Extraction](integrations/connectors/redshift/redshift-metadata-extraction.md)
* [Redshift Usage](integrations/connectors/redshift-usage.md)
* [Salesforce](integrations/connectors/salesforce.md)
* [SingleStore](integrations/connectors/singlestore.md)
* [Snowflake](integrations/connectors/snowflake/README.md)
* [Snowflake Metadata Extraction](integrations/connectors/snowflake/snowflake-metadata-extraction.md)
* [Snowflake Usage](integrations/connectors/snowflake-usage.md)
* [Superset](integrations/connectors/superset.md)
* [Tableau](integrations/connectors/tableau.md)
* [Trino](integrations/connectors/trino.md)
* [Vertica](integrations/connectors/vertica.md)
* [Troubleshoot Connectors](integrations/troubleshoot-connectors.md)
## Metadata Standard
2021-08-01 14:27:44 -07:00
* [Schemas](openmetadata-apis/schemas/README.md)
* [JSON Schema](openmetadata-apis/schemas/schema-language.md)
2021-08-13 20:12:38 +00:00
* [Schema Concepts](openmetadata-apis/schemas/overview.md)
2021-08-12 17:28:54 +00:00
* [OpenMetadata Types](openmetadata-apis/schemas/types/README.md)
* [Audit Log](openmetadata-apis/schemas/types/auditlog.md)
* [Basic Types](openmetadata-apis/schemas/types/basic.md)
* [Change Event](openmetadata-apis/schemas/types/changeevent.md)
* [Daily Count](openmetadata-apis/schemas/types/dailycount.md)
* [Database Connection Configuration](openmetadata-apis/schemas/types/databaseconnectionconfig.md)
* [Entity History](openmetadata-apis/schemas/types/entityhistory.md)
* [Entity Lineage](openmetadata-apis/schemas/types/entitylineage.md)
* [Entity Reference](openmetadata-apis/schemas/types/entityreference.md)
* [Entity Relationship](openmetadata-apis/schemas/types/entityrelationship.md)
* [Entity Usage](openmetadata-apis/schemas/types/entityusage.md)
* [Include](openmetadata-apis/schemas/types/include.md)
* [Jdbc Connection](openmetadata-apis/schemas/types/jdbcconnection.md)
* [Paging](openmetadata-apis/schemas/types/paging.md)
* [Profile](openmetadata-apis/schemas/types/profile.md)
* [Schedule](openmetadata-apis/schemas/types/schedule.md)
* [Storage](openmetadata-apis/schemas/types/storage.md)
* [Tag Label](openmetadata-apis/schemas/types/taglabel.md)
* [Usage Details](openmetadata-apis/schemas/types/usagedetails.md)
2021-08-12 17:28:54 +00:00
* [OpenMetadata Entities](openmetadata-apis/schemas/entities/README.md)
* [Access Control Rule](openmetadata-apis/schemas/entities/accesscontrolrule.md)
* [Bot](openmetadata-apis/schemas/entities/bot.md)
* [Chart](openmetadata-apis/schemas/entities/chart.md)
* [Dashboard](openmetadata-apis/schemas/entities/dashboard.md)
* [Dashboard Service](openmetadata-apis/schemas/entities/dashboardservice.md)
* [Database](openmetadata-apis/schemas/entities/database.md)
* [Database Service](openmetadata-apis/schemas/entities/databaseservice.md)
* [Delete Action](openmetadata-apis/schemas/entities/deleteaction.md)
* [Feed](openmetadata-apis/schemas/entities/thread.md)
* [Filters](openmetadata-apis/schemas/entities/filters.md)
* [Glossary](openmetadata-apis/schemas/entities/glossary.md)
* [Glossary Term](openmetadata-apis/schemas/entities/glossaryterm.md)
* [Location](openmetadata-apis/schemas/entities/location.md)
* [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md)
* [Metrics](openmetadata-apis/schemas/entities/metrics.md)
* [ML Model](openmetadata-apis/schemas/entities/mlmodel.md)
* [Move Action](openmetadata-apis/schemas/entities/moveaction.md)
* [Pipeline](openmetadata-apis/schemas/entities/pipeline.md)
* [Pipeline Service](openmetadata-apis/schemas/entities/pipelineservice.md)
* [Policy](openmetadata-apis/schemas/entities/policy.md)
* [Report](openmetadata-apis/schemas/entities/report.md)
* [Role](openmetadata-apis/schemas/entities/role.md)
* [Rule](openmetadata-apis/schemas/entities/rule.md)
* [Storage Service](openmetadata-apis/schemas/entities/storageservice.md)
* [Table](openmetadata-apis/schemas/entities/table.md)
* [Tag Bases](openmetadata-apis/schemas/entities/tagbased.md)
* [Tag Category](openmetadata-apis/schemas/entities/tagcategory.md)
* [Task](openmetadata-apis/schemas/entities/task.md)
* [Team](openmetadata-apis/schemas/entities/team.md)
* [Topic](openmetadata-apis/schemas/entities/topic.md)
* [User](openmetadata-apis/schemas/entities/user.md)
* [Webhook](openmetadata-apis/schemas/entities/webhook.md)
2021-08-01 14:27:44 -07:00
* [APIs](openmetadata-apis/apis/README.md)
* [Overview](openmetadata-apis/apis/overview.md)
2021-08-15 01:39:19 +00:00
* [API Organization](openmetadata-apis/apis/api-organization.md)
2021-08-12 17:37:06 +00:00
* [Implementation notes](openmetadata-apis/apis/implementation-notes.md)
2021-08-01 14:27:44 -07:00
2022-03-10 08:59:13 +00:00
## Deploy
* [Deploy on Bare Metal](../deploy/deploy-on-bare-metal/README.md)
* [Deploy OpenMetadata on Bare Metal](../deploy/deploy-on-bare-metal/run-in-production.md)
* [Enable Security](../deploy/deploy-on-bare-metal/enable-security/README.md)
* [Google SSO](../deploy/deploy-on-bare-metal/enable-security/google-sso/README.md)
* [Create Server Credentials](../deploy/deploy-on-bare-metal/enable-security/google-sso/google-server-creds.md)
* [Create Service Account](../deploy/deploy-on-bare-metal/enable-security/google-sso/create-ingestion-service-account.md)
* [Configure OpenMetadata Server](../deploy/deploy-on-bare-metal/enable-security/google-sso/google-config.md)
* [Configure Ingestion](../deploy/deploy-on-bare-metal/enable-security/google-sso/configure-security-ingestion.md)
* [Okta SSO](../deploy/deploy-on-bare-metal/enable-security/okta-sso/README.md)
* [Create Server Credentials](../deploy/deploy-on-bare-metal/enable-security/okta-sso/okta-server-creds.md)
* [Configure OpenMetadata Server](../deploy/deploy-on-bare-metal/enable-security/okta-sso/okta-config.md)
* [Create Service Application](../deploy/deploy-on-bare-metal/enable-security/okta-sso/create-ingestion-service-account.md)
* [Configure Ingestion](../deploy/deploy-on-bare-metal/enable-security/okta-sso/configure-security-ingestion.md)
* [Auth0 SSO](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/README.md)
* [Create Server Credentials](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/auth0-server-creds.md)
* [Create Service Account](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/create-ingestion-service-account.md)
* [Configure OpenMetadata Server](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/auth0-config.md)
* [Configure Ingestion](../deploy/deploy-on-bare-metal/enable-security/auth0-sso/configure-security-ingestion.md)
* [Deploy on Kubernetes](../deploy/deploy-on-kubernetes/README.md)
* [Deploy OpenMetadata on Kubernetes](../deploy/deploy-on-kubernetes/run-in-kubernetes.md)
* [Values.yaml](../deploy/deploy-on-kubernetes/values.yaml.md)
* [Enable Security](../deploy/deploy-on-kubernetes/enable-security/README.md)
* [Copy of Google SSO](../deploy/deploy-on-kubernetes/enable-security/google-sso/README.md)
* [Copy of Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-server-creds.md)
* [Copy of Create Service Account](../deploy/deploy-on-kubernetes/enable-security/google-sso/create-ingestion-service-account.md)
* [Copy of Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-config.md)
* [Copy of Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/google-sso/configure-security-ingestion.md)
* [Copy of Okta SSO](../deploy/deploy-on-kubernetes/enable-security/okta-sso/README.md)
* [Copy of Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-server-creds.md)
* [Copy of Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-config.md)
* [Copy of Create Service Application](../deploy/deploy-on-kubernetes/enable-security/okta-sso/create-ingestion-service-account.md)
* [Copy of Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/okta-sso/configure-security-ingestion.md)
* [Copy of Auth0 SSO](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/README.md)
* [Copy of Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-server-creds.md)
* [Copy of Create Service Account](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/create-ingestion-service-account.md)
* [Copy of Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-config.md)
* [Copy of Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/configure-security-ingestion.md)
* [Reference](../deploy/reference/README.md)
* [Server Configuration Parameters](../deploy/reference/configuration.md)
* [Connector Configuration Parameters](../deploy/reference/connector-configuration.md)
## Upgrade
* [Upgrade on Bare Metal](../upgrade/upgrade-on-bare-metal/README.md)
* [Backup Metadata](../upgrade/upgrade-on-bare-metal/backup-metadata.md)
* [Upgrade OpenMetadata on Bare Metal](../upgrade/upgrade-on-bare-metal/upgrade-openmetadata.md)
* [Upgrade on Kubernetes](../upgrade/upgrade-on-kubernetes/README.md)
* [Backup Metadata](../upgrade/upgrade-on-kubernetes/backup-metadata.md)
* [Upgrade OpenMetadata on Kubernetes](../upgrade/upgrade-on-kubernetes/upgrade-openmetadata-on-kubernetes.md)
## Metadata Ingestion
* [Metadata Ingestion Overview](../metadata-ingestion/metadata-ingestion.md)
* [Ingest Sample Data](../metadata-ingestion/ingest-sample-data.md)
## Data Quality
2021-08-01 14:27:44 -07:00
2022-03-10 08:59:13 +00:00
* [Data Quality Overview](../data-quality/data-quality-overview/README.md)
* [Metrics](../data-quality/data-quality-overview/metrics.md)
* [Tests](../data-quality/data-quality-overview/tests.md)
2021-08-01 14:27:44 -07:00
## Open Source Community
* [Community](open-source-community/community.md)
* [UX Style Guide](open-source-community/ux-style-guide.md)
2021-08-01 14:27:44 -07:00
* [Developer](open-source-community/developer/README.md)
* [How to Contribute](open-source-community/developer/how-to-contribute.md)
* [Prerequisites](open-source-community/developer/prerequisites.md)
* [Backend](open-source-community/developer/backend/README.md)
2021-08-01 14:27:44 -07:00
* [Build the code & run tests](open-source-community/developer/build-code-run-tests.md)
* [Quick Start Guide](open-source-community/developer/quick-start-guide.md)
* [Build a Connector](open-source-community/developer/build-a-connector/README.md)
* [Setup](open-source-community/developer/build-a-connector/setup.md)
* [Source](open-source-community/developer/build-a-connector/source.md)
* [Sink](open-source-community/developer/build-a-connector/sink.md)
* [Stage](open-source-community/developer/build-a-connector/stage.md)
* [BulkSink](open-source-community/developer/build-a-connector/bulksink.md)
2021-08-01 14:27:44 -07:00
* [Run Integration Tests](open-source-community/developer/run-integration-tests.md)
2022-03-10 08:59:13 +00:00
* [UI](open-source-community/developer/ui.md)
* [Solution Design](open-source-community/developer/solution-design.md)
2021-12-05 16:38:58 +00:00
* [Python API](open-source-community/developer/python-api.md)
2021-12-22 21:34:31 +00:00
* [Entities](open-source-community/developer/entities/README.md)
* [ML Model Entity](open-source-community/developer/entities/ml-model-entity.md)