From 0dfe39ba4f5106837cd3a3211f6077173562eccb Mon Sep 17 00:00:00 2001 From: John Smyth Date: Fri, 25 Oct 2024 10:14:52 -0500 Subject: [PATCH] proofread integrations --- docs/connect/index.md | 6 +++--- docs/develop/index.md | 2 +- docs/develop/query-api.md | 18 +++++++++--------- docs/integrations/aws.md | 10 +++++----- docs/integrations/azure.md | 6 +++--- docs/integrations/gcp.md | 10 +++++----- docs/integrations/github.md | 5 ++--- docs/integrations/slack.md | 6 +++--- 8 files changed, 31 insertions(+), 32 deletions(-) diff --git a/docs/connect/index.md b/docs/connect/index.md index 5a969d7..fb6c1bd 100644 --- a/docs/connect/index.md +++ b/docs/connect/index.md @@ -15,7 +15,7 @@ You can get the Postgres connection string and other database information from t ![](/images/docs/pipes/query-info-connect.png) -The **Database** tab will provide general database connection details - the **Connection String**, **Host**, **Port**, **Database**, **Username** and **Password**. Click on any field to copy it to your clipboard. Note that the password is masked on the screen, but clicking it will add the un-redacted text to your clipboard so that you can paste it into your tool's configuration screen. Individual users can access the database with their credentials, and the information in this view is specific to the logged in user, enabling secure, personalized access. +The **Database** tab will provide general database connection details - the **Connection String**, **Host**, **Port**, **Database**, **Username** and **Password**. Click on any field to copy it to your clipboard. Note that the password is masked on the screen, but clicking it will add the un-redacted text to your clipboard so that you can paste it into your tool's configuration screen. Individual users can access the database with their credentials, and the information in this view is specific to the logged-in user, enabling secure, personalized access. You can also get specific [Steampipe](https://steampipe.io/) commands from the **Steampipe CLI** tab: @@ -28,7 +28,7 @@ Or retrieve the [psql](/pipes/docs/connect/psql) and [pgcli](/pipes/docs/connect -## Examples of Postgres-Compatable Clients +## Examples of Postgres-Compatible Clients Our community leverages a diverse range of PostgreSQL clients to connect to Turbot Pipes. This flexibility accommodates different workflows, whether you prefer traditional SQL IDEs for database management, BI tools for data analysis and visualization, or [programming languages and SDKs](https://turbot.com/pipes/blog/2024/01/turbot-pipes-as-software-component) for custom integrations. ### SQL IDEs @@ -36,7 +36,7 @@ Our community leverages a diverse range of PostgreSQL clients to connect to Turb | Tool | Description | |------|-------------| | [Azure Data Studio](https://turbot.com/pipes/docs/connect/azuredatastudio) | Azure Data Studio is a cross-platform database tool for data professionals. | -| [DataGrip](https://turbot.com/pipes/docs/connect/datagrip) | DataGrip is a professional SQL IDE by JetBrains, designed for database developers. | +| [DataGrip](https://turbot.com/pipes/docs/connect/datagrip) | DataGrip is a professional SQL IDE by JetBrains designed for database developers. | | [DBeaver](https://turbot.com/pipes/docs/connect/dbeaver) | DBeaver is a free, multi-platform database tool for developers and database administrators. | | [dbt](https://turbot.com/pipes/docs/connect/dbt) | dbt is a transformation tool that enables data analysts and engineers to transform data in their warehouses. | | [Deepnote](https://turbot.com/pipes/docs/connect/deepnote) | Deepnote is a data science notebook for collaborative projects. | diff --git a/docs/develop/index.md b/docs/develop/index.md index 78c4b27..f0273bf 100644 --- a/docs/develop/index.md +++ b/docs/develop/index.md @@ -5,7 +5,7 @@ sidebar_label: Developers # Developers -Turbot Pipes is built by developers, for developers! It easy to manage your +Turbot Pipes is built by developers, for developers! It's easy to manage your cloud assets with our [REST API](/pipes/docs/reference/api) or [Go SDK](/pipes/docs/reference/gosdk), manage your Turbot Pipes infrastructure as code using our [Terraform provider](/pipes/docs/reference/terraform), or query your diff --git a/docs/develop/query-api.md b/docs/develop/query-api.md index ad0e39c..04dc630 100644 --- a/docs/develop/query-api.md +++ b/docs/develop/query-api.md @@ -19,21 +19,21 @@ export PIPES_TOKEN=tpt_c6rnjt8afakemj4gha10_svpnmxqfaketokenad431k ## Query Your Data -The Turbot Pipes API makes it easy query your data and integrate it into your +The Turbot Pipes API makes it easy to query your data and integrate it into your scripts and applications! You can issue a simple query with a GET request: ```bash curl -H "Authorization: Bearer ${PIPES_TOKEN}" \ - https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query?sql=select+*+from+aws_s3_bucket + https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query?sql=select+*+from+aws_s3_bucket ``` -If you POST you can avoid encoding the SQL: +If you POST, you can avoid encoding the SQL: ```bash curl -H "Authorization: Bearer ${PIPES_TOKEN}" \ - -d 'sql=select name,arn from aws_s3_bucket' \ + -d 'sql=select name,arn from aws_s3_bucket' \ https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query ``` @@ -43,7 +43,7 @@ results in CSV: ```bash curl -H "Authorization: Bearer ${PIPES_TOKEN}" \ - -d sql'=select name,arn from aws_s3_bucket' \ + -d sql'=select name,arn from aws_s3_bucket' \ https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query/my-file.csv ``` @@ -51,7 +51,7 @@ Or markdown: ```bash curl -H "Authorization: Bearer ${PIPES_TOKEN}" \ - -d sql'=select name,arn from aws_s3_bucket' \ + -d sql'=select name,arn from aws_s3_bucket' \ https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query/my-file.md ``` @@ -60,7 +60,7 @@ parameter: ```bash curl -H "Authorization: Bearer ${PIPES_TOKEN}" \ - -d sql'=select name,arn from aws_s3_bucket' \ + -d sql'=select name,arn from aws_s3_bucket' \ https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query?content_type=csv ``` @@ -68,7 +68,7 @@ Or via HTTP headers: ```bash curl -H "Authorization: Bearer ${PIPES_TOKEN}" \ - -H "Accept: text/csv" \ + -H "Accept: text/csv" \ -X POST -d sql='select name,arn from aws_s3_bucket' \ - https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query + https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query ``` diff --git a/docs/integrations/aws.md b/docs/integrations/aws.md index 0fc2620..d28cbe6 100644 --- a/docs/integrations/aws.md +++ b/docs/integrations/aws.md @@ -59,7 +59,7 @@ Configure the **Connection settings**. ![](/images/docs/pipes/org-integrations-aws-setup.png) -Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes, or to ensure the uniqueness of the generated connection handles. +Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes or to ensure the uniqueness of the generated connection handles. Next, set up the trust relationship for the discovered accounts. In order for Pipes to access the discovered accounts, a cross-account role must be created in each discovered account. You can set these roles up manually, or Pipes can generate a CloudFormation StackSet to help automate the process. Depending on your preference, follow the **Automatic Setup** or **Manual Setup** instructions, then enter the **Role Name** and **External ID**. Pipes will dynamically generate the **Role ARN** for each discovered account based on its ID and the provided **Role Name**. Choose the **Regions** that you would like configured in the child connections. @@ -72,7 +72,7 @@ These options will be inherited by all connections imported by the integration. @@ -86,7 +86,7 @@ Finally, select the [Permissions](/pipes/docs/accounts/tenant/connections#permis ![](/images/docs/pipes/org-integrations-perms.png) -The permissions on this screen apply to the top-level folders and therefore to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered. +The permissions on this screen apply to the top-level folders and, therefore, to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered. Note also that **All Workspaces** will not only add permissions for the existing organization workspaces but will also allow access for any new workspaces that are created. @@ -100,7 +100,7 @@ After you have created an integration, you can change its **Handle**, **Handle P *Modifying the integration after it has been created will potentially impact any workspaces that use its connections!* - Changing the **Handle Prefix** will change the handles of all of its connections. This means that the schema names will change in any workspace to which they are attached. The schema names, in turn, impact the search path and aggregators that use wildcards. -- Discovery of accounts and OUs occurs using the supplied **Credentials**. If changing the credentials affects access to these accounts and OUs that will be reflected in the folders and connections. For example, if the new credentials do not have access to some OUs or accounts that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached. +- Discovery of accounts and OUs occurs using the supplied **Credentials**. If changing the credentials affects access to these accounts and OUs, that will be reflected in the folders and connections. For example, if the new credentials do not have access to some OUs or accounts that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached. To modify the integration, navigate to the **Integrations** page for the appropriate resource: - To configure an AWS integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant. @@ -109,7 +109,7 @@ To modify the integration, navigate to the **Integrations** page for the appropr In the list of integrations, click the gear icon next to the integration that you want to modify. -You can change credentials used for discovert in the **Discovery Settings** section of the **Config** tab. +You can change credentials used for discovery in the **Discovery Settings** section of the **Config** tab. ![](/images/docs/pipes/org-integrations-aws-settings-config-discovery.png) You can also change the **Connection Settings** from the **Config** tab, including the **Handle Prefix**, **Regions**, the connection credentials, and the **Advanced Options**, diff --git a/docs/integrations/azure.md b/docs/integrations/azure.md index a1bbfbd..d654a6c 100644 --- a/docs/integrations/azure.md +++ b/docs/integrations/azure.md @@ -53,7 +53,7 @@ Enter the **Azure Credentials**. Pipes requires a Client ID and Client secret w Enter the **Tenant ID**, **Client ID**, and **Client Secret**. -Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes, or to ensure the uniqueness of the generated connection handles. +Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes or to ensure the uniqueness of the generated connection handles. Click the **Test Connection** button to verify that the credentials are configured correctly, then click **Next**. @@ -61,7 +61,7 @@ Finally, select the [Permissions](/pipes/docs/accounts/tenant/connections#permis ![](/images/docs/pipes/org-integrations-perms.png) -The permissions on this screen apply to the top-level folders and therefore to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered. +The permissions on this screen apply to the top-level folders and, therefore, to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered. Note also that **All Workspaces** will not only add permissions for the existing organization workspaces but will also allow access for any new workspaces that are created. @@ -75,7 +75,7 @@ After you have created an integration, you can change its **Handle**, **Handle P *Modifying the integration after it has been created will potentially impact any workspaces that use its connections!* - Changing the **Handle Prefix** will change the handles of all of its connections. This means that the schema names will change in any workspace to which they are attached. The schema names, in turn, impact the search path and aggregators that use wildcards. -- Discovery of subscriptions and management groups occurs using the supplied **Credentials**. If changing the credentials affects access to these subscriptions and management groups that will be reflected in the folders and connections. For example, if the new credentials do not have access to some management groups or subscriptions that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached. +- Discovery of subscriptions and management groups occurs using the supplied **Credentials**. If changing the credentials affects access to these subscriptions and management groups, that will be reflected in the folders and connections. For example, if the new credentials do not have access to some management groups or subscriptions that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached. To modify the integration, navigate to the **Integrations** page for the appropriate resource: - To configure an Azure integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant. diff --git a/docs/integrations/gcp.md b/docs/integrations/gcp.md index d7e999d..0fc5df2 100644 --- a/docs/integrations/gcp.md +++ b/docs/integrations/gcp.md @@ -20,8 +20,8 @@ You can create an integration for a [tenant](/pipes/docs/accounts/tenant/) or an First, navigate to the **Integrations** page for the appropriate resource: -- To configure an GCP integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant. -- To configure an GCP integration for your **Organization**, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the **Integrations** tab to manage the integrations for the organization. +- To configure a GCP integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant. +- To configure a GCP integration for your **Organization**, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the **Integrations** tab to manage the integrations for the organization. ![](/images/docs/pipes/org-integrations-tab.png) @@ -52,7 +52,7 @@ Configure the **Connection settings**. ![](/images/docs/pipes/org-integrations-gcp-connection.png) -Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes, or to ensure the uniqueness of the generated connection handles. +Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes or to ensure the uniqueness of the generated connection handles. If desired, you can click **Advanced Options** to set default settings for the imported connections. All connections created by the integration will inherit these settings, though you can override them later for each connection if you want. @@ -64,7 +64,7 @@ Finally, select the [Permissions](/pipes/docs/accounts/tenant/connections#permis ![](/images/docs/pipes/org-integrations-perms.png) -The permissions on this screen apply to the top-level folders and therefore to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered. +The permissions on this screen apply to the top-level folders and, therefore, to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered. Note also that **All Workspaces** will not only add permissions for the existing organization workspaces but will also allow access for any new workspaces that are created. @@ -85,7 +85,7 @@ To modify the integration, navigate to the **Integrations** page for the appropr In the list of integrations, click the gear icon next to the integration that you want to modify. -You can change the **Credentials**, **Handle Prefix** or **Advanced Settings** from the **Config** tab. +You can change the **Credentials**, **Handle Prefix**, or **Advanced Settings** from the **Config** tab. ![](/images/docs/pipes/org-integrations-gcp-settings-config.png) diff --git a/docs/integrations/github.md b/docs/integrations/github.md index 3ad1047..04b2c69 100644 --- a/docs/integrations/github.md +++ b/docs/integrations/github.md @@ -52,7 +52,7 @@ Select the GitHub user or organization that you would like to share with Turbot ![](/images/docs/pipes/integrations_github_choose_repos.png) -After you complete the GitHub setup, you will be redirected to the **Integrations** page. You should see your new integration in the list. If the state is **Enabled** then the setup is complete and Pipes will begin discovering the mods in your repositories. +After you complete the GitHub setup, you will be redirected to the **Integrations** page. You should see your new integration in the list. If the state is **Enabled**, then the setup is complete, and Pipes will begin discovering the mods in your repositories. ![](/images/docs/pipes/integrations_list_github_enabled.png) @@ -83,5 +83,4 @@ Navigate to the **Integrations** page for the appropriate resource: - To configure a Github integration for your **Organization**, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the **Integrations** tab to manage the integrations for the organization. - To configure a GitHub integration for your **Developer Account**, click the double arrow button from the navigation at the top of the page, select your account from the dropdown, and then select **Settings** from the menu on the left. On the organization settings page, select **Integrations**. -Go to the **Advanced** page and click the **Delete Integration** button. You will be asked to enter the handle to confirm deletion. If you wish to *permanently delete the integration and all of its resources*, click **Delete**. - +Go to the **Advanced** page and click the **Delete Integration** button. You will be asked to enter the handle to confirm deletion. If you wish to *permanently delete the integration and all of its resources*, click **Delete**. \ No newline at end of file diff --git a/docs/integrations/slack.md b/docs/integrations/slack.md index 338226f..20bbb0f 100644 --- a/docs/integrations/slack.md +++ b/docs/integrations/slack.md @@ -23,8 +23,8 @@ You can create an integration for a [tenant](/pipes/docs/accounts/tenant/) or an First, navigate to the **Integrations** page for the appropriate resource: -- To configure an GCP integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant. -- To configure an GCP integration for your **Organization**, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the **Integrations** tab to manage the integrations for the organization. +- To configure a Slack integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant. +- To configure a Slack integration for your **Organization**, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the **Integrations** tab to manage the integrations for the organization. ![](/images/docs/pipes/org-integrations-tab.png) @@ -39,7 +39,7 @@ Select **Slack** and click **Next**. Provide a **Handle** for the integration. This handle should be meaningful and must be unique for all integrations in the tenant (including any org-level integrations). Click **Create Integration**. -You will be prompted to grant permissions to access the Slack workspace. If you are a member of multiple workspaces, you can select a Slack workspace from the select box at the top right of the screen. After selecting the workspace, select a default **channel** for the integration. Review the permissions and click **Allow**. +You will be prompted to grant permission to access the Slack workspace. If you are a member of multiple workspaces, you can select a Slack workspace from the select box at the top right of the screen. After selecting the workspace, select a default **channel** for the integration. Review the permissions and click **Allow**. ![](/images/docs/pipes/slack_oauth_perms.png)