From 2d09b8318345e2c1d09556ec822a2a9301ca388a Mon Sep 17 00:00:00 2001 From: Suresh Srinivas Date: Thu, 12 Aug 2021 21:14:42 +0000 Subject: [PATCH] GitBook: [main] 11 pages modified --- docs/install/configuration.md | 8 ++++---- .../google-sso/configure-security-ingestion.md | 2 +- .../google-sso/create-ingestion-service-account.md | 6 +++--- docs/install/enable-security/google-sso/google-config.md | 2 +- .../enable-security/google-sso/google-server-creds.md | 6 +++--- docs/install/enable-security/okta-sso/okta-config.md | 4 ++-- .../install/enable-security/okta-sso/okta-server-creds.md | 6 +++--- docs/install/run-in-production.md | 4 ++-- docs/open-source-community/community.md | 2 +- .../developer/build-code-run-tests.md | 4 ++-- docs/open-source-community/developer/coding-style.md | 8 ++++---- 11 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/install/configuration.md b/docs/install/configuration.md index a84eae92224..dc8ce5324b5 100644 --- a/docs/install/configuration.md +++ b/docs/install/configuration.md @@ -81,7 +81,7 @@ server: port: 8586 ``` -By default OpenMetadata server runs on port 8585. It uses Jetty Server. The above config can be changed to make it run on a different port. Once you have updated the port details in config restart the server. +By default, the OpenMetadata server runs on port 8585. It uses Jetty Server. The above config can be changed to make it run on a different port. Once you have updated the port details in config restart the server. ## Database @@ -96,7 +96,7 @@ database: url: jdbc:mysql://localhost/openmetadata_db?useSSL=false&serverTimezone=UTC ``` -The above section is database connection details to MySQL database. We recommend you to create a MySQL user with strong password and update this section accordingly. +The above section is database connection details to MySQL database. We recommend you create a MySQL user with a strong password and update this section accordingly. ## ElasticSearch @@ -106,7 +106,7 @@ elasticsearch: port: 9200 ``` -ElasticSearch is one of the pre-requisities to run OpenMetadata. Default configuration expects a single instance of ElasticSearch running on local machine. Please make sure you update it with your production elastic search. +ElasticSearch is one of the pre-requisites to run OpenMetadata. Default configuration expects a single instance of ElasticSearch running on the local machine. Please make sure you update it with your production elastic search. ## EventHandlers @@ -136,7 +136,7 @@ health: successAttempts: 1 ``` -Healthcheck api provides a API endpoint to check the OpenMetadata server health. We recommend in production settign to use this api to monitor the health of your OpenMetadata instance. Please tune the above configuration according to your production needs. +Healthcheck API provides an API endpoint to check the OpenMetadata server health. We recommend in production settings to use this API to monitor the health of your OpenMetadata instance. Please tune the above configuration according to your production needs. ## Security diff --git a/docs/install/enable-security/google-sso/configure-security-ingestion.md b/docs/install/enable-security/google-sso/configure-security-ingestion.md index a202916ea57..e46411c523c 100644 --- a/docs/install/enable-security/google-sso/configure-security-ingestion.md +++ b/docs/install/enable-security/google-sso/configure-security-ingestion.md @@ -6,7 +6,7 @@ description: This is a guide to configure Ingestion Connectors with security. ## Add Metadata Authentication for Connectors -All Connectors have **metadata\_server** config. Pass the json file generated in [Create Service Account](https://github.com/StreamlineData/catalog/tree/3d53fa7c645ea55f846b06d0210ac63f8c38463f/docs/install/security/google-sso/create-ingestion-service-account.md) as secret\_key +All Connectors have **metadata\_server** config. Pass the JSON file generated in [Create Service Account](https://github.com/StreamlineData/catalog/tree/3d53fa7c645ea55f846b06d0210ac63f8c38463f/docs/install/security/google-sso/create-ingestion-service-account.md) as secret\_key {% code title="Connector Config for MySQL Connector:" %} ```javascript 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 index 5e46fe06185..8e14f954989 100644 --- a/docs/install/enable-security/google-sso/create-ingestion-service-account.md +++ b/docs/install/enable-security/google-sso/create-ingestion-service-account.md @@ -10,7 +10,7 @@ description: This is a guide to create ingestion bot service account. ![Alt text](https://user-images.githubusercontent.com/83201188/125935620-63a9c619-7e0c-49f7-a1a4-c190194a7f30.png) -* Click on **Credentails** available on the left side panel +* Click on **Credentials** available on the left side panel ![Alt text](https://user-images.githubusercontent.com/83201188/125935630-254cc611-f959-4c5e-b33d-73c1a09cc384.png) @@ -30,7 +30,7 @@ Makesure the Service Account Id as **ingestion-bot** and click on **CREATE AND C ![](../../../.gitbook/assets/ingestion-bot-service-account.png) -* Click on **role** and give the **owner** role. Then click **CONTINUE** +* Click on **Select a role** and give the **Owner** role. Then click **Continue.** ![Alt text](https://user-images.githubusercontent.com/83201188/125935643-748b30ee-526b-473b-9c39-8b86e50605a8.png) @@ -62,7 +62,7 @@ Makesure the Service Account Id as **ingestion-bot** and click on **CREATE AND C ![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 C**reate new key** ![Alt text](https://user-images.githubusercontent.com/83201188/125935661-ce32b714-a67a-42fa-b989-395a29678e84.png) diff --git a/docs/install/enable-security/google-sso/google-config.md b/docs/install/enable-security/google-sso/google-config.md index 13e663656d5..3893c56f8dc 100644 --- a/docs/install/enable-security/google-sso/google-config.md +++ b/docs/install/enable-security/google-sso/google-config.md @@ -15,7 +15,7 @@ authenticationConfiguration: callbackUrl: "http://localhost:8585/callback" ``` -* Update authorizationConfiguraiton to add adminPrincipals +* Update authorizerConfiguration to add adminPrincipals ```text authorizerConfiguration: diff --git a/docs/install/enable-security/google-sso/google-server-creds.md b/docs/install/enable-security/google-sso/google-server-creds.md index 2da7264f881..555a386f9fc 100644 --- a/docs/install/enable-security/google-sso/google-server-creds.md +++ b/docs/install/enable-security/google-sso/google-server-creds.md @@ -18,7 +18,7 @@ ## Step 3: How to configure OAuth consent -* Select the project you created above and Click on **APIs & Services** on the left-side panel. +* Select the project you created above and click on **APIs & Services** on the left-side panel. ![OAuth Consent](../../../.gitbook/assets/g-project-oauth-consent.png) @@ -57,7 +57,7 @@ ![Alt text](https://user-images.githubusercontent.com/83201188/123220655-c7d59b00-d4eb-11eb-96c0-711f2938ec99.png) * Select **OAuth client ID** from the dropdown. -* Once selected, you will be asked to select the **Application Type** . Select **Web Application** +* Once selected, you will be asked to select the **Application type**. Select **Web application** ![OAuth Consent](https://user-images.githubusercontent.com/83201188/123220661-c906c800-d4eb-11eb-8ffb-5a7dbc4fc5b6.png) @@ -73,7 +73,7 @@ ## Step 5: Where to find the credentials * Go to **Credentials** -* Click on the **pencil icon \(Edit OAuth Client\)** of the right side of the screen +* Click on the **pencil icon \(Edit OAuth Client\)** on the right side of the screen ![Alt text](https://user-images.githubusercontent.com/83201188/123220675-cad08b80-d4eb-11eb-9c46-2c7c81b02509.png) diff --git a/docs/install/enable-security/okta-sso/okta-config.md b/docs/install/enable-security/okta-sso/okta-config.md index f51b5474f1e..e0db6101bdd 100644 --- a/docs/install/enable-security/okta-sso/okta-config.md +++ b/docs/install/enable-security/okta-sso/okta-config.md @@ -4,7 +4,7 @@ * Once the **Client Id**, **Client secret**, **issuer** and **audience** is generated. - Add those details in openmetadata-security.yaml file in the respective field. + Add those details in `openmetadata-security.yaml` file in the respective field. ```text authenticationConfiguration: @@ -15,7 +15,7 @@ authenticationConfiguration: callbackUrl: "http://localhost:8585/callback" ``` -* Update authorizationConfiguraiton to add adminPrincipals +* Update `authorizerConfiguration` to add `adminPrincipals` ```text authorizerConfiguration: diff --git a/docs/install/enable-security/okta-sso/okta-server-creds.md b/docs/install/enable-security/okta-sso/okta-server-creds.md index 01c9b441c17..ff24ca5c32a 100644 --- a/docs/install/enable-security/okta-sso/okta-server-creds.md +++ b/docs/install/enable-security/okta-sso/okta-server-creds.md @@ -1,6 +1,6 @@ # Create Server Credentials -**This document is all about how to create an Okta app and configure it for oauth. It will generate information which is required to perform single sign on activity.** +**This document is all about how to create an Okta app and configure it for oAuth. It will generate information which is required to perform single-sign-on activity.** ## Step 1: Create an Okta Account @@ -51,7 +51,7 @@ ![Alt text](https://user-images.githubusercontent.com/83201188/123376803-b605fd80-d5a8-11eb-94ce-42f38dca99a1.png) * Click on your application. -* You will find your **Client id**,**Client secret** and **Okta domain**. +* You will find your **Client id**, **Client secret,** and **Okta domain**. ![Alt text](https://user-images.githubusercontent.com/83201188/123376795-b43c3a00-d5a8-11eb-8a83-f146959f31c9.png) @@ -61,7 +61,7 @@ ## Step 5: Adding the details in openmetadata-security.yaml -* Once the **Client Id**, **Client secret**, **issuer** and **audience** is generated. +* Once the **Client Id**, **Client secret**, **issuer,** and **audience** are generated. Add those details in openmetadata-security.yaml file in the respective field. diff --git a/docs/install/run-in-production.md b/docs/install/run-in-production.md index e325a15cf1b..18d84564c90 100644 --- a/docs/install/run-in-production.md +++ b/docs/install/run-in-production.md @@ -25,11 +25,11 @@ cd openmetdata-0.3.0 ./bin/openmetdata start ``` -We recommend to configure serviced to monitor openmetadata command to restart incase of any failures. +We recommend configuring serviced to monitor openmetadata command to restart in case of any failures. ## Running with a load balancer -One or more OpenMetadata instances can be put behind a load balancer for reverse proxying, in that case appropriate OpenMetdata url must be mentioned in the load balancer's configuraiton file. +One or more OpenMetadata instances can be put behind a load balancer for reverse proxying, in that case, an appropriate OpenMetdata URL must be mentioned in the load balancer's configuration file. For example, in case Apache mod proxy the VirtualHost tag in the configuration file should be edited out with the following diff --git a/docs/open-source-community/community.md b/docs/open-source-community/community.md index 34eb11051fd..2945e421a30 100644 --- a/docs/open-source-community/community.md +++ b/docs/open-source-community/community.md @@ -8,7 +8,7 @@ All OpenMetadata discussions happen on the [mailing list](community.md), [Github ## Github -Star us at [open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata) to follow the development. Ask questions, raise issues or contribute pull requests. Please see [Developers](https://github.com/open-metadata/OpenMetadata/blob/main/docs/open-source-community/developer/README.md) +Star us at [open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata) to follow the development. Ask questions, raise issues, or contribute pull requests. Please see [Developers](https://github.com/open-metadata/OpenMetadata/blob/main/docs/open-source-community/developer/README.md) ## Slack Channel diff --git a/docs/open-source-community/developer/build-code-run-tests.md b/docs/open-source-community/developer/build-code-run-tests.md index 8feee616af8..cff7c7372c8 100644 --- a/docs/open-source-community/developer/build-code-run-tests.md +++ b/docs/open-source-community/developer/build-code-run-tests.md @@ -2,7 +2,7 @@ ## Prerequisites -First of all you need to make sure you are using maven 3.5.x or higher and JDK 11 or higher. +First of all, you need to make sure you are using maven 3.5.x or higher and JDK 11 or higher. ## Building @@ -32,7 +32,7 @@ dist/target/open-metadata-.tar.gz ## Run instance through IntelliJ IDEA -1. Add new Run/Debug configuration like below screenshot. +1. Add new Run/Debug configuration like the below screenshot. ![Intellj Run Configuration](https://github.com/open-metadata/OpenMetadata/blob/main/docs/install/images/ingestion-bot-service-account.png) diff --git a/docs/open-source-community/developer/coding-style.md b/docs/open-source-community/developer/coding-style.md index 6ac380f5b32..8172508b327 100644 --- a/docs/open-source-community/developer/coding-style.md +++ b/docs/open-source-community/developer/coding-style.md @@ -11,9 +11,9 @@ description: >- 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. Maximum line length is 120. +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. -6. User documentation should be considered a part of any user-facing the feature, just like unit tests. Example REST apis should've accompanying documentation. +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. @@ -33,7 +33,7 @@ description: >- 4. No wildcard imports. 5. No unused imports. Remove all unused imports. -6. No raw types. Do not use raw generic types, unless strictly necessary \(sometime necessary for signature matches, arrays\). +6. No raw types. Do not use raw generic types, unless strictly necessary \(sometimes necessary for signature matches, arrays\). 7. Suppress warnings. Add annotations to suppress warnings, if they cannot be avoided \(such as “unchecked”, or “serial”\). 8. Comments. Add JavaDocs to public methods or inherit them by not adding any comments to the methods. 9. logger instance should be upper case LOG. @@ -63,7 +63,7 @@ description: >- 3. Logging statements should be complete sentences with proper capitalization that are written to be read by a person not necessarily familiar with the source code. 4. String appending using StringBuilders should not be used for building log messages. - Formatting should be used. For ex: + Formatting should be used. For example: LOG.debug\("Loaded class \[{}\] from jar \[{}\]", className, jarFile\);