From 545e2fb95dafe14f1c28bd6acbdb0aa40691fa21 Mon Sep 17 00:00:00 2001 From: socar-dini <0327jane@gmail.com> Date: Wed, 20 Sep 2023 11:23:09 +0900 Subject: [PATCH] fix: fix grammer --- .../looker/configuration.md | 24 +++++++------- .../quick-ingestion-guides/looker/overview.md | 8 ++--- docs/quick-ingestion-guides/looker/setup.md | 32 +++++++++---------- 3 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/quick-ingestion-guides/looker/configuration.md b/docs/quick-ingestion-guides/looker/configuration.md index 530a5f91aace8..d9ba1907b006e 100644 --- a/docs/quick-ingestion-guides/looker/configuration.md +++ b/docs/quick-ingestion-guides/looker/configuration.md @@ -3,23 +3,23 @@ title: Configuration --- # Configuring Looker & LookML Connector -Now that you have created a DataHub specific API key with the relevant access in [the prior step](setup.md), it's now time to set up a connection via the DataHub UI. +Now that you have created a DataHub-specific API key with the relevant access in [the prior step](setup.md), it's time to set up a connection via the DataHub UI. ## Configure Secrets -You have to create two secrets to configure connection with Looker or LookerML. +You must create two secrets to configure a connection with Looker or LookerML. * `LOOKER_CLIENT_ID` * `LOOKER_CLIENT_SECRET` -On your DataHub instance, navigate to the **Ingestion** tab in the top, right corner of your screen. +On your DataHub instance, navigate to the **Ingestion** tab in your screen's top right corner.

Navigate to the "Ingestion Tab"

:::note -If you do not see the Ingestion tab, please contact your DataHub admin to grant you the correct permissions +If you do not see the Ingestion tab, please get in touch with your DataHub admin to grant you the correct permissions. ::: Navigate to the **Secrets** tab and click **Create new secret**. @@ -85,7 +85,7 @@ Your recipe should look something like this: ### Schedule Execution -Now it's time to schedule a recurring ingestion pipeline to regularly extract metadata from your Looker instance. +Now, it's time to schedule a recurring ingestion pipeline to extract metadata from your Looker instance regularly. Decide how regularly you want this ingestion to run-- day, month, year, hour, minute, etc. Select from the dropdown. @@ -117,7 +117,7 @@ You will now find your new ingestion source running. ## Configure LookML Connector -Now that you have created a DataHub specific API key and Deploy Key with the relevant access in [the prior step](setup.md), it's now time to set up a connection via the DataHub UI. +Now that you have created a DataHub-specific API key and Deploy Key with the relevant access in [the prior step](setup.md), it's time to set up a connection via the DataHub UI. ### Configure Recipe @@ -133,9 +133,9 @@ Choose `LooML`. Select Looker from the options

-Enter the details into the Looker Recipe. You need to set minimum 5 field in the recipe for this quick ingestion guide: +Enter the details into the Looker Recipe. You need to set a minimum 5 fields in the recipe for this quick ingestion guide: -* **GitHub Repository:** This is your github repository where LookML model are stored. You can provide full URL (example: https://gitlab.com/gitlab-org/gitlab) or organization/repo in this case connector assume it is GitHub repo +* **GitHub Repository:** This is your GitHub repository where LookML models are stored. You can provide the full URL (example: https://gitlab.com/gitlab-org/gitlab) or organization/repo; in this case, the connector assume it is a GitHub repo * **GitHub Deploy Key:** Copy the content of `looker_datahub_deploy_key` and paste into this filed. * **Looker Base URL:** This is your looker instance URL. (i.e. https://abc.cloud.looker.com) * **Looker Client ID:** Use the secret LOOKER_CLIENT_ID with the format `${LOOKER_CLIENT_ID}`. @@ -152,9 +152,9 @@ After completing the recipe, click **Next**. ### Schedule Execution -Now it's time to schedule a recurring ingestion pipeline to regularly extract metadata from your Looker instance. +Now, it's time to schedule a recurring ingestion pipeline to extract metadata from your Looker instance regularly. -Decide how regularly you want this ingestion to run-- day, month, year, hour, minute, etc. Select from the dropdown +Decide how regularly you want this ingestion to run-- day, month, year, hour, minute, etc. Select from the dropdown.

schedule selector @@ -188,7 +188,7 @@ View the latest status of ingestion runs on the Ingestion page. ingestion succeeded

-Click the `+` sign to expand the full list of historical runs and outcomes; click **Details** to see the outcomes of a specific run. +Click the `+` sign to expand the complete list of historical runs and outcomes; click **Details** to see the results of a specific run.

ingestion_details @@ -209,4 +209,4 @@ Pick an entity from the list to manually validate if it contains the detail you **Congratulations!** You've successfully set up Looker & LookML as an ingestion source for DataHub! -*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!* \ No newline at end of file +*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!* diff --git a/docs/quick-ingestion-guides/looker/overview.md b/docs/quick-ingestion-guides/looker/overview.md index 731e487e01d79..843d704526bcc 100644 --- a/docs/quick-ingestion-guides/looker/overview.md +++ b/docs/quick-ingestion-guides/looker/overview.md @@ -6,7 +6,7 @@ title: Overview ## What You Will Get Out of This Guide This guide will help you set up the Looker & LookML connectors to begin ingesting metadata into DataHub. -Upon completing this guide, you will have a recurring ingestion pipeline that will extract metadata from Looker & LookML and load it into DataHub. +Upon completing this guide, you will have a recurring ingestion pipeline to extract metadata from Looker & LookML and load it into DataHub. ### Looker @@ -27,7 +27,7 @@ To get complete Looker metadata integration (including Looker views and lineage ### LookML -LookMl connector will include to following LookML asset types: +LookMl connector will include the following LookML asset types: * [LookML views from model files in a project](https://cloud.google.com/looker/docs/reference/param-view-view) * [Metadata for dimensions](https://cloud.google.com/looker/docs/reference/param-field-dimension) @@ -41,7 +41,7 @@ To get complete Looker metadata integration (including Looker views and lineage ::: ## Next Steps -Continue to the [setup guide](setup.md), where we'll describe the prerequisites. +Please continue to the [setup guide](setup.md), where we'll describe the prerequisites. ### Reference @@ -49,4 +49,4 @@ If you want to ingest metadata from Looker using the DataHub CLI, check out the * Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md) * [Looker Ingestion Source](https://datahubproject.io/docs/generated/ingestion/sources/Looker) -*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!* \ No newline at end of file +*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!* diff --git a/docs/quick-ingestion-guides/looker/setup.md b/docs/quick-ingestion-guides/looker/setup.md index 7b40cade493b3..c08de116895ea 100644 --- a/docs/quick-ingestion-guides/looker/setup.md +++ b/docs/quick-ingestion-guides/looker/setup.md @@ -6,7 +6,7 @@ title: Setup ## Looker Prerequisites -In order to configure ingestion from Looker, you'll first have to ensure you have an API key to access the Looker resources. +To configure ingestion from Looker, you'll first have to ensure you have an API key to access the Looker resources. ### Login To Looker Instance @@ -30,7 +30,7 @@ On **Roles Panel**, click **New Permission Set**. Looker new permission set

-Set name for the new permission set (e.g. *DataHub Connector Permission Set*) and select the following permissions. +Set a name for the new permission set (e.g., *DataHub Connector Permission Set*) and select the following permissions.
Permission List @@ -61,13 +61,13 @@ After selecting all permissions mentioned above, click **New Permission Set** at ### Create A Role -On **Roles** Panel, click **New Role**. +On the **Roles** Panel, click **New Role**.

Looker new role button

-Set name for the new role (e.g. *DataHub Extractor*) and set following fields on this window. +Set the name for the new role (e.g., *DataHub Extractor*) and set the following fields on this window. - Set **Permission Set** to permission set created in previous step (i.e *DataHub Connector Permission Set*) - Set **Model Set** to `All` @@ -80,7 +80,7 @@ Finally, click **New Role** at the bottom of the page. ### Create A New User -On **Admin** Panel, click **Users** to open users panel. +On the **Admin** Panel, click **Users** to open the users panel.

Looker user search @@ -92,7 +92,7 @@ Click **Add Users**. Looker add user

-On **Adding a new user**, set detail in following fields. +On **Adding a new user**, set details in the following fields. - Add user's **Email Addresses**. - Set **Roles** to the role created in previous step (e.g. *DataHub Extractor*) @@ -105,52 +105,52 @@ Finally, click **Save**. ### Create An API Key -On **User** Panel, click on the newly created user. +On the **User** Panel, click on the newly created user.

Looker user panel

-Click **Edit Keys** to open **API Key** Panel. +Click **Edit Keys** to open the **API Key** Panel.

Looker user view

-On **API Key** Panel, click **New API Key** to generate a new **Client Id** and **Client Secret**. +On the **API Key** Panel, click **New API Key** to generate a new **Client ID** and **Client Secret**.

Looker new api key

## LookML Prerequisites -Follow below steps to create GitHub Deploy Key. +Follow the below steps to create the GitHub Deploy Key. -### Generate a private-public ssh key pair +### Generate a private-public SSH key pair ```bash ssh-keygen -t rsa -f looker_datahub_deploy_key ``` -This will typically generate two file like below. +This will typically generate two files like the one below. * `looker_datahub_deploy_key` (private key) * `looker_datahub_deploy_key.pub` (public key) ### Add Deploy Key to GitHub Repository -First, login to [GitHub](https://github.com). +First, log in to [GitHub](https://github.com). -Navigate to **GitHub Repository** -> **Settings** -> **Deploy Keys** and add public key (e.g. `looker_datahub_deploy_key.pub`) as deploy key with read access. +Navigate to **GitHub Repository** -> **Settings** -> **Deploy Keys** and add a public key (e.g. `looker_datahub_deploy_key.pub`) as deploy key with read access.

Looker home page

-Make note of the private key file, you will need to paste the contents of the file into the GitHub Deploy Key field later while [configuring](./configuration.md) ingestion on DataHub Portal. +Make a note of the private key file. You must paste the file's contents into the GitHub Deploy Key field later while [configuring](./configuration.md) ingestion on the DataHub Portal. ## Next Steps Once you've done all the above steps, it's time to move on to [configuring the actual ingestion source](configuration.md) within DataHub. -_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_ +_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_ \ No newline at end of file