OpenMetadata/docs/SUMMARY.md

124 lines
7.2 KiB
Markdown
Raw Permalink 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)
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
* [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)
2021-08-01 14:27:44 -07:00
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
## OpenMetadata
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)
* [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 Usage](openmetadata-apis/schemas/types/entityusage.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)
* [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)
* [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)
* [Location](openmetadata-apis/schemas/entities/location.md)
* [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md)
* [Feed](openmetadata-apis/schemas/entities/thread.md)
* [Metrics](openmetadata-apis/schemas/entities/metrics.md)
* [ML Model](openmetadata-apis/schemas/entities/mlmodel.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)
* [Storage Service](openmetadata-apis/schemas/entities/storageservice.md)
* [Table](openmetadata-apis/schemas/entities/table.md)
* [Tag Category](openmetadata-apis/schemas/entities/tagcategory.md)
* [Team](openmetadata-apis/schemas/entities/team.md)
* [Topic](openmetadata-apis/schemas/entities/topic.md)
* [User](openmetadata-apis/schemas/entities/user.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
## Install
2021-08-12 11:39:56 -07:00
* [Run OpenMetadata](install/run-openmetadata.md)
2021-08-12 12:24:29 -07:00
* [Run in Production](install/run-in-production.md)
* [Run in Kubernetes](install/run-in-kubernetes.md)
2021-08-12 12:37:05 -07:00
* [Configuration](install/configuration.md)
2021-08-12 12:24:29 -07:00
* [Enable Security](install/enable-security/README.md)
* [Google SSO](install/enable-security/google-sso/README.md)
* [Create Server Credentials](install/enable-security/google-sso/google-server-creds.md)
* [Create Service Account](install/enable-security/google-sso/create-ingestion-service-account.md)
2021-08-12 12:37:05 -07:00
* [Configure OpenMetadata Server](install/enable-security/google-sso/google-config.md)
2021-08-12 12:24:29 -07:00
* [Configure Ingestion](install/enable-security/google-sso/configure-security-ingestion.md)
* [Okta SSO](install/enable-security/okta-sso/README.md)
* [Create Server Credentials](install/enable-security/okta-sso/okta-server-creds.md)
2021-08-12 12:37:05 -07:00
* [Configure OpenMetadata Server](install/enable-security/okta-sso/okta-config.md)
2021-08-12 12:24:29 -07:00
* [Create Service Account](install/enable-security/okta-sso/create-ingestion-service-account.md)
* [Configure Ingestion](install/enable-security/okta-sso/configure-security-ingestion.md)
* [Auth0 SSO](install/enable-security/auth0-sso/README.md)
* [Create Server Credentials](install/enable-security/auth0-sso/auth0-server-creds.md)
* [Create Service Account](install/enable-security/auth0-sso/create-ingestion-service-account.md)
* [Configure OpenMetadata Server](install/enable-security/auth0-sso/auth0-config.md)
* [Configure Ingestion](install/enable-security/auth0-sso/configure-security-ingestion.md)
2021-08-01 14:27:44 -07:00
* [Metadata Ingestion](install/metadata-ingestion/README.md)
* [Ingest Sample Data](install/metadata-ingestion/ingest-sample-data.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
* [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)
2021-08-01 14:27:44 -07:00
## Open Source Community
* [Community](open-source-community/community.md)
* [Developer](open-source-community/developer/README.md)
* [How to Contribute](open-source-community/developer/how-to-contribute.md)
2021-08-01 14:27:44 -07:00
* [Coding Style](open-source-community/developer/coding-style.md)
* [Build the code & run tests](open-source-community/developer/build-code-run-tests.md)
* [Build a Connector](open-source-community/developer/build-a-connector/README.md)
* [Source](open-source-community/developer/build-a-connector/source.md)
* [Processor](open-source-community/developer/build-a-connector/processor.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)
2021-08-15 22:21:43 +00:00
* [UX Style Guide](open-source-community/developer/ux-style-guide.md)