From 2b2a4090fcee22bf249c2f8439e7e6d1cd0b91fd Mon Sep 17 00:00:00 2001 From: Rounak Dhillon <162090200+RounakDhillon@users.noreply.github.com> Date: Wed, 6 Aug 2025 10:25:09 +0530 Subject: [PATCH] Docs: Brand Name Tag Updation (#22760) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Docs: Updation * Docs: Updation * Docs: Updation --------- Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”> Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com> --- .../v1.7.x/connectors/pipeline/airflow/index.md | 4 ++-- .../v1.7.x/getting-started/day-1/collate-saas.md | 3 ++- .../getting-started/day-1/hybrid-saas/airflow.md | 1 + .../day-1/hybrid-saas/credentials.md | 3 ++- .../day-1/hybrid-saas/gcp-composer.md | 3 ++- .../day-1/hybrid-saas/github-actions.md | 1 + .../day-1/hybrid-saas/hybrid-ingestion-runner.md | 3 ++- .../getting-started/day-1/hybrid-saas/index.md | 1 + .../getting-started/day-1/hybrid-saas/mwaa.md | 13 +++++++------ .../content/v1.7.x/getting-started/day-1/index.md | 3 ++- .../content/v1.7.x/getting-started/index.md | 3 ++- .../data-quality-observability/profiler/index.md | 2 +- .../v1.8.x/connectors/pipeline/airflow/index.md | 4 ++-- .../v1.8.x/getting-started/day-1/collate-saas.md | 3 ++- .../getting-started/day-1/hybrid-saas/airflow.md | 1 + .../day-1/hybrid-saas/credentials.md | 3 ++- .../day-1/hybrid-saas/gcp-composer.md | 3 ++- .../day-1/hybrid-saas/github-actions.md | 1 + .../day-1/hybrid-saas/hybrid-ingestion-runner.md | 3 ++- .../getting-started/day-1/hybrid-saas/index.md | 1 + .../getting-started/day-1/hybrid-saas/mwaa.md | 13 +++++++------ .../content/v1.8.x/getting-started/day-1/index.md | 3 ++- .../content/v1.8.x/getting-started/index.md | 3 ++- .../data-quality-observability/profiler/index.md | 2 +- .../connectors/pipeline/airflow/index.md | 4 ++-- .../getting-started/day-1/collate-saas.md | 3 ++- .../getting-started/day-1/hybrid-saas/airflow.md | 1 + .../day-1/hybrid-saas/credentials.md | 3 ++- .../day-1/hybrid-saas/gcp-composer.md | 3 ++- .../day-1/hybrid-saas/github-actions.md | 1 + .../day-1/hybrid-saas/hybrid-ingestion-runner.md | 3 ++- .../getting-started/day-1/hybrid-saas/index.md | 1 + .../getting-started/day-1/hybrid-saas/mwaa.md | 13 +++++++------ .../v1.9.x-SNAPSHOT/getting-started/day-1/index.md | 3 ++- .../v1.9.x-SNAPSHOT/getting-started/index.md | 3 ++- .../data-quality-observability/profiler/index.md | 2 +- .../data-quality-observability/quality/tests-ui.md | 2 +- 37 files changed, 76 insertions(+), 46 deletions(-) diff --git a/openmetadata-docs/content/v1.7.x/connectors/pipeline/airflow/index.md b/openmetadata-docs/content/v1.7.x/connectors/pipeline/airflow/index.md index c80813f8fc1..8f738913a5f 100644 --- a/openmetadata-docs/content/v1.7.x/connectors/pipeline/airflow/index.md +++ b/openmetadata-docs/content/v1.7.x/connectors/pipeline/airflow/index.md @@ -1,6 +1,6 @@ --- -title: Airflow Connector | OpenMetadata Workflow Orchestration -description: Connect Apache Airflow to OpenMetadata effortlessly. Complete setup guide, configuration steps, and pipeline metadata extraction for seamless data lineage tracking. +title: Airflow Connector | `brandName` Workflow Orchestration +description: Connect Apache Airflow to `brandName` effortlessly. Complete setup guide, configuration steps, and pipeline metadata extraction for seamless data lineage tracking. slug: /connectors/pipeline/airflow --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/collate-saas.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/collate-saas.md index 2c058373b5e..42eea5cbf9e 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/collate-saas.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/collate-saas.md @@ -1,5 +1,6 @@ --- -title: Collate SaaS +title: Collate SaaS Setup Guide | Connect Database Services for Metadata Extraction +description: Learn how to configure database services in Collate SaaS, allow IP access, test connections, and begin metadata extraction using built-in connectors like Snowflake. slug: /getting-started/day-1/collate-saas collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/airflow.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/airflow.md index 81f9edef38f..aea6c4eef04 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/airflow.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/airflow.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from your Airflow +description: Learn how to run OpenMetadata ingestion workflows using Python, Docker, or Virtualenv operators in Airflow for secure and flexible metadata ingestion. slug: /getting-started/day-1/hybrid-saas/airflow collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/credentials.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/credentials.md index bc696794757..decc9111200 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/credentials.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/credentials.md @@ -1,5 +1,6 @@ --- -title: Managing Credentials +title: Managing Credentials Securely | Collate Ingestion Best Practices +description: Learn secure ways to manage credentials in Collate ingestion workflows using environment variables, Airflow connections, GitHub secrets, and existing services. slug: /getting-started/day-1/hybrid-saas/credentials collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/gcp-composer.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/gcp-composer.md index 3b9ecee084b..0f376ebafd6 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/gcp-composer.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/gcp-composer.md @@ -1,5 +1,6 @@ --- -title: Run the ingestion from GCP Composer +title: Run the ingestion from GCP Composer +description: Learn to run Collate ingestion in GCP Composer using Python or KubernetesPod operators. Install packages or run containers for secure, scalable ingestion. slug: /getting-started/day-1/hybrid-saas/gcp-composer collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/github-actions.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/github-actions.md index 73704aab2bb..d6670b01a97 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/github-actions.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/github-actions.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from GitHub Actions +description: Automate Collate ingestion with GitHub Actions. Set up YAML configs, secure credentials, schedule workflows, and send Slack alerts on failure. slug: /getting-started/day-1/hybrid-saas/github-actions collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md index cf49836b442..c5ee0a5ddc5 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md @@ -1,5 +1,6 @@ --- -title: Hybrid Ingestion Runner +title: Hybrid Ingestion Runner | Secure Metadata Workflows in Your Cloud +description: Learn to configure and manage Hybrid Ingestion Runner to securely execute workflows in your cloud using AWS, Azure, or GCP secrets—without exposing credentials. slug: /getting-started/day-1/hybrid-saas/hybrid-ingestion-runner collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/index.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/index.md index b00154bbdb4..22c7f924002 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/index.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/index.md @@ -1,5 +1,6 @@ --- title: Hybrid SaaS | Secure Metadata Ingestion for Collate +description: Learn how to securely ingest metadata using the Collate Ingestion Agent in your own infrastructure. Ideal for private networks and hybrid SaaS setups. slug: /getting-started/day-1/hybrid-saas collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/mwaa.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/mwaa.md index 8c42a38fba6..781437807f1 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/mwaa.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/hybrid-saas/mwaa.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from AWS MWAA +description: Set up Collate ingestion workflows on AWS MWAA using Python, ECS, or Virtualenv operators. Compare approaches and configure DAGs for secure metadata ingestion. slug: /getting-started/day-1/hybrid-saas/mwaa collate: true --- @@ -35,7 +36,7 @@ To install the package, we need to update the `requirements.txt` file from the M openmetadata-ingestion[]==x.y.z ``` -Where `x.y.z` is the version of the OpenMetadata ingestion package. Note that the version needs to match the server version. If we are using the server at 1.3.1, then the ingestion package needs to also be 1.3.1. +Where `x.y.z` is the version of the Collate ingestion package. Note that the version needs to match the server version. If we are using the server at 1.3.1, then the ingestion package needs to also be 1.3.1. The plugin parameter is a list of the sources that we want to ingest. An example would look like this `openmetadata-ingestion[mysql,snowflake,s3]==1.3.1`. @@ -78,7 +79,7 @@ def metadata_ingestion_workflow(): with DAG( "redshift_ingestion", default_args=default_args, - description="An example DAG which runs a OpenMetadata ingestion workflow", + description="An example DAG which runs a Collate ingestion workflow", start_date=days_ago(1), is_paused_upon_creation=False, catchup=False, @@ -293,7 +294,7 @@ with DAG( ``` Note that depending on the kind of workflow you will be deploying, the YAML configuration will need to updated following -the official OpenMetadata docs, and the value of the `pipelineType` configuration will need to hold one of the following values: +the official Collate docs, and the value of the `pipelineType` configuration will need to hold one of the following values: - `metadata` - `usage` @@ -410,7 +411,7 @@ YAML config with DAG( "redshift_ingestion", default_args=default_args, - description="An example DAG which runs a OpenMetadata ingestion workflow", + description="An example DAG which runs a Collate ingestion workflow", start_date=days_ago(1), is_paused_upon_creation=False, catchup=False, @@ -419,7 +420,7 @@ with DAG( task_id="ingest_redshift", python_callable=metadata_ingestion_workflow, requirements=['openmetadata-ingestion==1.0.5.0', - 'apache-airflow==2.4.3', # note, v2.4.3 is the first version that does not conflict with OpenMetadata's 'tabulate' requirements + 'apache-airflow==2.4.3', # note, v2.4.3 is the first version that does not conflict with Collate's 'tabulate' requirements 'apache-airflow-providers-amazon==6.0.0', # Amazon Airflow provider is necessary for MWAA 'watchtower',], system_site_packages=False, @@ -430,7 +431,7 @@ with DAG( Where you can update the YAML configuration and workflow classes accordingly. accordingly. Further examples on how to run the ingestion can be found on the documentation (e.g., [Snowflake](/connectors/database/snowflake)). -You will also need to determine the OpenMetadata ingestion extras and Airflow providers you need. Note that the Openmetadata version needs to match the server version. If we are using the server at 0.12.2, then the ingestion package needs to also be 0.12.2. An example of the extras would look like this `openmetadata-ingestion[mysql,snowflake,s3]==0.12.2.2`. +You will also need to determine the Collate ingestion extras and Airflow providers you need. Note that the Openmetadata version needs to match the server version. If we are using the server at 0.12.2, then the ingestion package needs to also be 0.12.2. An example of the extras would look like this `openmetadata-ingestion[mysql,snowflake,s3]==0.12.2.2`. For Airflow providers, you will want to pull the provider versions from [the matching constraints file](https://raw.githubusercontent.com/apache/airflow/constraints-2.4.3/constraints-3.7.txt). Since this example installs Airflow Providers v2.4.3 on Python 3.7, we use that constraints file. Also note that the ingestion workflow function must be entirely self-contained as it will run by itself in the virtualenv. Any imports it needs, including the configuration, must exist within the function itself. diff --git a/openmetadata-docs/content/v1.7.x/getting-started/day-1/index.md b/openmetadata-docs/content/v1.7.x/getting-started/day-1/index.md index a92ab62dbbb..a521e2b73dc 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/day-1/index.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/day-1/index.md @@ -1,5 +1,6 @@ --- -title: Day 1 +title: Day 1 Setup Guide | Connect, Ingest & Collaborate in Collate +description: Start your Collate journey by connecting data sources, ingesting metadata, inviting users, and exploring key features. Everything you need for Day 1. slug: /getting-started/day-1 collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/getting-started/index.md b/openmetadata-docs/content/v1.7.x/getting-started/index.md index b3a0c941ecb..45599dbddd5 100644 --- a/openmetadata-docs/content/v1.7.x/getting-started/index.md +++ b/openmetadata-docs/content/v1.7.x/getting-started/index.md @@ -1,5 +1,6 @@ --- -title: Getting Started +title: Getting Started with Collate | Setup & Onboarding Guide +description: Quickly set up your Collate environment in 30 minutes. Learn how to connect data sources, explore features, and begin your onboarding journey. slug: /getting-started collate: true --- diff --git a/openmetadata-docs/content/v1.7.x/how-to-guides/data-quality-observability/profiler/index.md b/openmetadata-docs/content/v1.7.x/how-to-guides/data-quality-observability/profiler/index.md index 0182698a586..e1fad46940c 100644 --- a/openmetadata-docs/content/v1.7.x/how-to-guides/data-quality-observability/profiler/index.md +++ b/openmetadata-docs/content/v1.7.x/how-to-guides/data-quality-observability/profiler/index.md @@ -1,5 +1,5 @@ --- -title: Data Profiler | OpenMetadata Data Profiling Guide +title: Data Profiler | `brandName` Data Profiling Guide description: Explore profiling workflows including histogram metrics, null counts, and field-level health. slug: /how-to-guides/data-quality-observability/profiler --- diff --git a/openmetadata-docs/content/v1.8.x/connectors/pipeline/airflow/index.md b/openmetadata-docs/content/v1.8.x/connectors/pipeline/airflow/index.md index d4190d916a7..4ee92a228a9 100644 --- a/openmetadata-docs/content/v1.8.x/connectors/pipeline/airflow/index.md +++ b/openmetadata-docs/content/v1.8.x/connectors/pipeline/airflow/index.md @@ -1,6 +1,6 @@ --- -title: Airflow Connector | OpenMetadata Workflow Orchestration -description: Connect Apache Airflow to OpenMetadata effortlessly. Complete setup guide, configuration steps, and pipeline metadata extraction for seamless data lineage tracking. +title: Airflow Connector | `brandName` Workflow Orchestration +description: Connect Apache Airflow to `brandName` effortlessly. Complete setup guide, configuration steps, and pipeline metadata extraction for seamless data lineage tracking. slug: /connectors/pipeline/airflow --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/collate-saas.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/collate-saas.md index 636b999b792..94c6e206565 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/collate-saas.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/collate-saas.md @@ -1,5 +1,6 @@ --- -title: Collate SaaS +title: Collate SaaS Setup Guide | Connect Database Services for Metadata Extraction +description: Learn how to configure database services in Collate SaaS, allow IP access, test connections, and begin metadata extraction using built-in connectors like Snowflake. slug: /getting-started/day-1/collate-saas collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/airflow.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/airflow.md index 199ca07ab78..035d058257e 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/airflow.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/airflow.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from your Airflow +description: Learn how to run OpenMetadata ingestion workflows using Python, Docker, or Virtualenv operators in Airflow for secure and flexible metadata ingestion. slug: /getting-started/day-1/hybrid-saas/airflow collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/credentials.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/credentials.md index 1cbeb124b35..8a23abfa5c1 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/credentials.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/credentials.md @@ -1,5 +1,6 @@ --- -title: Managing Credentials +title: Managing Credentials Securely | Collate Ingestion Best Practices +description: Learn secure ways to manage credentials in Collate ingestion workflows using environment variables, Airflow connections, GitHub secrets, and existing services. slug: /getting-started/day-1/hybrid-saas/credentials collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/gcp-composer.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/gcp-composer.md index 4005fed7311..b7deefb8acf 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/gcp-composer.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/gcp-composer.md @@ -1,5 +1,6 @@ --- -title: Run the ingestion from GCP Composer +title: Run the ingestion from GCP Composer +description: Learn to run Collate ingestion in GCP Composer using Python or KubernetesPod operators. Install packages or run containers for secure, scalable ingestion. slug: /getting-started/day-1/hybrid-saas/gcp-composer collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/github-actions.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/github-actions.md index fa0e49a8e8d..c3c44e9e6d5 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/github-actions.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/github-actions.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from GitHub Actions +description: Automate Collate ingestion with GitHub Actions. Set up YAML configs, secure credentials, schedule workflows, and send Slack alerts on failure. slug: /getting-started/day-1/hybrid-saas/github-actions collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md index 169c178ee68..3920d58015d 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md @@ -1,5 +1,6 @@ --- -title: Hybrid Ingestion Runner +title: Hybrid Ingestion Runner | Secure Metadata Workflows in Your Cloud +description: Learn to configure and manage Hybrid Ingestion Runner to securely execute workflows in your cloud using AWS, Azure, or GCP secrets—without exposing credentials. slug: /getting-started/day-1/hybrid-saas/hybrid-ingestion-runner collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/index.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/index.md index b24a3fa2ced..2179ef680bc 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/index.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/index.md @@ -1,5 +1,6 @@ --- title: Hybrid SaaS | Secure Metadata Ingestion for Collate +description: Learn how to securely ingest metadata using the Collate Ingestion Agent in your own infrastructure. Ideal for private networks and hybrid SaaS setups. slug: /getting-started/day-1/hybrid-saas collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/mwaa.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/mwaa.md index bdfc6e21a46..1a0c95f3741 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/mwaa.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/hybrid-saas/mwaa.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from AWS MWAA +description: Set up Collate ingestion workflows on AWS MWAA using Python, ECS, or Virtualenv operators. Compare approaches and configure DAGs for secure metadata ingestion. slug: /getting-started/day-1/hybrid-saas/mwaa collate: true --- @@ -35,7 +36,7 @@ To install the package, we need to update the `requirements.txt` file from the M openmetadata-ingestion[]==x.y.z ``` -Where `x.y.z` is the version of the OpenMetadata ingestion package. Note that the version needs to match the server version. If we are using the server at 1.3.1, then the ingestion package needs to also be 1.3.1. +Where `x.y.z` is the version of the Collate ingestion package. Note that the version needs to match the server version. If we are using the server at 1.3.1, then the ingestion package needs to also be 1.3.1. The plugin parameter is a list of the sources that we want to ingest. An example would look like this `openmetadata-ingestion[mysql,snowflake,s3]==1.3.1`. @@ -78,7 +79,7 @@ def metadata_ingestion_workflow(): with DAG( "redshift_ingestion", default_args=default_args, - description="An example DAG which runs a OpenMetadata ingestion workflow", + description="An example DAG which runs a Collate ingestion workflow", start_date=days_ago(1), is_paused_upon_creation=False, catchup=False, @@ -293,7 +294,7 @@ with DAG( ``` Note that depending on the kind of workflow you will be deploying, the YAML configuration will need to updated following -the official OpenMetadata docs, and the value of the `pipelineType` configuration will need to hold one of the following values: +the official Collate docs, and the value of the `pipelineType` configuration will need to hold one of the following values: - `metadata` - `usage` @@ -410,7 +411,7 @@ YAML config with DAG( "redshift_ingestion", default_args=default_args, - description="An example DAG which runs a OpenMetadata ingestion workflow", + description="An example DAG which runs a Collate ingestion workflow", start_date=days_ago(1), is_paused_upon_creation=False, catchup=False, @@ -419,7 +420,7 @@ with DAG( task_id="ingest_redshift", python_callable=metadata_ingestion_workflow, requirements=['openmetadata-ingestion==1.0.5.0', - 'apache-airflow==2.4.3', # note, v2.4.3 is the first version that does not conflict with OpenMetadata's 'tabulate' requirements + 'apache-airflow==2.4.3', # note, v2.4.3 is the first version that does not conflict with Collate's 'tabulate' requirements 'apache-airflow-providers-amazon==6.0.0', # Amazon Airflow provider is necessary for MWAA 'watchtower',], system_site_packages=False, @@ -430,7 +431,7 @@ with DAG( Where you can update the YAML configuration and workflow classes accordingly. accordingly. Further examples on how to run the ingestion can be found on the documentation (e.g., [Snowflake](/connectors/database/snowflake)). -You will also need to determine the OpenMetadata ingestion extras and Airflow providers you need. Note that the Openmetadata version needs to match the server version. If we are using the server at 0.12.2, then the ingestion package needs to also be 0.12.2. An example of the extras would look like this `openmetadata-ingestion[mysql,snowflake,s3]==0.12.2.2`. +You will also need to determine the Collate ingestion extras and Airflow providers you need. Note that the Openmetadata version needs to match the server version. If we are using the server at 0.12.2, then the ingestion package needs to also be 0.12.2. An example of the extras would look like this `openmetadata-ingestion[mysql,snowflake,s3]==0.12.2.2`. For Airflow providers, you will want to pull the provider versions from [the matching constraints file](https://raw.githubusercontent.com/apache/airflow/constraints-2.4.3/constraints-3.7.txt). Since this example installs Airflow Providers v2.4.3 on Python 3.7, we use that constraints file. Also note that the ingestion workflow function must be entirely self-contained as it will run by itself in the virtualenv. Any imports it needs, including the configuration, must exist within the function itself. diff --git a/openmetadata-docs/content/v1.8.x/getting-started/day-1/index.md b/openmetadata-docs/content/v1.8.x/getting-started/day-1/index.md index 2d78b036c8d..a44966fa384 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/day-1/index.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/day-1/index.md @@ -1,5 +1,6 @@ --- -title: Day 1 +title: Day 1 Setup Guide | Connect, Ingest & Collaborate in Collate +description: Start your Collate journey by connecting data sources, ingesting metadata, inviting users, and exploring key features. Everything you need for Day 1. slug: /getting-started/day-1 collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/getting-started/index.md b/openmetadata-docs/content/v1.8.x/getting-started/index.md index b3a0c941ecb..45599dbddd5 100644 --- a/openmetadata-docs/content/v1.8.x/getting-started/index.md +++ b/openmetadata-docs/content/v1.8.x/getting-started/index.md @@ -1,5 +1,6 @@ --- -title: Getting Started +title: Getting Started with Collate | Setup & Onboarding Guide +description: Quickly set up your Collate environment in 30 minutes. Learn how to connect data sources, explore features, and begin your onboarding journey. slug: /getting-started collate: true --- diff --git a/openmetadata-docs/content/v1.8.x/how-to-guides/data-quality-observability/profiler/index.md b/openmetadata-docs/content/v1.8.x/how-to-guides/data-quality-observability/profiler/index.md index 0182698a586..e1fad46940c 100644 --- a/openmetadata-docs/content/v1.8.x/how-to-guides/data-quality-observability/profiler/index.md +++ b/openmetadata-docs/content/v1.8.x/how-to-guides/data-quality-observability/profiler/index.md @@ -1,5 +1,5 @@ --- -title: Data Profiler | OpenMetadata Data Profiling Guide +title: Data Profiler | `brandName` Data Profiling Guide description: Explore profiling workflows including histogram metrics, null counts, and field-level health. slug: /how-to-guides/data-quality-observability/profiler --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/connectors/pipeline/airflow/index.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/connectors/pipeline/airflow/index.md index 625717bd1ff..4389deefbeb 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/connectors/pipeline/airflow/index.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/connectors/pipeline/airflow/index.md @@ -1,6 +1,6 @@ --- -title: Airflow Connector | OpenMetadata Workflow Orchestration -description: Connect Apache Airflow to OpenMetadata effortlessly. Complete setup guide, configuration steps, and pipeline metadata extraction for seamless data lineage tracking. +title: Airflow Connector | `brandName` Workflow Orchestration +description: Connect Apache Airflow to `brandName` effortlessly. Complete setup guide, configuration steps, and pipeline metadata extraction for seamless data lineage tracking. slug: /connectors/pipeline/airflow --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/collate-saas.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/collate-saas.md index 676f87c2848..fe66e1986c9 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/collate-saas.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/collate-saas.md @@ -1,5 +1,6 @@ --- -title: Collate SaaS +title: Collate SaaS Setup Guide | Connect Database Services for Metadata Extraction +description: Learn how to configure database services in Collate SaaS, allow IP access, test connections, and begin metadata extraction using built-in connectors like Snowflake. slug: /getting-started/day-1/collate-saas collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/airflow.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/airflow.md index dd8f7d58b82..7d12aaa5034 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/airflow.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/airflow.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from your Airflow +description: Learn how to run OpenMetadata ingestion workflows using Python, Docker, or Virtualenv operators in Airflow for secure and flexible metadata ingestion. slug: /getting-started/day-1/hybrid-saas/airflow collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/credentials.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/credentials.md index 58f2053ac74..104dbc891ff 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/credentials.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/credentials.md @@ -1,5 +1,6 @@ --- -title: Managing Credentials +title: Managing Credentials Securely | Collate Ingestion Best Practices +description: Learn secure ways to manage credentials in Collate ingestion workflows using environment variables, Airflow connections, GitHub secrets, and existing services. slug: /getting-started/day-1/hybrid-saas/credentials collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/gcp-composer.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/gcp-composer.md index 2d5cd1df860..ba4bbf39295 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/gcp-composer.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/gcp-composer.md @@ -1,5 +1,6 @@ --- -title: Run the ingestion from GCP Composer +title: Run the ingestion from GCP Composer +description: Learn to run Collate ingestion in GCP Composer using Python or KubernetesPod operators. Install packages or run containers for secure, scalable ingestion. slug: /getting-started/day-1/hybrid-saas/gcp-composer collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/github-actions.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/github-actions.md index 064ddd2961c..7cd663d9274 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/github-actions.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/github-actions.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from GitHub Actions +description: Automate Collate ingestion with GitHub Actions. Set up YAML configs, secure credentials, schedule workflows, and send Slack alerts on failure. slug: /getting-started/day-1/hybrid-saas/github-actions collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md index c19d054025a..986b9b8efba 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner.md @@ -1,5 +1,6 @@ --- -title: Hybrid Ingestion Runner +title: Hybrid Ingestion Runner | Secure Metadata Workflows in Your Cloud +description: Learn to configure and manage Hybrid Ingestion Runner to securely execute workflows in your cloud using AWS, Azure, or GCP secrets—without exposing credentials. slug: /getting-started/day-1/hybrid-saas/hybrid-ingestion-runner collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/index.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/index.md index a4b9bf9cd8f..e23f6d74efd 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/index.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/index.md @@ -1,5 +1,6 @@ --- title: Hybrid SaaS | Secure Metadata Ingestion for Collate +description: Learn how to securely ingest metadata using the Collate Ingestion Agent in your own infrastructure. Ideal for private networks and hybrid SaaS setups. slug: /getting-started/day-1/hybrid-saas collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/mwaa.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/mwaa.md index b46d116df64..896346b998f 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/mwaa.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/hybrid-saas/mwaa.md @@ -1,5 +1,6 @@ --- title: Run the ingestion from AWS MWAA +description: Set up Collate ingestion workflows on AWS MWAA using Python, ECS, or Virtualenv operators. Compare approaches and configure DAGs for secure metadata ingestion. slug: /getting-started/day-1/hybrid-saas/mwaa collate: true --- @@ -35,7 +36,7 @@ To install the package, we need to update the `requirements.txt` file from the M openmetadata-ingestion[]==x.y.z ``` -Where `x.y.z` is the version of the OpenMetadata ingestion package. Note that the version needs to match the server version. If we are using the server at 1.3.1, then the ingestion package needs to also be 1.3.1. +Where `x.y.z` is the version of the Collate ingestion package. Note that the version needs to match the server version. If we are using the server at 1.3.1, then the ingestion package needs to also be 1.3.1. The plugin parameter is a list of the sources that we want to ingest. An example would look like this `openmetadata-ingestion[mysql,snowflake,s3]==1.3.1`. @@ -78,7 +79,7 @@ def metadata_ingestion_workflow(): with DAG( "redshift_ingestion", default_args=default_args, - description="An example DAG which runs a OpenMetadata ingestion workflow", + description="An example DAG which runs a Collate ingestion workflow", start_date=days_ago(1), is_paused_upon_creation=False, catchup=False, @@ -293,7 +294,7 @@ with DAG( ``` Note that depending on the kind of workflow you will be deploying, the YAML configuration will need to updated following -the official OpenMetadata docs, and the value of the `pipelineType` configuration will need to hold one of the following values: +the official Collate docs, and the value of the `pipelineType` configuration will need to hold one of the following values: - `metadata` - `usage` @@ -410,7 +411,7 @@ YAML config with DAG( "redshift_ingestion", default_args=default_args, - description="An example DAG which runs a OpenMetadata ingestion workflow", + description="An example DAG which runs a Collate ingestion workflow", start_date=days_ago(1), is_paused_upon_creation=False, catchup=False, @@ -419,7 +420,7 @@ with DAG( task_id="ingest_redshift", python_callable=metadata_ingestion_workflow, requirements=['openmetadata-ingestion==1.0.5.0', - 'apache-airflow==2.4.3', # note, v2.4.3 is the first version that does not conflict with OpenMetadata's 'tabulate' requirements + 'apache-airflow==2.4.3', # note, v2.4.3 is the first version that does not conflict with Collate's 'tabulate' requirements 'apache-airflow-providers-amazon==6.0.0', # Amazon Airflow provider is necessary for MWAA 'watchtower',], system_site_packages=False, @@ -430,7 +431,7 @@ with DAG( Where you can update the YAML configuration and workflow classes accordingly. accordingly. Further examples on how to run the ingestion can be found on the documentation (e.g., [Snowflake](/connectors/database/snowflake)). -You will also need to determine the OpenMetadata ingestion extras and Airflow providers you need. Note that the Openmetadata version needs to match the server version. If we are using the server at 0.12.2, then the ingestion package needs to also be 0.12.2. An example of the extras would look like this `openmetadata-ingestion[mysql,snowflake,s3]==0.12.2.2`. +You will also need to determine the Collate ingestion extras and Airflow providers you need. Note that the Openmetadata version needs to match the server version. If we are using the server at 0.12.2, then the ingestion package needs to also be 0.12.2. An example of the extras would look like this `openmetadata-ingestion[mysql,snowflake,s3]==0.12.2.2`. For Airflow providers, you will want to pull the provider versions from [the matching constraints file](https://raw.githubusercontent.com/apache/airflow/constraints-2.4.3/constraints-3.7.txt). Since this example installs Airflow Providers v2.4.3 on Python 3.7, we use that constraints file. Also note that the ingestion workflow function must be entirely self-contained as it will run by itself in the virtualenv. Any imports it needs, including the configuration, must exist within the function itself. diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/index.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/index.md index 6825404557a..a7b2d7a4091 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/index.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/day-1/index.md @@ -1,5 +1,6 @@ --- -title: Day 1 +title: Day 1 Setup Guide | Connect, Ingest & Collaborate in Collate +description: Start your Collate journey by connecting data sources, ingesting metadata, inviting users, and exploring key features. Everything you need for Day 1. slug: /getting-started/day-1 collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/index.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/index.md index b3a0c941ecb..45599dbddd5 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/index.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/getting-started/index.md @@ -1,5 +1,6 @@ --- -title: Getting Started +title: Getting Started with Collate | Setup & Onboarding Guide +description: Quickly set up your Collate environment in 30 minutes. Learn how to connect data sources, explore features, and begin your onboarding journey. slug: /getting-started collate: true --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/index.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/index.md index 0e381ea4d26..2ac6013bdfc 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/index.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/index.md @@ -1,5 +1,5 @@ --- -title: Data Profiler | OpenMetadata Data Profiling Guide +title: Data Profiler | `brandName` Data Profiling Guide description: Explore profiling workflows including histogram metrics, null counts, and field-level health. slug: /how-to-guides/data-quality-observability/profiler --- diff --git a/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/tests-ui.md b/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/tests-ui.md index b01b9dfecd4..120378f4912 100644 --- a/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/tests-ui.md +++ b/openmetadata-docs/content/v1.9.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/tests-ui.md @@ -1,5 +1,5 @@ --- -title: Tests - UI Config | OpenMetadata Quality Config Guide +title: Tests - UI Config | `brandName` Quality Config Guide description: Define UI tests to validate data quality during ingestion and enforce expectations at column or table level. slug: /how-to-guides/data-quality-observability/quality/tests-ui ---