From 35ae9b2852aaa81b6c8c2a505441aa2b2c08892c Mon Sep 17 00:00:00 2001 From: Joseph Shearer Date: Mon, 24 Jul 2023 11:53:38 -0400 Subject: [PATCH] Move things around per Olivia's comment --- site/docs/concepts/README.md | 2 +- site/docs/concepts/advanced/journals.md | 2 +- site/docs/concepts/advanced/shards.md | 2 +- site/docs/concepts/collections.md | 2 +- site/docs/concepts/schemas.md | 2 +- .../index.md => storage-mappings.md} | 6 +- .../concepts/storage-mappings/_category_.json | 4 - .../concepts/storage-mappings/azure-blob.mdx | 42 ---- site/docs/concepts/web-app.md | 2 +- .../Azure_AD_Tenant_ID.png | Bin .../Azure_Container_ID.png | Bin .../Azure_Storage_Account_Name.png | Bin .../azureAuthorize.jsx | 0 site/docs/getting-started/installation.md | 145 -------------- site/docs/getting-started/installation.mdx | 186 ++++++++++++++++++ .../tutorials/continuous-materialized-view.md | 2 +- .../guides/flowctl/edit-draft-from-webapp.md | 4 +- .../flowctl/edit-specification-locally.md | 4 +- site/docs/guides/flowctl/troubleshoot-task.md | 4 +- site/docs/overview/README.md | 2 +- 20 files changed, 203 insertions(+), 208 deletions(-) rename site/docs/concepts/{storage-mappings/index.md => storage-mappings.md} (80%) delete mode 100644 site/docs/concepts/storage-mappings/_category_.json delete mode 100644 site/docs/concepts/storage-mappings/azure-blob.mdx rename site/docs/{concepts/storage-mappings => getting-started}/Azure_AD_Tenant_ID.png (100%) rename site/docs/{concepts/storage-mappings => getting-started}/Azure_Container_ID.png (100%) rename site/docs/{concepts/storage-mappings => getting-started}/Azure_Storage_Account_Name.png (100%) rename site/docs/{concepts/storage-mappings => getting-started}/azureAuthorize.jsx (100%) delete mode 100644 site/docs/getting-started/installation.md create mode 100644 site/docs/getting-started/installation.mdx diff --git a/site/docs/concepts/README.md b/site/docs/concepts/README.md index 90e9508a91..5a898b8883 100644 --- a/site/docs/concepts/README.md +++ b/site/docs/concepts/README.md @@ -247,7 +247,7 @@ A given capture or materialization may have multiple bindings, which connect mul Flow [collections](#collections) use cloud storage buckets for the durable storage of data. Storage mappings define how Flow maps your various collections into your storage buckets and prefixes. -[Learn more about storage mappings](./storage-mappings/index.md) +[Learn more about storage mappings](./storage-mappings.md) ## Advanced concepts diff --git a/site/docs/concepts/advanced/journals.md b/site/docs/concepts/advanced/journals.md index e545340b2b..1cc304ce62 100644 --- a/site/docs/concepts/advanced/journals.md +++ b/site/docs/concepts/advanced/journals.md @@ -105,7 +105,7 @@ collections: retention: 720h ``` -Your [storage mappings](../storage-mappings/index.md) determine +Your [storage mappings](../storage-mappings.md) determine which of your cloud storage buckets is used for storage of collection fragment files. diff --git a/site/docs/concepts/advanced/shards.md b/site/docs/concepts/advanced/shards.md index 3bd6b149d9..bbb350d59b 100644 --- a/site/docs/concepts/advanced/shards.md +++ b/site/docs/concepts/advanced/shards.md @@ -65,4 +65,4 @@ However, they can hold your user data. Recovery logs of [derivations](../derivations.md) hold your derivation register values. Recovery logs are stored in your cloud storage bucket, -and must have a configured [storage mapping](../storage-mappings/index.md#recovery-logs). \ No newline at end of file +and must have a configured [storage mapping](../storage-mappings.md#recovery-logs). \ No newline at end of file diff --git a/site/docs/concepts/collections.md b/site/docs/concepts/collections.md index e0e81427d0..fb6b49d838 100644 --- a/site/docs/concepts/collections.md +++ b/site/docs/concepts/collections.md @@ -349,7 +349,7 @@ regular JSON files in your cloud storage bucket. Reads of that history are served by directly reading files from your bucket. -Your [storage mappings](./storage-mappings/index.md) +Your [storage mappings](./storage-mappings.md) determine how Flow collections are mapped into your cloud storage buckets. diff --git a/site/docs/concepts/schemas.md b/site/docs/concepts/schemas.md index dd10d4aec7..0369dff35c 100644 --- a/site/docs/concepts/schemas.md +++ b/site/docs/concepts/schemas.md @@ -327,7 +327,7 @@ reduce: { strategy: merge } ``` Learn more in the -[reductions strategies](../../reference/reduction-strategies/) +[reduction strategies](../../reference/reduction-strategies/) reference documentation. #### Reductions and collection keys diff --git a/site/docs/concepts/storage-mappings/index.md b/site/docs/concepts/storage-mappings.md similarity index 80% rename from site/docs/concepts/storage-mappings/index.md rename to site/docs/concepts/storage-mappings.md index cd5dd72246..bddeb23637 100644 --- a/site/docs/concepts/storage-mappings/index.md +++ b/site/docs/concepts/storage-mappings.md @@ -1,13 +1,13 @@ --- -sidebar_position: 1 +sidebar_position: 8 --- # Storage mappings Flow stores the documents that comprise your collections in a cloud storage bucket. Your **storage mapping** tells Flow which bucket to use. -Every Flow organization (defined by its [catalog prefix](../catalogs.md#namespace)) has a storage mapping defined during setup. -When you're provisioned a prefix, your Estuary account manager will help you [set up your storage mapping](../../getting-started/installation.md#configuring-your-cloud-storage-bucket-for-use-with-flow). +Every Flow organization (defined by its [catalog prefix](./catalogs.md#namespace)) has a storage mapping defined during setup. +When you're provisioned a prefix, your Estuary account manager will help you [set up your storage mapping](../getting-started/installation.mdx#configuring-your-cloud-storage-bucket-for-use-with-flow). If you have a trial account, your storage mapping is Estuary's secure Google Cloud Storage bucket. You can set up a bucket lifecycle policy to manage data retention in your storage mapping; diff --git a/site/docs/concepts/storage-mappings/_category_.json b/site/docs/concepts/storage-mappings/_category_.json deleted file mode 100644 index 370b5938fe..0000000000 --- a/site/docs/concepts/storage-mappings/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Storage Mappings", - "position": 4 -} diff --git a/site/docs/concepts/storage-mappings/azure-blob.mdx b/site/docs/concepts/storage-mappings/azure-blob.mdx deleted file mode 100644 index 08b390a5cf..0000000000 --- a/site/docs/concepts/storage-mappings/azure-blob.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 2 -title: Azure Blob Storage ---- - -Setting up a Flow account to store data in your Azure Blob storage account requires you to grant our application access to your storage account and container, as well as providing us with some identifying information. At the moment storage mappings are not self-service, so once you have granted access and gathered the required information, reach out to your account manager who will configure your account. - -### Gathering information - -In order to complete this process, you will need to gather the following data: - -- Your **Azure AD tenant ID**. This can be found in the "Azure Active Directory" page here: - ![](Azure_AD_Tenant_ID.png) -- Your **Azure Blob Storage account ID**. This can be found in the "Storage Accounts" page here: - ![](Azure_Storage_Account_Name.png) -- Your **Azure Blob Storage container ID**. This can be found inside your storage account here: - ![](Azure_Container_ID.png) - -### Granting Access - -We use an [Azure Application](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/what-is-application-management) to allow granting access to storage resources between your tenant and ours. In order for Flow to write to your storage account, it needs the [`Storage Blob Data Owner`](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#storage-blob-data-owner) IAM role for the storage account in question. In order to grant this role, you must first add our application to your tenant. - -#### Add application to your tenant - -import { AzureAuthorizeComponent } from "./azureAuthorize"; -import BrowserOnly from "@docusaurus/BrowserOnly"; - -{() => } - -#### Authorize application to your storage account - -Once the application has been added, you must grant it the [`Storage Blob Data Owner`](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#storage-blob-data-owner) IAM role for your storage account. - -- Inside your storage account's "Access Control (IAM)" tab, click "Add Role Assignment" -- Search for the string `Storage Blob Data Owner` and select it -- On the next page, make sure `User, group, or service principal` is selected, then click "+ Select Members" -- You must search for the exact name of the application, otherwise it won't show up: `Estuary Storage Mappings Prod` -- Once you've selected the application, finish granting the role and you should be all set - -### Give us a ring - -Once you've finished the above steps, the next part is to contact us. Self-service storage mapping configuration is on our roadmap, but for the moment we're happy to configure your account by hand. Send support@estuary.dev an email containing all of the information you gathered above, as well as whether you want the storage mapping to apply to your whole Flow account, or just a subset of it. We'll get back to you letting you know when it's done, and that's it! diff --git a/site/docs/concepts/web-app.md b/site/docs/concepts/web-app.md index 784cc8ae6b..85aa2bfb6f 100644 --- a/site/docs/concepts/web-app.md +++ b/site/docs/concepts/web-app.md @@ -287,7 +287,7 @@ You typically have just one prefix: your organization name, which you provided w If you're a trial user, your prefix is `trial/`, and this tab isn't applicable to you; your data is stored temporarily in Estuary's cloud storage bucket for your trial period. -[Learn more about storage mappings.](./storage-mappings/index.md) +[Learn more about storage mappings.](./storage-mappings.md) #### Connectors diff --git a/site/docs/concepts/storage-mappings/Azure_AD_Tenant_ID.png b/site/docs/getting-started/Azure_AD_Tenant_ID.png similarity index 100% rename from site/docs/concepts/storage-mappings/Azure_AD_Tenant_ID.png rename to site/docs/getting-started/Azure_AD_Tenant_ID.png diff --git a/site/docs/concepts/storage-mappings/Azure_Container_ID.png b/site/docs/getting-started/Azure_Container_ID.png similarity index 100% rename from site/docs/concepts/storage-mappings/Azure_Container_ID.png rename to site/docs/getting-started/Azure_Container_ID.png diff --git a/site/docs/concepts/storage-mappings/Azure_Storage_Account_Name.png b/site/docs/getting-started/Azure_Storage_Account_Name.png similarity index 100% rename from site/docs/concepts/storage-mappings/Azure_Storage_Account_Name.png rename to site/docs/getting-started/Azure_Storage_Account_Name.png diff --git a/site/docs/concepts/storage-mappings/azureAuthorize.jsx b/site/docs/getting-started/azureAuthorize.jsx similarity index 100% rename from site/docs/concepts/storage-mappings/azureAuthorize.jsx rename to site/docs/getting-started/azureAuthorize.jsx diff --git a/site/docs/getting-started/installation.md b/site/docs/getting-started/installation.md deleted file mode 100644 index 063db497fd..0000000000 --- a/site/docs/getting-started/installation.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Registration and setup - -Estuary Flow is a fully managed web application that also offers a robust CLI. - -Flow is currently in public beta beta. - -## Get started with the Flow web application - -You can get started with a Flow trial by visiting the web application [here](https://go.estuary.dev/dashboard). - -As a trial user, you can create one end-to-end Data Flow. -Trial user data is deleted from Flow after 30 days. - -To skip the limitations of the trial and begin with an organizational account instead, [contact the Estuary team](mailto:support@estuary.dev). - -## Get started with the Flow CLI - -After your account has been activated through the [web app](#get-started-with-the-flow-web-application), you can begin to work with your data flows from the command line. -This is not required, but it enables more advanced workflows or might simply be your preference. - -Flow has a single binary, **flowctl**. - -flowctl is available for: - -* **Linux** x86-64. All distributions are supported. -* **MacOS** 11 (Big Sur) or later. Both Intel and M1 chips are supported. - -To install, copy and paste the appropriate script below into your terminal. This will download flowctl, make it executable, and add it to your `PATH`. - - * For Linux: - ```console - sudo curl -o /usr/local/bin/flowctl -L 'https://github.com/estuary/flow/releases/latest/download/flowctl-x86_64-linux' && sudo chmod +x /usr/local/bin/flowctl - ``` - - * For Mac: - ```console - sudo curl -o /usr/local/bin/flowctl -L 'https://github.com/estuary/flow/releases/latest/download/flowctl-multiarch-macos' && sudo chmod +x /usr/local/bin/flowctl - ``` - - Alternatively, Mac users can install with Homebrew: - ```console - brew tap estuary/flowctl - brew install flowctl - ``` - -flowctl isn't currently available for Windows. -For Windows users, we recommend running the Linux version inside [WSL](https://learn.microsoft.com/en-us/windows/wsl/), -or using a remote development environment. - -The flowctl source files are also on GitHub [here](https://go.estuary.dev/flowctl). - -Once you've installed flowctl and are ready to begin working, authenticate your session using an access token. - -1. Ensure that you have an Estuary account and have signed into the Flow web app before. - -2. In the terminal of your local development environment, run: - ``` console - flowctl auth login - ``` - In a browser window, the web app opens to the CLI-API tab. - -3. Copy the access token. - -4. Return to the terminal, paste the access token, and press Enter. - -The token will expire after a predetermined duration. Repeat this process to re-authenticate. - - -[Learn more about using flowctl.](../concepts/flowctl.md) - -## Configuring your cloud storage bucket for use with Flow - -During your trial period, Flow uses Estuary's cloud storage to temporarily store your data. -When you upgrade from a trial to an organizational account, you're provisioned a unique [prefix](../concepts/catalogs.md#namespace) in the Flow namespace, -and transition to using your own cloud storage bucket to store your Flow data. This is called a [storage mapping](../concepts/storage-mappings/index.md). - -Flow supports Google Cloud Storage and Amazon S3 buckets. -Before your account manager configures your bucket as your storage mapping, you must grant access to Estuary. - -#### Google Cloud Storage buckets - -Follow the steps to [add a principal to a bucket level policy](https://cloud.google.com/storage/docs/access-control/using-iam-permissions#bucket-add). - -* For the principal, enter `flow-258@helpful-kingdom-273219.iam.gserviceaccount.com` -* Select the [`roles/storage.admin`](https://cloud.google.com/storage/docs/access-control/iam-roles) role. - -#### Amazon S3 buckets - -:::info -Your S3 bucket must be in the us-east-1 [region](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html) for use with Flow. -::: - -Follow the steps to [add a bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/add-bucket-policy.html), pasting the policy below. -Be sure to replace `YOUR-S3-BUCKET` with the actual name of your bucket. - -```json -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "AllowUsersToAccessObjectsUnderPrefix", - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::789740162118:user/flow-aws" - }, - "Action": [ - "s3:GetObject", - "s3:PutObject" - ], - "Resource": "arn:aws:s3:::YOUR-S3-BUCKET/*" - }, - { - "Effect": "Allow", - "Principal": { - "AWS": "arn:aws:iam::789740162118:user/flow-aws" - }, - "Action": "s3:ListBucket", - "Resource": "arn:aws:s3:::YOUR-S3-BUCKET" - } - ] -} -``` - -## Self-hosting Flow - -The Flow runtime is available under the [Business Source License](https://github.com/estuary/flow/blob/master/LICENSE-BSL). It's possible to self-host Flow using a cloud provider of your choice. - -:::caution Beta -Setup for self-hosting is not covered in this documentation, and full support is not guaranteed at this time. -We recommend using the [hosted version of Flow](#get-started-with-the-flow-web-application) for the best experience. -If you'd still like to self-host, refer to the [GitHub repository](https://github.com/estuary/flow) or the [Estuary Slack](https://join.slack.com/t/estuary-dev/shared_invite/zt-86nal6yr-VPbv~YfZE9Q~6Zl~gmZdFQ). -::: - -## What's next? - -Start using Flow with these recommended resources. - -* **[Create your first data flow](../guides/create-dataflow.md)**: -Follow this guide to create your first data flow in the Flow web app, while learning essential flow concepts. - -* **[High level concepts](../concepts/README.md)**: Start here to learn more about important Flow terms. \ No newline at end of file diff --git a/site/docs/getting-started/installation.mdx b/site/docs/getting-started/installation.mdx new file mode 100644 index 0000000000..de5373ee5d --- /dev/null +++ b/site/docs/getting-started/installation.mdx @@ -0,0 +1,186 @@ +--- +sidebar_position: 1 +--- + +# Registration and setup + +Estuary Flow is a fully managed web application that also offers a robust CLI. + +Flow is currently in public beta beta. + +## Get started with the Flow web application + +You can get started with a Flow trial by visiting the web application [here](https://go.estuary.dev/dashboard). + +As a trial user, you can create one end-to-end Data Flow. +Trial user data is deleted from Flow after 30 days. + +To skip the limitations of the trial and begin with an organizational account instead, [contact the Estuary team](mailto:support@estuary.dev). + +## Get started with the Flow CLI + +After your account has been activated through the [web app](#get-started-with-the-flow-web-application), you can begin to work with your data flows from the command line. +This is not required, but it enables more advanced workflows or might simply be your preference. + +Flow has a single binary, **flowctl**. + +flowctl is available for: + +- **Linux** x86-64. All distributions are supported. +- **MacOS** 11 (Big Sur) or later. Both Intel and M1 chips are supported. + +To install, copy and paste the appropriate script below into your terminal. This will download flowctl, make it executable, and add it to your `PATH`. + +- For Linux: + +```console +sudo curl -o /usr/local/bin/flowctl -L 'https://github.com/estuary/flow/releases/latest/download/flowctl-x86_64-linux' && sudo chmod +x /usr/local/bin/flowctl +``` + +- For Mac: + +```console +sudo curl -o /usr/local/bin/flowctl -L 'https://github.com/estuary/flow/releases/latest/download/flowctl-multiarch-macos' && sudo chmod +x /usr/local/bin/flowctl +``` + +Alternatively, Mac users can install with Homebrew: + +```console +brew tap estuary/flowctl +brew install flowctl +``` + +flowctl isn't currently available for Windows. +For Windows users, we recommend running the Linux version inside [WSL](https://learn.microsoft.com/en-us/windows/wsl/), +or using a remote development environment. + +The flowctl source files are also on GitHub [here](https://go.estuary.dev/flowctl). + +Once you've installed flowctl and are ready to begin working, authenticate your session using an access token. + +1. Ensure that you have an Estuary account and have signed into the Flow web app before. + +2. In the terminal of your local development environment, run: + + ```console + flowctl auth login + ``` + + In a browser window, the web app opens to the CLI-API tab. + +3. Copy the access token. + +4. Return to the terminal, paste the access token, and press Enter. + +The token will expire after a predetermined duration. Repeat this process to re-authenticate. + +[Learn more about using flowctl.](../concepts/flowctl.md) + +## Configuring your cloud storage bucket for use with Flow + +During your trial period, Flow uses Estuary's cloud storage to temporarily store your data. +When you upgrade from a trial to an organizational account, you're provisioned a unique [prefix](../concepts/catalogs.md#namespace) in the Flow namespace, +and transition to using your own cloud storage bucket to store your Flow data. This is called a [storage mapping](../concepts/storage-mappings.md). + +Flow supports Google Cloud Storage and Amazon S3 buckets. +Before your account manager configures your bucket as your storage mapping, you must grant access to Estuary. + +### Google Cloud Storage buckets + +Follow the steps to [add a principal to a bucket level policy](https://cloud.google.com/storage/docs/access-control/using-iam-permissions#bucket-add). + +- For the principal, enter `flow-258@helpful-kingdom-273219.iam.gserviceaccount.com` +- Select the [`roles/storage.admin`](https://cloud.google.com/storage/docs/access-control/iam-roles) role. + +### Amazon S3 buckets + +:::info +Your S3 bucket must be in the us-east-1 [region](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html) for use with Flow. +::: + +Follow the steps to [add a bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/add-bucket-policy.html), pasting the policy below. +Be sure to replace `YOUR-S3-BUCKET` with the actual name of your bucket. + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "AllowUsersToAccessObjectsUnderPrefix", + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::789740162118:user/flow-aws" + }, + "Action": ["s3:GetObject", "s3:PutObject"], + "Resource": "arn:aws:s3:::YOUR-S3-BUCKET/*" + }, + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::789740162118:user/flow-aws" + }, + "Action": "s3:ListBucket", + "Resource": "arn:aws:s3:::YOUR-S3-BUCKET" + } + ] +} +``` + +### Azure Blob Storage + +Setting up a Flow account to store data in your Azure Blob storage account requires you to grant our application access to your storage account and container, as well as providing us with some identifying information. At the moment storage mappings are not self-service, so once you have granted access and gathered the required information, reach out to your account manager who will configure your account. + +#### Gathering information + +In order to complete this process, you will need to gather the following data: + +- Your **Azure AD tenant ID**. This can be found in the "Azure Active Directory" page here: + ![](Azure_AD_Tenant_ID.png) +- Your **Azure Blob Storage account ID**. This can be found in the "Storage Accounts" page here: + ![](Azure_Storage_Account_Name.png) +- Your **Azure Blob Storage container ID**. This can be found inside your storage account here: + ![](Azure_Container_ID.png) + +#### Granting Access + +We use an [Azure Application](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/what-is-application-management) to allow granting access to storage resources between your tenant and ours. In order for Flow to write to your storage account, it needs the [`Storage Blob Data Owner`](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#storage-blob-data-owner) IAM role for the storage account in question. In order to grant this role, you must first add our application to your tenant. + +#### Add application to your tenant + +import { AzureAuthorizeComponent } from "./azureAuthorize"; +import BrowserOnly from "@docusaurus/BrowserOnly"; + +{() => } + +#### Authorize application to your storage account + +Once the application has been added, you must grant it the [`Storage Blob Data Owner`](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#storage-blob-data-owner) IAM role for your storage account. + +- Inside your storage account's "Access Control (IAM)" tab, click "Add Role Assignment" +- Search for the string `Storage Blob Data Owner` and select it +- On the next page, make sure `User, group, or service principal` is selected, then click "+ Select Members" +- You must search for the exact name of the application, otherwise it won't show up: `Estuary Storage Mappings Prod` +- Once you've selected the application, finish granting the role and you should be all set + +### Give us a ring + +Once you've finished the above steps, the next part is to contact us. Self-service storage mapping configuration is on our roadmap, but for the moment we're happy to configure your account by hand. Send support@estuary.dev an email containing all of the information you gathered above, as well as whether you want the storage mapping to apply to your whole Flow account, or just a subset of it. We'll get back to you letting you know when it's done, and that's it! + +## Self-hosting Flow + +The Flow runtime is available under the [Business Source License](https://github.com/estuary/flow/blob/master/LICENSE-BSL). It's possible to self-host Flow using a cloud provider of your choice. + +:::caution Beta +Setup for self-hosting is not covered in this documentation, and full support is not guaranteed at this time. +We recommend using the [hosted version of Flow](#get-started-with-the-flow-web-application) for the best experience. +If you'd still like to self-host, refer to the [GitHub repository](https://github.com/estuary/flow) or the [Estuary Slack](https://join.slack.com/t/estuary-dev/shared_invite/zt-86nal6yr-VPbv~YfZE9Q~6Zl~gmZdFQ). +::: + +## What's next? + +Start using Flow with these recommended resources. + +- **[Create your first data flow](../guides/create-dataflow.md)**: + Follow this guide to create your first data flow in the Flow web app, while learning essential flow concepts. + +- **[High level concepts](../concepts/README.md)**: Start here to learn more about important Flow terms. diff --git a/site/docs/getting-started/tutorials/continuous-materialized-view.md b/site/docs/getting-started/tutorials/continuous-materialized-view.md index e5d5bfe2e8..8a2319e25f 100644 --- a/site/docs/getting-started/tutorials/continuous-materialized-view.md +++ b/site/docs/getting-started/tutorials/continuous-materialized-view.md @@ -13,7 +13,7 @@ a materialized view that updates continuously based on a real-time data feed. * An Estuary Flow account. If you don't have one, visit the [Flow web app](https://dashboard.estuary.dev) to register for free. -* The [flowctl CLI installed](../installation.md#get-started-with-the-flow-cli) (for the optional section). +* The [flowctl CLI installed](../installation.mdx#get-started-with-the-flow-cli) (for the optional section). * A Postgres database for testing set up to [allow connections from Flow](../../reference/Connectors/materialization-connectors/PostgreSQL.md#setup). Amazon RDS, Amazon Aurora, Google Cloud SQL, Azure Database for PostgreSQL, and self-hosted databases are supported. diff --git a/site/docs/guides/flowctl/edit-draft-from-webapp.md b/site/docs/guides/flowctl/edit-draft-from-webapp.md index c488116f92..999ae3df55 100644 --- a/site/docs/guides/flowctl/edit-draft-from-webapp.md +++ b/site/docs/guides/flowctl/edit-draft-from-webapp.md @@ -25,9 +25,9 @@ you can pull the draft into a local environment, finish making changes, and publ To complete this workflow, you need: -* An [Estuary account](../../getting-started/installation.md) +* An [Estuary account](../../getting-started/installation.mdx) -* [flowctl installed locally](../../getting-started/installation.md#get-started-with-the-flow-cli) +* [flowctl installed locally](../../getting-started/installation.mdx#get-started-with-the-flow-cli) ## Identify the draft and pull it locally diff --git a/site/docs/guides/flowctl/edit-specification-locally.md b/site/docs/guides/flowctl/edit-specification-locally.md index 4480bee312..bbd3b58f5a 100644 --- a/site/docs/guides/flowctl/edit-specification-locally.md +++ b/site/docs/guides/flowctl/edit-specification-locally.md @@ -37,9 +37,9 @@ editing their specifications, and re-publishing them. To complete this workflow, you need: -* An [Estuary account](../../getting-started/installation.md#registration-and-setup) +* An [Estuary account](../../getting-started/installation.mdx#registration-and-setup) -* [flowctl installed locally](../../getting-started/installation.md#get-started-with-the-flow-cli) +* [flowctl installed locally](../../getting-started/installation.mdx#get-started-with-the-flow-cli) * One or more published Flow entities. (To edit unpublished drafts, [use this guide](./edit-draft-from-webapp.md).) diff --git a/site/docs/guides/flowctl/troubleshoot-task.md b/site/docs/guides/flowctl/troubleshoot-task.md index d8ede494c6..e0b6a2113a 100644 --- a/site/docs/guides/flowctl/troubleshoot-task.md +++ b/site/docs/guides/flowctl/troubleshoot-task.md @@ -14,9 +14,9 @@ If a task has errors or is failing in the web app, you'll be able to troubleshoo To complete this workflow, you need: -* An [Estuary account](../../getting-started/installation.md) +* An [Estuary account](../../getting-started/installation.mdx) -* [flowctl installed locally](../../getting-started/installation.md#get-started-with-the-flow-cli) +* [flowctl installed locally](../../getting-started/installation.mdx#get-started-with-the-flow-cli) ## Print task logs diff --git a/site/docs/overview/README.md b/site/docs/overview/README.md index 0c4f973421..87aab8de9a 100644 --- a/site/docs/overview/README.md +++ b/site/docs/overview/README.md @@ -33,7 +33,7 @@ and an open-source ecosystem of pluggable connectors for integrating your existi **Want to get up and running ASAP?** -See the [get started documentation](../getting-started/installation.md). +See the [get started documentation](../getting-started/installation.mdx). **Wondering if Flow is right for you?**