diff --git a/docs/install/enable-security/README.md b/docs/install/enable-security/README.md index 43545f005b6..0052b692035 100644 --- a/docs/install/enable-security/README.md +++ b/docs/install/enable-security/README.md @@ -1,2 +1,4 @@ # Enable Security +OpenMetadata has support for Google SSO and Okta SSO as identity providers. TODO + diff --git a/docs/install/metadata-ingestion/README.md b/docs/install/metadata-ingestion/README.md index 72a68315df3..379258c9dda 100644 --- a/docs/install/metadata-ingestion/README.md +++ b/docs/install/metadata-ingestion/README.md @@ -1,6 +1,6 @@ # Metadata Ingestion -OpenMetadata Ingesiton is a simple framework to build connectors and ingest metadata of various systems through [OpenMetadata APIs](https://docs.open-metadata.org/v/docs/openmetadata-apis/apis). It could be used in an orchestration framework\(e.g. Apache Airflow\) to ingest metadata. +OpenMetadata Ingestion is a simple framework to build connectors and ingest metadata of various systems through [OpenMetadata APIs](https://docs.open-metadata.org/v/docs/openmetadata-apis/apis). It could be used in an orchestration framework\(e.g. Apache Airflow\) to ingest metadata. ## Guides diff --git a/docs/install/metadata-ingestion/connectors/README.md b/docs/install/metadata-ingestion/connectors/README.md index 81b05df535e..19518bb554f 100644 --- a/docs/install/metadata-ingestion/connectors/README.md +++ b/docs/install/metadata-ingestion/connectors/README.md @@ -1,2 +1,4 @@ # Connectors +TODO + diff --git a/docs/install/metadata-ingestion/connectors/mysql.md b/docs/install/metadata-ingestion/connectors/mysql.md index eba44553e15..e78aedba7e0 100644 --- a/docs/install/metadata-ingestion/connectors/mysql.md +++ b/docs/install/metadata-ingestion/connectors/mysql.md @@ -76,7 +76,7 @@ metadata ingest -c ./pipelines/mysql.json Below is the configuration to publish MySQL data into openmetadata -Add Optional `pii-tags` processor and `metadata-rest-tables` sink along with `metadata-server` config +Add optional `pii-tags` processor and `metadata-rest-tables` sink along with `metadata-server` config {% code title="mysql.json" %} ```javascript diff --git a/docs/install/metadata-ingestion/ingest-sample-data.md b/docs/install/metadata-ingestion/ingest-sample-data.md index f7f95c73092..e215afe95c6 100644 --- a/docs/install/metadata-ingestion/ingest-sample-data.md +++ b/docs/install/metadata-ingestion/ingest-sample-data.md @@ -52,7 +52,7 @@ metadata ingest -c ./pipelines/sample_users.json Start Elastic Search Docker: {% hint style="warning" %} -Below command to run elastic search docker stores the indexed data in memory. If you stop the container it will lose any data on restart. Please re-run the metadata\_to\_es workflow again to index the data upon starting the container. +Below command to run elastic search docker that stores the indexed data in memory. If you stop the container it will lose any data on restart. Please re-run the metadata\_to\_es workflow again to index the data upon starting the container. {% endhint %} ```bash diff --git a/docs/install/run-openmetadata.md b/docs/install/run-openmetadata.md index 4c13ce282ce..08ebde609e8 100644 --- a/docs/install/run-openmetadata.md +++ b/docs/install/run-openmetadata.md @@ -22,7 +22,7 @@ cd OpenMetadata/docker/metadata docker-compose up ``` -Above command brings up all the necessary services +The above command brings up all the necessary services 1. MySQL 2. ElasticSearch @@ -133,7 +133,7 @@ cd openmetadata-1.0.0-SNAPSHOT ### Ingest Sample Data -Previous steps starts the OpenMetadataServer. To start using using it we need to run ElasticSearch and ingest sample metadata. Please follow the below guide +Previous steps start OpenMetadata server. To start using it we need to run ElasticSearch and ingest sample metadata. Please follow the below guide [Ingest Sample Data](metadata-ingestion/ingest-sample-data.md) diff --git a/docs/open-source-community/developer/coding-style.md b/docs/open-source-community/developer/coding-style.md index 8172508b327..249ab014381 100644 --- a/docs/open-source-community/developer/coding-style.md +++ b/docs/open-source-community/developer/coding-style.md @@ -8,11 +8,11 @@ description: >- ## Basics -1. Avoid cryptic abbreviations. Single letter variable names are fine in very short methods with few variables, otherwise make them informative. +1. Avoid cryptic abbreviations. Single letter variable names are fine in very short methods with few variables, otherwise, make them informative. 2. Clear code is preferable to comments. When possible make your naming so good you don't need comments. When that isn't possible comments should be thought of as mandatory, write them to be read. 3. Logging, configuration, and public APIs are our "UI". Make them pretty, consistent, and usable. 4. The maximum line length is 120. -5. Don't leave TODOs in the code or FIXMEs if you can help it. Don't leave println statements in the code. TODOs should be filed as github tasks. +5. Don't leave TODOs in the code or FIXMEs if you can help it. Don't leave println statements in the code. TODOs should be filed as GitHub tasks. 6. User documentation should be considered a part of any user-facing feature, just like unit tests. Example REST APIs should've accompanying documentation. 7. Tests should never rely on timing in order to pass. 8. Every unit test should leave no side effects, i.e., any test dependencies should be set during setup and clean during tear down. diff --git a/docs/take-it-for-a-spin.md b/docs/take-it-for-a-spin.md index 975aa353881..463c3fe7dac 100644 --- a/docs/take-it-for-a-spin.md +++ b/docs/take-it-for-a-spin.md @@ -1,4 +1,8 @@ # Take it for a spin -TODO Sanket, add a link to the demo and add some screenshots +We want our users to get the feel for what we have built with the least effort. That is why we have set up a sandbox. Please give it a try at TODO + + + +Screenshots and explanation.