From 773f15a2ce937aa79020eccfc802e65831af2bfd Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Fri, 15 Nov 2024 17:36:24 -0500 Subject: [PATCH] Update links in blocks to not point to docs from archived repositories (#16031) --- src/integrations/prefect-aws/README.md | 6 +--- .../prefect-aws/prefect_aws/credentials.py | 4 +-- .../prefect_aws/lambda_function.py | 2 +- .../prefect-aws/prefect_aws/s3.py | 4 +-- .../prefect_aws/secrets_manager.py | 2 +- .../prefect_aws/workers/ecs_worker.py | 2 +- .../prefect_azure/blob_storage.py | 2 +- .../prefect_azure/credentials.py | 8 ++--- .../workers/container_instance.py | 4 +-- .../prefect-dbt/prefect_dbt/cli/commands.py | 34 ++++++++++++------- .../prefect_dbt/cli/configs/base.py | 6 ++-- .../prefect_dbt/cli/configs/bigquery.py | 2 +- .../prefect_dbt/cli/configs/postgres.py | 2 +- .../prefect_dbt/cli/configs/snowflake.py | 2 +- .../prefect_dbt/cli/credentials.py | 2 +- .../prefect_dbt/cloud/credentials.py | 2 +- .../prefect-dbt/prefect_dbt/cloud/jobs.py | 2 +- .../prefect-docker/prefect_docker/worker.py | 2 +- .../prefect_email/credentials.py | 2 +- src/integrations/prefect-gcp/README.md | 10 ++---- .../prefect-gcp/prefect_gcp/bigquery.py | 2 +- .../prefect-gcp/prefect_gcp/cloud_storage.py | 2 +- .../prefect-gcp/prefect_gcp/credentials.py | 2 +- .../prefect-gcp/prefect_gcp/secret_manager.py | 2 +- .../prefect_gcp/workers/cloud_run.py | 2 +- .../prefect_gcp/workers/cloud_run_v2.py | 2 +- .../prefect-gcp/prefect_gcp/workers/vertex.py | 2 +- .../prefect_github/credentials.py | 2 +- .../prefect_github/repository.py | 2 +- .../prefect_kubernetes/credentials.py | 4 +-- .../prefect_kubernetes/jobs.py | 2 +- .../prefect_kubernetes/worker.py | 2 +- .../prefect-shell/prefect_shell/commands.py | 2 +- .../prefect_slack/credentials.py | 4 +-- .../prefect_snowflake/credentials.py | 2 +- .../prefect_snowflake/database.py | 2 +- .../prefect_sqlalchemy/database.py | 2 +- 37 files changed, 66 insertions(+), 72 deletions(-) diff --git a/src/integrations/prefect-aws/README.md b/src/integrations/prefect-aws/README.md index 5526f03c5dbe..fbd323352343 100644 --- a/src/integrations/prefect-aws/README.md +++ b/src/integrations/prefect-aws/README.md @@ -7,7 +7,7 @@

-## Welcome! +## Welcome `prefect-aws` makes it easy to leverage the capabilities of AWS in your flows, featuring support for ECS, S3, Secrets Manager, and Batch. @@ -18,7 +18,3 @@ To start using `prefect-aws`: ```bash pip install prefect-aws ``` - -### Contributing - -Thanks for thinking about chipping in! Check out this [step-by-step guide](https://prefecthq.github.io/prefect-aws/#installation) on how to get started. diff --git a/src/integrations/prefect-aws/prefect_aws/credentials.py b/src/integrations/prefect-aws/prefect_aws/credentials.py index 987a4c722660..7a8a4add88b3 100644 --- a/src/integrations/prefect-aws/prefect_aws/credentials.py +++ b/src/integrations/prefect-aws/prefect_aws/credentials.py @@ -70,7 +70,7 @@ class AwsCredentials(CredentialsBlock): _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/d74b16fe84ce626345adf235a47008fea2869a60-225x225.png" # noqa _block_type_name = "AWS Credentials" - _documentation_url = "https://prefecthq.github.io/prefect-aws/credentials/#prefect_aws.credentials.AwsCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-aws" # noqa aws_access_key_id: Optional[str] = Field( default=None, @@ -209,7 +209,7 @@ class MinIOCredentials(CredentialsBlock): "docs: https://docs.min.io/docs/minio-server-configuration-guide.html " "for more info about the possible credential configurations." ) - _documentation_url = "https://prefecthq.github.io/prefect-aws/credentials/#prefect_aws.credentials.MinIOCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-aws" # noqa minio_root_user: str = Field(default=..., description="Admin or root user.") minio_root_password: SecretStr = Field( diff --git a/src/integrations/prefect-aws/prefect_aws/lambda_function.py b/src/integrations/prefect-aws/prefect_aws/lambda_function.py index 8cbd14de1bca..6b778c48f407 100644 --- a/src/integrations/prefect-aws/prefect_aws/lambda_function.py +++ b/src/integrations/prefect-aws/prefect_aws/lambda_function.py @@ -79,7 +79,7 @@ class LambdaFunction(Block): _block_type_name = "Lambda Function" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/d74b16fe84ce626345adf235a47008fea2869a60-225x225.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-aws/s3/#prefect_aws.lambda_function.LambdaFunction" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-aws" # noqa function_name: str = Field( title="Function Name", diff --git a/src/integrations/prefect-aws/prefect_aws/s3.py b/src/integrations/prefect-aws/prefect_aws/s3.py index 84570728c3d2..39a3e9b7ea9c 100644 --- a/src/integrations/prefect-aws/prefect_aws/s3.py +++ b/src/integrations/prefect-aws/prefect_aws/s3.py @@ -403,9 +403,7 @@ class S3Bucket(WritableFileSystem, WritableDeploymentStorage, ObjectStorageBlock _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/d74b16fe84ce626345adf235a47008fea2869a60-225x225.png" # noqa _block_type_name = "S3 Bucket" - _documentation_url = ( - "https://prefecthq.github.io/prefect-aws/s3/#prefect_aws.s3.S3Bucket" # noqa - ) + _documentation_url = "https://docs.prefect.io/integrations/prefect-aws" # noqa bucket_name: str = Field(default=..., description="Name of your bucket.") diff --git a/src/integrations/prefect-aws/prefect_aws/secrets_manager.py b/src/integrations/prefect-aws/prefect_aws/secrets_manager.py index 0536f8175b9e..82a695d02141 100644 --- a/src/integrations/prefect-aws/prefect_aws/secrets_manager.py +++ b/src/integrations/prefect-aws/prefect_aws/secrets_manager.py @@ -367,7 +367,7 @@ class AwsSecret(SecretBlock): _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/d74b16fe84ce626345adf235a47008fea2869a60-225x225.png" # noqa _block_type_name = "AWS Secret" - _documentation_url = "https://prefecthq.github.io/prefect-aws/secrets_manager/#prefect_aws.secrets_manager.AwsSecret" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-aws" # noqa aws_credentials: AwsCredentials secret_name: str = Field(default=..., description="The name of the secret.") diff --git a/src/integrations/prefect-aws/prefect_aws/workers/ecs_worker.py b/src/integrations/prefect-aws/prefect_aws/workers/ecs_worker.py index 4d6da6127392..54cf62958350 100644 --- a/src/integrations/prefect-aws/prefect_aws/workers/ecs_worker.py +++ b/src/integrations/prefect-aws/prefect_aws/workers/ecs_worker.py @@ -654,7 +654,7 @@ class ECSWorker(BaseWorker): "and Fargate clusters. Requires an AWS account." ) _display_name = "AWS Elastic Container Service" - _documentation_url = "https://prefecthq.github.io/prefect-aws/ecs_worker/" + _documentation_url = "https://docs.prefect.io/integrations/prefect-aws/" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/d74b16fe84ce626345adf235a47008fea2869a60-225x225.png" # noqa async def run( diff --git a/src/integrations/prefect-azure/prefect_azure/blob_storage.py b/src/integrations/prefect-azure/prefect_azure/blob_storage.py index 7a6edb5af999..679f28c563d6 100644 --- a/src/integrations/prefect-azure/prefect_azure/blob_storage.py +++ b/src/integrations/prefect-azure/prefect_azure/blob_storage.py @@ -207,7 +207,7 @@ class AzureBlobStorageContainer( _block_type_name = "Azure Blob Storage Container" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/54e3fa7e00197a4fbd1d82ed62494cb58d08c96a-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-azure/blob_storage/#prefect_azure.blob_storabe.AzureBlobStorageContainer" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-azure" # noqa container_name: str = Field( default=..., description="The name of a Azure Blob Storage container." diff --git a/src/integrations/prefect-azure/prefect_azure/credentials.py b/src/integrations/prefect-azure/prefect_azure/credentials.py index 2a3f776bc26d..9132e3a912be 100644 --- a/src/integrations/prefect-azure/prefect_azure/credentials.py +++ b/src/integrations/prefect-azure/prefect_azure/credentials.py @@ -95,7 +95,7 @@ class AzureBlobStorageCredentials(Block): _block_type_name = "Azure Blob Storage Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/54e3fa7e00197a4fbd1d82ed62494cb58d08c96a-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-azure/credentials/#prefect_azure.credentials.AzureBlobStorageCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-azure" # noqa connection_string: Optional[SecretStr] = Field( default=None, @@ -281,7 +281,7 @@ class AzureCosmosDbCredentials(Block): _block_type_name = "Azure Cosmos DB Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/54e3fa7e00197a4fbd1d82ed62494cb58d08c96a-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-azure/credentials/#prefect_azure.credentials.AzureCosmosDbCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-azure" # noqa connection_string: SecretStr = Field( default=..., description="Includes the authorization information required." @@ -401,7 +401,7 @@ class AzureMlCredentials(Block): _block_type_name = "AzureML Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/54e3fa7e00197a4fbd1d82ed62494cb58d08c96a-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-azure/credentials/#prefect_azure.credentials.AzureMlCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-azure" # noqa tenant_id: str = Field( default=..., @@ -474,7 +474,7 @@ class AzureContainerInstanceCredentials(Block): _block_type_name = "Azure Container Instance Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/54e3fa7e00197a4fbd1d82ed62494cb58d08c96a-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-azure/credentials/#prefect_azure.credentials.AzureContainerInstanceCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-azure" # noqa client_id: Optional[str] = Field( default=None, diff --git a/src/integrations/prefect-azure/prefect_azure/workers/container_instance.py b/src/integrations/prefect-azure/prefect_azure/workers/container_instance.py index 81d1b057a49d..3b293db87fe7 100644 --- a/src/integrations/prefect-azure/prefect_azure/workers/container_instance.py +++ b/src/integrations/prefect-azure/prefect_azure/workers/container_instance.py @@ -526,9 +526,7 @@ class AzureContainerWorker(BaseWorker): "Execute flow runs within containers on Azure's Container Instances " "service. Requires an Azure account." ) - _documentation_url = ( - "https://prefecthq.github.io/prefect-azure/container_instance_worker/" - ) + _documentation_url = "https://docs.prefect.io/integrations/prefect-azure" async def run( self, diff --git a/src/integrations/prefect-dbt/prefect_dbt/cli/commands.py b/src/integrations/prefect-dbt/prefect_dbt/cli/commands.py index 2193de75f037..f7da28a31fe3 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cli/commands.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cli/commands.py @@ -290,7 +290,7 @@ class DbtCoreOperation(ShellOperation): _block_type_name = "dbt Core Operation" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/commands/#prefect_dbt.cli.commands.DbtCoreOperation" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa profiles_dir: Optional[Path] = Field( default=None, @@ -929,9 +929,11 @@ def _create_unsuccessful_markdown(run_results: dict) -> str: n.node.resource_type, n.message, n.node.path, - n.node.compiled_code - if n.node.resource_type not in ["seed", "source"] - else None, + ( + n.node.compiled_code + if n.node.resource_type not in ["seed", "source"] + else None + ), ) if len(run_results["Fail"]) > 0: markdown += "\n### Failed Nodes:\n" @@ -941,9 +943,11 @@ def _create_unsuccessful_markdown(run_results: dict) -> str: n.node.resource_type, n.message, n.node.path, - n.node.compiled_code - if n.node.resource_type not in ["seed", "source"] - else None, + ( + n.node.compiled_code + if n.node.resource_type not in ["seed", "source"] + else None + ), ) if len(run_results["Skipped"]) > 0: markdown += "\n### Skipped Nodes:\n" @@ -953,9 +957,11 @@ def _create_unsuccessful_markdown(run_results: dict) -> str: n.node.resource_type, n.message, n.node.path, - n.node.compiled_code - if n.node.resource_type not in ["seed", "source"] - else None, + ( + n.node.compiled_code + if n.node.resource_type not in ["seed", "source"] + else None + ), ) if len(run_results["Warn"]) > 0: markdown += "\n### Warned Nodes:\n" @@ -965,9 +971,11 @@ def _create_unsuccessful_markdown(run_results: dict) -> str: n.node.resource_type, n.message, n.node.path, - n.node.compiled_code - if n.node.resource_type not in ["seed", "source"] - else None, + ( + n.node.compiled_code + if n.node.resource_type not in ["seed", "source"] + else None + ), ) return markdown diff --git a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/base.py b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/base.py index 1028973e55c1..4aff4a005c1c 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/base.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/base.py @@ -34,7 +34,7 @@ class DbtConfigs(Block, abc.ABC): "fields provided in extras and credentials." ), ) - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/configs/base/#prefect_dbt.cli.configs.base.DbtConfigs" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa def _populate_configs_json( self, @@ -145,7 +145,7 @@ class TargetConfigs(BaseTargetConfigs): _block_type_name = "dbt CLI Target Configs" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/configs/base/#prefect_dbt.cli.configs.base.TargetConfigs" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa class GlobalConfigs(DbtConfigs): @@ -189,7 +189,7 @@ class GlobalConfigs(DbtConfigs): _block_type_name = "dbt CLI Global Configs" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/configs/base/#prefect_dbt.cli.configs.base.GlobalConfigs" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa send_anonymous_usage_stats: Optional[bool] = Field( default=None, diff --git a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/bigquery.py b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/bigquery.py index 27eb98701f84..e799f674496c 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/bigquery.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/bigquery.py @@ -56,7 +56,7 @@ class BigQueryTargetConfigs(BaseTargetConfigs): _block_type_name = "dbt CLI BigQuery Target Configs" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa _description = "dbt CLI target configs containing credentials and settings, specific to BigQuery." # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/configs/bigquery/#prefect_dbt.cli.configs.bigquery.BigQueryTargetConfigs" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa type: Literal["bigquery"] = Field( default="bigquery", description="The type of target." diff --git a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/postgres.py b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/postgres.py index 19561ee25de2..a207465840d1 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/postgres.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/postgres.py @@ -30,7 +30,7 @@ class PostgresTargetConfigs(BaseTargetConfigs): _block_type_name = "dbt CLI Postgres Target Configs" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa _description = "dbt CLI target configs containing credentials and settings specific to Postgres." # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/configs/postgres/#prefect_dbt.cli.configs.postgres.PostgresTargetConfigs" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa type: Literal["postgres"] = Field( default="postgres", description="The type of the target." diff --git a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/snowflake.py b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/snowflake.py index 124e5bd62ca9..3398f54a1bfd 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cli/configs/snowflake.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cli/configs/snowflake.py @@ -64,7 +64,7 @@ class SnowflakeTargetConfigs(BaseTargetConfigs): _block_type_name = "dbt CLI Snowflake Target Configs" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/configs/snowflake/#prefect_dbt.cli.configs.snowflake.SnowflakeTargetConfigs" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa type: Literal["snowflake"] = Field( default="snowflake", description="The type of the target configs." diff --git a/src/integrations/prefect-dbt/prefect_dbt/cli/credentials.py b/src/integrations/prefect-dbt/prefect_dbt/cli/credentials.py index c6bfe0077162..5fa4e9cd9163 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cli/credentials.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cli/credentials.py @@ -108,7 +108,7 @@ class DbtCliProfile(Block): _block_type_name = "dbt CLI Profile" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cli/credentials/#prefect_dbt.cli.credentials.DbtCliProfile" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa name: str = Field( default=..., description="Profile name used for populating profiles.yml." diff --git a/src/integrations/prefect-dbt/prefect_dbt/cloud/credentials.py b/src/integrations/prefect-dbt/prefect_dbt/cloud/credentials.py index a4a756207634..82d4eb179efa 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cloud/credentials.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cloud/credentials.py @@ -61,7 +61,7 @@ def trigger_dbt_cloud_job_run_flow(): _block_type_name = "dbt Cloud Credentials" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cloud/credentials/#prefect_dbt.cloud.credentials.DbtCloudCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa api_key: SecretStr = Field( default=..., diff --git a/src/integrations/prefect-dbt/prefect_dbt/cloud/jobs.py b/src/integrations/prefect-dbt/prefect_dbt/cloud/jobs.py index d1694f3d74bc..b493cc1e3bd9 100644 --- a/src/integrations/prefect-dbt/prefect_dbt/cloud/jobs.py +++ b/src/integrations/prefect-dbt/prefect_dbt/cloud/jobs.py @@ -1006,7 +1006,7 @@ def dbt_cloud_job_flow(): _block_type_name = "dbt Cloud Job" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/5zE9lxfzBHjw3tnEup4wWL/9a001902ed43a84c6c96d23b24622e19/dbt-bit_tm.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-dbt/cloud/jobs/#prefect_dbt.cloud.jobs.DbtCloudJob" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-dbt" # noqa dbt_cloud_credentials: DbtCloudCredentials = Field( default=..., diff --git a/src/integrations/prefect-docker/prefect_docker/worker.py b/src/integrations/prefect-docker/prefect_docker/worker.py index e529b123375d..24a57631046b 100644 --- a/src/integrations/prefect-docker/prefect_docker/worker.py +++ b/src/integrations/prefect-docker/prefect_docker/worker.py @@ -396,7 +396,7 @@ class DockerWorker(BaseWorker): "Docker daemon." ) _display_name = "Docker" - _documentation_url = "https://prefecthq.github.io/prefect-docker/worker/" + _documentation_url = "https://docs.prefect.io/integrations/prefect-docker" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/2IfXXfMq66mrzJBDFFCHTp/6d8f320d9e4fc4393f045673d61ab612/Moby-logo.png?h=250" # noqa def __init__( diff --git a/src/integrations/prefect-email/prefect_email/credentials.py b/src/integrations/prefect-email/prefect_email/credentials.py index fa9e24db0484..1280d161dec1 100644 --- a/src/integrations/prefect-email/prefect_email/credentials.py +++ b/src/integrations/prefect-email/prefect_email/credentials.py @@ -97,7 +97,7 @@ class EmailServerCredentials(Block): _block_type_name = "Email Server Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/82bc6ed16ca42a2252a5512c72233a253b8a58eb-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-email/credentials/#prefect_email.credentials.EmailServerCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-email" # noqa username: Optional[str] = Field( default=None, diff --git a/src/integrations/prefect-gcp/README.md b/src/integrations/prefect-gcp/README.md index 586fd4e082d7..f8e76ae31397 100644 --- a/src/integrations/prefect-gcp/README.md +++ b/src/integrations/prefect-gcp/README.md @@ -9,18 +9,12 @@ `prefect-gcp` makes it easy to leverage the capabilities of Google Cloud Platform (GCP) in your flows, featuring support for Vertex AI, Cloud Run, BigQuery, Cloud Storage, and Secret Manager. -Visit the full docs [here](https://PrefectHQ.github.io/prefect-gcp). +Visit the full docs [here](https://docs.prefect.io/integrations/prefect-gcp). -### Installation +## Installation To start using `prefect-gcp`: ```bash pip install prefect-gcp ``` - -To install extras, see [here](https://prefecthq.github.io/prefect-gcp/#installation). - -### Contributing - -Thanks for thinking about chipping in! Check out this [step-by-step guide](https://prefecthq.github.io/prefect-gcp/#installation) on how to get started. diff --git a/src/integrations/prefect-gcp/prefect_gcp/bigquery.py b/src/integrations/prefect-gcp/prefect_gcp/bigquery.py index 5e0c3522ada9..0b69c0496838 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/bigquery.py +++ b/src/integrations/prefect-gcp/prefect_gcp/bigquery.py @@ -560,7 +560,7 @@ class BigQueryWarehouse(DatabaseBlock): _block_type_name = "BigQuery Warehouse" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/10424e311932e31c477ac2b9ef3d53cefbaad708-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-gcp/bigquery/#prefect_gcp.bigquery.BigQueryWarehouse" # noqa: E501 + _documentation_url = "https://docs.prefect.io/integrations/prefect-gcp" # noqa: E501 gcp_credentials: GcpCredentials fetch_size: int = Field( diff --git a/src/integrations/prefect-gcp/prefect_gcp/cloud_storage.py b/src/integrations/prefect-gcp/prefect_gcp/cloud_storage.py index 68ea9bdbace0..b7b6183c5e8c 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/cloud_storage.py +++ b/src/integrations/prefect-gcp/prefect_gcp/cloud_storage.py @@ -581,7 +581,7 @@ class GcsBucket(WritableDeploymentStorage, WritableFileSystem, ObjectStorageBloc _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/10424e311932e31c477ac2b9ef3d53cefbaad708-250x250.png" # noqa _block_type_name = "GCS Bucket" - _documentation_url = "https://prefecthq.github.io/prefect-gcp/cloud_storage/#prefect_gcp.cloud_storage.GcsBucket" # noqa: E501 + _documentation_url = "https://docs.prefect.io/integrations/prefect-gcp" # noqa: E501 bucket: str = Field(..., description="Name of the bucket.") gcp_credentials: GcpCredentials = Field( diff --git a/src/integrations/prefect-gcp/prefect_gcp/credentials.py b/src/integrations/prefect-gcp/prefect_gcp/credentials.py index 33703fe0cf72..45165c8c63e8 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/credentials.py +++ b/src/integrations/prefect-gcp/prefect_gcp/credentials.py @@ -124,7 +124,7 @@ class GcpCredentials(CredentialsBlock): _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/10424e311932e31c477ac2b9ef3d53cefbaad708-250x250.png" # noqa _block_type_name = "GCP Credentials" - _documentation_url = "https://prefecthq.github.io/prefect-gcp/credentials/#prefect_gcp.credentials.GcpCredentials" # noqa: E501 + _documentation_url = "https://docs.prefect.io/integrations/prefect-gcp" # noqa: E501 service_account_file: Optional[Path] = Field( default=None, description="Path to the service account JSON keyfile." diff --git a/src/integrations/prefect-gcp/prefect_gcp/secret_manager.py b/src/integrations/prefect-gcp/prefect_gcp/secret_manager.py index 6f90f8f4ec98..edd90a90f337 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/secret_manager.py +++ b/src/integrations/prefect-gcp/prefect_gcp/secret_manager.py @@ -307,7 +307,7 @@ class GcpSecret(SecretBlock): """ _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/10424e311932e31c477ac2b9ef3d53cefbaad708-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-gcp/secret_manager/#prefect_gcp.secret_manager.GcpSecret" # noqa: E501 + _documentation_url = "https://docs.prefect.io/integrations/prefect-gcp" # noqa: E501 gcp_credentials: GcpCredentials secret_name: str = Field(default=..., description="Name of the secret to manage.") diff --git a/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run.py b/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run.py index bc20017ee06e..298386ef168d 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run.py +++ b/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run.py @@ -541,7 +541,7 @@ class CloudRunWorker(BaseWorker): "a Google Cloud Platform account." ) _display_name = "Google Cloud Run" - _documentation_url = "https://prefecthq.github.io/prefect-gcp/cloud_run_worker/" + _documentation_url = "https://docs.prefect.io/integrations/prefect-gcp" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/10424e311932e31c477ac2b9ef3d53cefbaad708-250x250.png" # noqa def _create_job_error(self, exc, configuration): diff --git a/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py b/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py index c7a6427f3764..0d3b6989378a 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py +++ b/src/integrations/prefect-gcp/prefect_gcp/workers/cloud_run_v2.py @@ -472,7 +472,7 @@ class CloudRunWorkerV2(BaseWorker): job_configuration_variables = CloudRunWorkerV2Variables _description = "Execute flow runs within containers on Google Cloud Run (V2 API). Requires a Google Cloud Platform account." # noqa _display_name = "Google Cloud Run V2" - _documentation_url = "https://prefecthq.github.io/prefect-gcp/worker_v2/" + _documentation_url = "https://docs.prefect.io/integrations/prefect-gcp" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/4SpnOBvMYkHp6z939MDKP6/549a91bc1ce9afd4fb12c68db7b68106/social-icon-google-cloud-1200-630.png?h=250" # noqa async def run( diff --git a/src/integrations/prefect-gcp/prefect_gcp/workers/vertex.py b/src/integrations/prefect-gcp/prefect_gcp/workers/vertex.py index add6ec12798a..d11efff4c3d0 100644 --- a/src/integrations/prefect-gcp/prefect_gcp/workers/vertex.py +++ b/src/integrations/prefect-gcp/prefect_gcp/workers/vertex.py @@ -372,7 +372,7 @@ class VertexAIWorker(BaseWorker): "a Google Cloud Platform account." ) _display_name = "Google Vertex AI" - _documentation_url = "https://prefecthq.github.io/prefect-gcp/vertex_worker/" + _documentation_url = "https://docs.prefect.io/integrations/prefect-gcp" # noqa _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/10424e311932e31c477ac2b9ef3d53cefbaad708-250x250.png" # noqa async def run( diff --git a/src/integrations/prefect-github/prefect_github/credentials.py b/src/integrations/prefect-github/prefect_github/credentials.py index 24fe819be558..1e5971a6e9d3 100644 --- a/src/integrations/prefect-github/prefect_github/credentials.py +++ b/src/integrations/prefect-github/prefect_github/credentials.py @@ -25,7 +25,7 @@ class GitHubCredentials(CredentialsBlock): _block_type_name = "GitHub Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/41971cfecfea5f79ff334164f06ecb34d1038dd4-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-github/credentials/#prefect_github.credentials.GitHubCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-github" token: Optional[SecretStr] = Field( default=None, description="A GitHub personal access token (PAT)." diff --git a/src/integrations/prefect-github/prefect_github/repository.py b/src/integrations/prefect-github/prefect_github/repository.py index 4742bc2d8117..57551f2909f3 100644 --- a/src/integrations/prefect-github/prefect_github/repository.py +++ b/src/integrations/prefect-github/prefect_github/repository.py @@ -39,7 +39,7 @@ class GitHubRepository(ReadableDeploymentStorage): _block_type_name = "GitHub Repository" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/41971cfecfea5f79ff334164f06ecb34d1038dd4-250x250.png" # noqa: E501 - _documentation_url = "https://prefecthq.github.io/prefect-github/repository/#prefect_github.repository.GitHubRepository" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-github" # noqa repository_url: str = Field( default=..., diff --git a/src/integrations/prefect-kubernetes/prefect_kubernetes/credentials.py b/src/integrations/prefect-kubernetes/prefect_kubernetes/credentials.py index 802edc9b5007..d753317824d2 100644 --- a/src/integrations/prefect-kubernetes/prefect_kubernetes/credentials.py +++ b/src/integrations/prefect-kubernetes/prefect_kubernetes/credentials.py @@ -52,7 +52,7 @@ class KubernetesClusterConfig(Block): _block_type_name = "Kubernetes Cluster Config" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/2d0b896006ad463b49c28aaac14f31e00e32cfab-250x250.png" - _documentation_url = "https://prefecthq.github.io/prefect-kubernetes/credentials/#prefect_kubernetes.credentials.KubernetesClusterConfig" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-kubernetes" # noqa config: Dict = Field( default=..., description="The entire contents of a kubectl config file." ) @@ -142,7 +142,7 @@ class KubernetesCredentials(Block): _block_type_name = "Kubernetes Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/2d0b896006ad463b49c28aaac14f31e00e32cfab-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-kubernetes/credentials/#prefect_kubernetes.credentials.KubernetesCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-kubernetes" # noqa cluster_config: Optional[KubernetesClusterConfig] = None diff --git a/src/integrations/prefect-kubernetes/prefect_kubernetes/jobs.py b/src/integrations/prefect-kubernetes/prefect_kubernetes/jobs.py index d3b9ec828429..5650ca551f7b 100644 --- a/src/integrations/prefect-kubernetes/prefect_kubernetes/jobs.py +++ b/src/integrations/prefect-kubernetes/prefect_kubernetes/jobs.py @@ -540,7 +540,7 @@ class KubernetesJob(JobBlock): _block_type_name = "Kubernetes Job" _block_type_slug = "k8s-job" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/2d0b896006ad463b49c28aaac14f31e00e32cfab-250x250.png" # noqa: E501 - _documentation_url = "https://prefecthq.github.io/prefect-kubernetes/jobs/#prefect_kubernetes.jobs.KubernetesJob" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-kubernetes" # noqa @sync_compatible async def trigger(self): diff --git a/src/integrations/prefect-kubernetes/prefect_kubernetes/worker.py b/src/integrations/prefect-kubernetes/prefect_kubernetes/worker.py index d23c64f5897e..0d3f58637d66 100644 --- a/src/integrations/prefect-kubernetes/prefect_kubernetes/worker.py +++ b/src/integrations/prefect-kubernetes/prefect_kubernetes/worker.py @@ -566,7 +566,7 @@ class KubernetesWorker(BaseWorker): "Kubernetes cluster." ) _display_name = "Kubernetes" - _documentation_url = "https://prefecthq.github.io/prefect-kubernetes/worker/" + _documentation_url = "https://docs.prefect.io/integrations/prefect-kubernetes" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/2d0b896006ad463b49c28aaac14f31e00e32cfab-250x250.png" # noqa def __init__(self, *args, **kwargs): diff --git a/src/integrations/prefect-shell/prefect_shell/commands.py b/src/integrations/prefect-shell/prefect_shell/commands.py index 40395586f422..50360595730b 100644 --- a/src/integrations/prefect-shell/prefect_shell/commands.py +++ b/src/integrations/prefect-shell/prefect_shell/commands.py @@ -227,7 +227,7 @@ class ShellOperation(JobBlock): _block_type_name = "Shell Operation" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/0b47a017e1b40381de770c17647c49cdf6388d1c-250x250.png" # noqa: E501 - _documentation_url = "https://prefecthq.github.io/prefect-shell/commands/#prefect_shell.commands.ShellOperation" # noqa: E501 + _documentation_url = "https://docs.prefect.io/integrations/prefect-shell" # noqa commands: List[str] = Field( default=..., description="A list of commands to execute sequentially." diff --git a/src/integrations/prefect-slack/prefect_slack/credentials.py b/src/integrations/prefect-slack/prefect_slack/credentials.py index 7165874e92ec..3f12c4cc53ea 100644 --- a/src/integrations/prefect-slack/prefect_slack/credentials.py +++ b/src/integrations/prefect-slack/prefect_slack/credentials.py @@ -36,7 +36,7 @@ class SlackCredentials(Block): _block_type_name = "Slack Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/c1965ecbf8704ee1ea20d77786de9a41ce1087d1-500x500.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-slack/credentials/#prefect_slack.credentials.SlackCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-slack" # noqa token: SecretStr = Field( default=..., @@ -90,7 +90,7 @@ class SlackWebhook(NotificationBlock): _block_type_name = "Slack Incoming Webhook" _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/7dkzINU9r6j44giEFuHuUC/85d4cd321ad60c1b1e898bc3fbd28580/5cb480cd5f1b6d3fbadece79.png?h=250" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-slack/credentials/#prefect_slack.credentials.SlackWebhook" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-slack" # noqa url: SecretStr = Field( default=..., diff --git a/src/integrations/prefect-snowflake/prefect_snowflake/credentials.py b/src/integrations/prefect-snowflake/prefect_snowflake/credentials.py index 7c9012164358..1ea50ae97f83 100644 --- a/src/integrations/prefect-snowflake/prefect_snowflake/credentials.py +++ b/src/integrations/prefect-snowflake/prefect_snowflake/credentials.py @@ -72,7 +72,7 @@ class SnowflakeCredentials(CredentialsBlock): _block_type_name = "Snowflake Credentials" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/bd359de0b4be76c2254bd329fe3a267a1a3879c2-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-snowflake/credentials/#prefect_snowflake.credentials.SnowflakeCredentials" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-snowflake" # noqa account: str = Field( ..., diff --git a/src/integrations/prefect-snowflake/prefect_snowflake/database.py b/src/integrations/prefect-snowflake/prefect_snowflake/database.py index 0b95dc890d35..0ca83b5733b6 100644 --- a/src/integrations/prefect-snowflake/prefect_snowflake/database.py +++ b/src/integrations/prefect-snowflake/prefect_snowflake/database.py @@ -75,7 +75,7 @@ class SnowflakeConnector(DatabaseBlock): _block_type_name = "Snowflake Connector" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/bd359de0b4be76c2254bd329fe3a267a1a3879c2-250x250.png" # noqa - _documentation_url = "https://prefecthq.github.io/prefect-snowflake/database/#prefect_snowflake.database.SnowflakeConnector" # noqa + _documentation_url = "https://docs.prefect.io/integrations/prefect-snowflake" # noqa _description = "Perform data operations against a Snowflake database." credentials: SnowflakeCredentials = Field( diff --git a/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/database.py b/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/database.py index 1b340d14d336..cc8db9ec0618 100644 --- a/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/database.py +++ b/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/database.py @@ -94,7 +94,7 @@ class SqlAlchemyConnector(CredentialsBlock, DatabaseBlock): _block_type_name = "SQLAlchemy Connector" _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/3c7dff04f70aaf4528e184a3b028f9e40b98d68c-250x250.png" # type: ignore - _documentation_url = "https://prefecthq.github.io/prefect-sqlalchemy/database/#prefect_sqlalchemy.database.SqlAlchemyConnector" # type: ignore + _documentation_url = "https://docs.prefect.io/integrations/prefect-sqlalchemy" # type: ignore model_config = ConfigDict(arbitrary_types_allowed=True) connection_info: Union[ConnectionComponents, DBUrl] = Field(