diff --git a/.gitignore b/.gitignore index 7b17ab36..6138d15a 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,6 @@ static/llms.txt npm-debug.log* yarn-debug.log* yarn-error.log* + +CLAUDE.md +PLAN.md \ No newline at end of file diff --git a/docs/best-practices/datacoves/README.md b/docs/best-practices/datacoves/README.md index c05b225a..bff66a23 100644 --- a/docs/best-practices/datacoves/README.md +++ b/docs/best-practices/datacoves/README.md @@ -1,5 +1,7 @@ --- -title: Datacoves +title: Datacoves Platform Best Practices +sidebar_label: Datacoves +description: "Recommended practices for organizing and using Datacoves, including project folder structure and configuration guidance for enterprise data engineering teams." sidebar_position: 1 --- # Best practices on datacoves diff --git a/docs/best-practices/datacoves/folder-structure.md b/docs/best-practices/datacoves/folder-structure.md index 37efeb5b..29f09c7b 100644 --- a/docs/best-practices/datacoves/folder-structure.md +++ b/docs/best-practices/datacoves/folder-structure.md @@ -1,5 +1,7 @@ --- -title: Folder structure +title: Datacoves Project Folder Structure Guide +sidebar_label: Folder Structure +description: "Learn the recommended repository layout for Datacoves: required folders like automate/dbt and orchestrate/dags, plus optional dbt-coves configuration paths." sidebar_position: 1 --- diff --git a/docs/best-practices/dbt/README.md b/docs/best-practices/dbt/README.md index cff664be..806622c3 100644 --- a/docs/best-practices/dbt/README.md +++ b/docs/best-practices/dbt/README.md @@ -1,5 +1,7 @@ --- -title: dbt +title: "dbt Best Practices: Tools, Packages & Guidelines" +sidebar_label: dbt +description: "An overview of dbt best practices in Datacoves: macro naming standards, open-source packages, coding tools like dbt-coves and SQLFluff, and governance checks." sidebar_position: 2 --- # Overview diff --git a/docs/best-practices/dbt/dbt-guidelines.md b/docs/best-practices/dbt/dbt-guidelines.md index 7354dba3..ea6a66a5 100644 --- a/docs/best-practices/dbt/dbt-guidelines.md +++ b/docs/best-practices/dbt/dbt-guidelines.md @@ -1,5 +1,7 @@ --- -title: dbt guidelines +title: dbt Project Guidelines for Enterprise Data Teams +sidebar_label: Guidelines +description: "Coding standards and decision-making guidelines for dbt projects in Datacoves: model structure, source definitions, testing, and documentation best practices." sidebar_position: 1 --- diff --git a/docs/best-practices/dbt/inlets-bays-coves.md b/docs/best-practices/dbt/inlets-bays-coves.md index 132da6d5..8fb6a98c 100644 --- a/docs/best-practices/dbt/inlets-bays-coves.md +++ b/docs/best-practices/dbt/inlets-bays-coves.md @@ -1,5 +1,7 @@ --- -title: What are Inlets, Bays, and Coves +title: "Inlets, Bays & Coves: Datacoves dbt Layer Model" +sidebar_label: "Inlets, Bays & Coves" +description: "Understand Datacoves' three-tier dbt architecture: Inlets for raw source data, Bays for intermediate transformations, and Coves for analytics-ready output." sidebar_position: 3 --- diff --git a/docs/best-practices/dbt/object-naming.md b/docs/best-practices/dbt/object-naming.md index d002aced..e5cf8ba1 100644 --- a/docs/best-practices/dbt/object-naming.md +++ b/docs/best-practices/dbt/object-naming.md @@ -1,5 +1,7 @@ --- -title: Object Naming Standards +title: dbt Object Naming Standards in Datacoves +sidebar_label: Object Naming Standards +description: "Naming conventions for dbt models, sources, tests, and macros in Datacoves to ensure consistency and maintainability across large data engineering teams." sidebar_position: 2 --- diff --git a/docs/best-practices/git/README.md b/docs/best-practices/git/README.md index dac6ea06..c2433bc6 100644 --- a/docs/best-practices/git/README.md +++ b/docs/best-practices/git/README.md @@ -1,5 +1,7 @@ --- -title: Git +title: Git Best Practices for Datacoves Data Projects +sidebar_label: Git +description: "Best practices for using Git in Datacoves: branching strategies, commit conventions, and workflow recommendations for data engineering teams." sidebar_position: 3 --- # Git Overview diff --git a/docs/best-practices/snowflake/comparing-tables.md b/docs/best-practices/snowflake/comparing-tables.md index 6b63490d..1fce43c0 100644 --- a/docs/best-practices/snowflake/comparing-tables.md +++ b/docs/best-practices/snowflake/comparing-tables.md @@ -1,5 +1,7 @@ --- -title: Comparing Tables Across Environments +title: Compare Snowflake Tables Across dbt Environments +sidebar_label: Comparing Tables +description: "How to compare row counts, column values, and data distributions across dev, staging, and production Snowflake environments in your dbt workflow." sidebar_position: 5 --- diff --git a/docs/best-practices/snowflake/security-model.md b/docs/best-practices/snowflake/security-model.md index 2e0cade8..5cef5bbf 100644 --- a/docs/best-practices/snowflake/security-model.md +++ b/docs/best-practices/snowflake/security-model.md @@ -1,5 +1,7 @@ --- -title: Security Model +title: Snowflake Security Model for Datacoves Projects +sidebar_label: Security Model +description: "Best practices for Snowflake role-based access control, user management, and security configuration for data engineering teams using Datacoves." sidebar_position: 2 --- diff --git a/docs/best-practices/snowflake/time-travel.md b/docs/best-practices/snowflake/time-travel.md index fe6e867f..a113e4aa 100644 --- a/docs/best-practices/snowflake/time-travel.md +++ b/docs/best-practices/snowflake/time-travel.md @@ -1,5 +1,7 @@ --- -title: GDPR and Time-Travel +title: Snowflake Time Travel & GDPR Best Practices +sidebar_label: Time Travel & GDPR +description: "How to use Snowflake Time Travel for data recovery while managing GDPR compliance, including data retention policies and personal data handling guidance." sidebar_position: 3 --- diff --git a/docs/best-practices/vscode/README.md b/docs/best-practices/vscode/README.md index b92ceee2..495525ad 100644 --- a/docs/best-practices/vscode/README.md +++ b/docs/best-practices/vscode/README.md @@ -1,5 +1,7 @@ --- -title: VS Code +title: VS Code Best Practices for Datacoves Developers +sidebar_label: VS Code +description: "Tips and best practices for using VS Code in the Datacoves Transform tab, including extensions, settings, and productivity recommendations for dbt teams." sidebar_position: 5 --- # VS Code Best Practices and Tips diff --git a/docs/best-practices/vscode/tips.md b/docs/best-practices/vscode/tips.md index 49965bc6..8fe825fd 100644 --- a/docs/best-practices/vscode/tips.md +++ b/docs/best-practices/vscode/tips.md @@ -1,5 +1,7 @@ --- -title: VS Code Tips +title: VS Code Tips and Tricks for Datacoves Users +sidebar_label: Tips & Tricks +description: "Productivity tips and keyboard shortcuts for VS Code in Datacoves: navigation, multi-cursor editing, terminal tricks, and dbt workflow optimizations." sidebar_position: 138 --- # VS Code Tips and tricks diff --git a/docs/getting-started/Admin/configure-airflow.md b/docs/getting-started/Admin/configure-airflow.md index a29bf33a..2f862800 100644 --- a/docs/getting-started/Admin/configure-airflow.md +++ b/docs/getting-started/Admin/configure-airflow.md @@ -1,5 +1,7 @@ --- -title: Airflow - Configure +title: Airflow Setup Guide for Datacoves Administrators +sidebar_label: Configure Airflow +description: "Step-by-step guide to configure Airflow in Datacoves: set up service connections, repository structure, and notification integrations for scheduling dbt jobs." sidebar_position: 2 --- # Configuring Airflow diff --git a/docs/getting-started/Admin/configure-repository-using-dbt-coves.md b/docs/getting-started/Admin/configure-repository-using-dbt-coves.md index f0d8eed9..c08015f3 100644 --- a/docs/getting-started/Admin/configure-repository-using-dbt-coves.md +++ b/docs/getting-started/Admin/configure-repository-using-dbt-coves.md @@ -1,5 +1,7 @@ --- -title: Configure Git Repository Using dbt-coves +title: Initialize a Datacoves Repository with dbt-coves +sidebar_label: Configure Git Repository Using dbt-coves +description: "Use dbt-coves setup to scaffold a fully configured Datacoves project with dbt, Airflow, CI/CD pipelines, SQLFluff, and data warehouse adapters in one command." sidebar_position: 12 --- # Initial Datacoves Repository Setup diff --git a/docs/getting-started/Admin/configure-repository.md b/docs/getting-started/Admin/configure-repository.md index c9acb2a7..a030af79 100644 --- a/docs/getting-started/Admin/configure-repository.md +++ b/docs/getting-started/Admin/configure-repository.md @@ -1,5 +1,7 @@ --- -title: Configure Git Repository +title: Configure Your Git Repository for Airflow DAGs +sidebar_label: Configure Git Repository +description: "Set up the required folder structure in your git repository for Airflow: create orchestrate/dags, the airflow_development branch, and a profiles.yml file." sidebar_position: 8 --- # Update Repository for Airflow diff --git a/docs/getting-started/Admin/creating-airflow-dags.md b/docs/getting-started/Admin/creating-airflow-dags.md index dc876dc9..f00c65dc 100644 --- a/docs/getting-started/Admin/creating-airflow-dags.md +++ b/docs/getting-started/Admin/creating-airflow-dags.md @@ -1,5 +1,7 @@ --- -title: Airflow - Creating Dags +title: Creating Your First Airflow DAGs in Datacoves +sidebar_label: Create Airflow DAGs +description: "Learn to write Airflow DAGs in Datacoves: run dbt with Python DAGs or auto-generate them from YAML definitions using dbt-coves generate airflow-dags." sidebar_position: 3 --- # Creating Airflow Dags diff --git a/docs/getting-started/Admin/user-management.md b/docs/getting-started/Admin/user-management.md index 9d851dca..136a6114 100644 --- a/docs/getting-started/Admin/user-management.md +++ b/docs/getting-started/Admin/user-management.md @@ -1,5 +1,7 @@ --- -title: User Management +title: "Datacoves User Management: Invite, Edit & Remove" +sidebar_label: User Management +description: "Invite new users to Datacoves, manage their project and environment permissions, and remove accounts when access is no longer needed." sidebar_position: 20 --- # User Management diff --git a/docs/getting-started/create-account.md b/docs/getting-started/create-account.md index 6b909cc0..46ab8c4d 100644 --- a/docs/getting-started/create-account.md +++ b/docs/getting-started/create-account.md @@ -1,5 +1,7 @@ --- -title: Account Pre-reqs +title: Account Prerequisites for Setting Up Datacoves +sidebar_label: Create Account +description: "What you need before your Datacoves setup call: data warehouse credentials, git repository access, dbt version, and authentication method for SSO." sidebar_position: 1 --- # Configure your account with Datacoves diff --git a/docs/getting-started/developer/snowflake-extension.mdx b/docs/getting-started/developer/snowflake-extension.mdx index da916c65..119ad020 100644 --- a/docs/getting-started/developer/snowflake-extension.mdx +++ b/docs/getting-started/developer/snowflake-extension.mdx @@ -1,5 +1,7 @@ --- -title: Snowflake Extension +title: Snowflake VS Code Extension in Datacoves +sidebar_label: Snowflake Extension +description: "Video guide to the Snowflake VS Code extension in Datacoves: sign in, browse database objects, run queries, and use autocomplete directly in the browser IDE." sidebar_position: 3 --- # Getting Started with the Snowflake Extension diff --git a/docs/getting-started/developer/transform-tab.mdx b/docs/getting-started/developer/transform-tab.mdx index 22b79ed4..50df939c 100644 --- a/docs/getting-started/developer/transform-tab.mdx +++ b/docs/getting-started/developer/transform-tab.mdx @@ -1,5 +1,7 @@ --- -title: Transform Tab +title: Getting Started with the Datacoves Transform Tab +sidebar_label: Transform Tab +description: "Video walkthrough of the Datacoves Transform tab: configure VS Code settings, set up your terminal, navigate the editor, and reset your environment." sidebar_position: 4 --- # Getting Started with the VS Code in the browser via the Transform Tab diff --git a/docs/getting-started/developer/using-git.mdx b/docs/getting-started/developer/using-git.mdx index a7523ea5..f4907dfb 100644 --- a/docs/getting-started/developer/using-git.mdx +++ b/docs/getting-started/developer/using-git.mdx @@ -1,5 +1,7 @@ --- -title: Using Git +title: "Git Basics in Datacoves: Branches and Changes" +sidebar_label: Using Git +description: "Essential Git commands for Datacoves developers: create and switch branches, stage and commit changes, stash work, undo commits, and use aliased shortcuts." sidebar_position: 5 --- # Getting Started with Git - Branches and Changes diff --git a/docs/getting-started/developer/working-with-dbt-datacoves/index.mdx b/docs/getting-started/developer/working-with-dbt-datacoves/index.mdx index 5243766c..9d85649e 100644 --- a/docs/getting-started/developer/working-with-dbt-datacoves/index.mdx +++ b/docs/getting-started/developer/working-with-dbt-datacoves/index.mdx @@ -1,5 +1,7 @@ --- -title: Working with dbt in Datacoves +title: "Working with dbt in Datacoves: Models & Testing" +sidebar_label: Working with dbt +description: "Create, run, and test dbt models in Datacoves using the VS Code IDE, dbt-coves source generation, lineage views, and the Power User extension." sidebar_position: 6 --- # Getting Started with dbt in Datacoves diff --git a/docs/getting-started/developer/working-with-dbt-datacoves/lineage-view.md b/docs/getting-started/developer/working-with-dbt-datacoves/lineage-view.md index 46f38b24..93bd007a 100644 --- a/docs/getting-started/developer/working-with-dbt-datacoves/lineage-view.md +++ b/docs/getting-started/developer/working-with-dbt-datacoves/lineage-view.md @@ -1,6 +1,7 @@ --- -title: Lineage View - +title: Explore dbt Lineage Graphs in Datacoves VS Code +sidebar_label: Lineage View +description: "Use the Datacoves Lineage View panel to visualize dbt model dependencies, run or test models directly from the graph, and adjust node expansion depth." --- # Lineage View diff --git a/docs/how-tos/airflow/DAGs/create-dag-level-docs.md b/docs/how-tos/airflow/DAGs/create-dag-level-docs.md index 498e2b43..28b2b49c 100644 --- a/docs/how-tos/airflow/DAGs/create-dag-level-docs.md +++ b/docs/how-tos/airflow/DAGs/create-dag-level-docs.md @@ -1,5 +1,7 @@ --- -title: DAGs - Add Dag Documentation +title: Add Documentation to Airflow DAGs in Datacoves +sidebar_label: Add Documentation +description: "How to add Markdown documentation directly to Airflow DAGs in Datacoves so operators can read context in the Airflow UI and Grid view." sidebar_position: 20 --- # How to Add Docs at the DAG Level in Airflow diff --git a/docs/how-tos/airflow/DAGs/dynamically-set-schedule.md b/docs/how-tos/airflow/DAGs/dynamically-set-schedule.md index 227d0c38..cc6eae39 100644 --- a/docs/how-tos/airflow/DAGs/dynamically-set-schedule.md +++ b/docs/how-tos/airflow/DAGs/dynamically-set-schedule.md @@ -1,5 +1,7 @@ --- -title: DAGs - Dynamically Set Schedule +title: Dynamically Set Airflow Schedule Intervals +sidebar_label: Dynamic Schedule +description: "Use environment variables or Airflow Variables to dynamically configure DAG schedule intervals in Datacoves for flexible pipeline orchestration." sidebar_position: 22 --- # How to Dynamically set the schedule Interval diff --git a/docs/how-tos/airflow/DAGs/external-python-dag.md b/docs/how-tos/airflow/DAGs/external-python-dag.md index fae5c8c9..47334ecb 100644 --- a/docs/how-tos/airflow/DAGs/external-python-dag.md +++ b/docs/how-tos/airflow/DAGs/external-python-dag.md @@ -1,5 +1,7 @@ --- -title: DAGs - Calling External Python Scripts +title: Call External Python Scripts from Airflow DAGs +sidebar_label: External Python Scripts +description: "Use DatacovesBashOperator to run external Python scripts from Airflow DAGs in Datacoves, with custom packages pre-installed in the worker environment." sidebar_position: 21 --- # External Python DAG diff --git a/docs/how-tos/airflow/DAGs/generate-dags-from-yml.md b/docs/how-tos/airflow/DAGs/generate-dags-from-yml.md index 8939d3b6..b71cb379 100644 --- a/docs/how-tos/airflow/DAGs/generate-dags-from-yml.md +++ b/docs/how-tos/airflow/DAGs/generate-dags-from-yml.md @@ -1,5 +1,7 @@ --- -title: DAGs - Generate DAGs from yml +title: Generate Airflow DAGs from YAML with dbt-coves +sidebar_label: Generate from YAML +description: "Use dbt-coves to auto-generate Airflow Python DAG files from simple YAML definitions, reducing boilerplate and standardizing pipeline creation." sidebar_position: 23 --- # Generate DAGs from yml diff --git a/docs/how-tos/airflow/DAGs/get-current-branch-name.md b/docs/how-tos/airflow/DAGs/get-current-branch-name.md index 92192489..e6ba1b6b 100644 --- a/docs/how-tos/airflow/DAGs/get-current-branch-name.md +++ b/docs/how-tos/airflow/DAGs/get-current-branch-name.md @@ -1,5 +1,7 @@ --- -title: DAGs - Get Current Git Branch Name from a DAG Task +title: Get the Git Branch Name from an Airflow DAG Task +sidebar_label: Get Git Branch Name +description: "Retrieve the current git branch name from within an Airflow DAG task in Datacoves for branch-specific logic or conditional pipeline behavior." sidebar_position: 24 --- # Retrieving the Current Branch Name in a Git Repository diff --git a/docs/how-tos/airflow/DAGs/retry-dbt-tasks.md b/docs/how-tos/airflow/DAGs/retry-dbt-tasks.md index 6cf9e504..590324bc 100644 --- a/docs/how-tos/airflow/DAGs/retry-dbt-tasks.md +++ b/docs/how-tos/airflow/DAGs/retry-dbt-tasks.md @@ -1,5 +1,7 @@ --- -title: DAGs - Retry dbt jobs +title: Retry Failed dbt Tasks in Airflow DAGs +sidebar_label: Retry dbt Tasks +description: "Configure automatic retries for failed dbt tasks in Airflow DAGs in Datacoves, including retry count, delay settings, and email-on-retry behavior." sidebar_position: 29 --- # Retry a dbt task diff --git a/docs/how-tos/airflow/DAGs/run-adf-pipeline.md b/docs/how-tos/airflow/DAGs/run-adf-pipeline.md index 1aa1fc00..fe1ada1c 100644 --- a/docs/how-tos/airflow/DAGs/run-adf-pipeline.md +++ b/docs/how-tos/airflow/DAGs/run-adf-pipeline.md @@ -1,5 +1,7 @@ --- -title: DAGs - Run ADF Pipelines +title: Trigger ADF Pipelines from Airflow in Datacoves +sidebar_label: Run ADF Pipeline +description: "Use Azure Data Factory operators in Airflow DAGs within Datacoves to trigger and monitor ADF pipelines as part of your data orchestration workflow." sidebar_position: 26 --- # Use Microsoft Azure Data Factory Operators diff --git a/docs/how-tos/airflow/DAGs/run-airbyte-sync-jobs.md b/docs/how-tos/airflow/DAGs/run-airbyte-sync-jobs.md index 5079e60c..d246f7d3 100644 --- a/docs/how-tos/airflow/DAGs/run-airbyte-sync-jobs.md +++ b/docs/how-tos/airflow/DAGs/run-airbyte-sync-jobs.md @@ -1,5 +1,7 @@ --- -title: DAGs - Run Airbyte sync jobs +title: Trigger Airbyte Syncs from Airflow in Datacoves +sidebar_label: Run Airbyte Syncs +description: "Orchestrate Airbyte data syncs from Airflow DAGs in Datacoves using the Airbyte provider, with examples for triggering connections and monitoring status." sidebar_position: 27 --- # Run Airbyte sync jobs diff --git a/docs/how-tos/airflow/DAGs/run-databricks-notebook.md b/docs/how-tos/airflow/DAGs/run-databricks-notebook.md index c08f125c..64c95ae4 100644 --- a/docs/how-tos/airflow/DAGs/run-databricks-notebook.md +++ b/docs/how-tos/airflow/DAGs/run-databricks-notebook.md @@ -1,5 +1,7 @@ --- -title: DAGs - Run Databricks Notebooks +title: Run Databricks Notebooks from Airflow DAGs +sidebar_label: Run Databricks Notebook +description: "Trigger and monitor Databricks Notebook runs from Airflow DAGs in Datacoves using the Databricks provider operator with cluster configuration." sidebar_position: 30 --- # Run Databricks Notebooks diff --git a/docs/how-tos/airflow/DAGs/run-dbt.md b/docs/how-tos/airflow/DAGs/run-dbt.md index 54e2360e..771c092a 100644 --- a/docs/how-tos/airflow/DAGs/run-dbt.md +++ b/docs/how-tos/airflow/DAGs/run-dbt.md @@ -1,5 +1,7 @@ --- -title: DAGs - Run dbt +title: "Run dbt from Airflow in Datacoves: DAG Examples" +sidebar_label: Run dbt +description: "Use the Datacoves dbt decorator or operator to run dbt commands from Airflow tasks, with full examples for dbt run, dbt test, and dbt build." sidebar_position: 28 --- # How to run dbt from an Airflow worker diff --git a/docs/how-tos/airflow/DAGs/run-fivetran-sync-jobs.md b/docs/how-tos/airflow/DAGs/run-fivetran-sync-jobs.md index dfb2cc7e..7336b6ba 100644 --- a/docs/how-tos/airflow/DAGs/run-fivetran-sync-jobs.md +++ b/docs/how-tos/airflow/DAGs/run-fivetran-sync-jobs.md @@ -1,5 +1,7 @@ --- -title: DAGs - Run Fivetran sync jobs +title: Trigger Fivetran Syncs from Airflow in Datacoves +sidebar_label: Run Fivetran Syncs +description: "Orchestrate Fivetran connector syncs from Airflow DAGs in Datacoves using the Fivetran provider, with connection ID configuration and monitoring." sidebar_position: 31 --- # Run Fivetran sync jobs diff --git a/docs/how-tos/airflow/DAGs/s3-to-snowflake.md b/docs/how-tos/airflow/DAGs/s3-to-snowflake.md index eb3a4308..86925a2f 100644 --- a/docs/how-tos/airflow/DAGs/s3-to-snowflake.md +++ b/docs/how-tos/airflow/DAGs/s3-to-snowflake.md @@ -1,5 +1,7 @@ --- -title: DAGS - Load from S3 to Snowflake +title: Load S3 Files into Snowflake with Airflow +sidebar_label: S3 to Snowflake +description: "Use Airflow in Datacoves to load files from Amazon S3 into Snowflake using the S3ToSnowflakeOperator, with staging area and copy options." sidebar_position: 25 --- # Loading S3 Files into Snowflake diff --git a/docs/how-tos/airflow/DAGs/test-dags.md b/docs/how-tos/airflow/DAGs/test-dags.md index 79bab21e..53f28df3 100644 --- a/docs/how-tos/airflow/DAGs/test-dags.md +++ b/docs/how-tos/airflow/DAGs/test-dags.md @@ -1,5 +1,7 @@ --- -title: DAGs - Test DAGs +title: Test Airflow DAGs in Your CI/CD Pipeline +sidebar_label: Test DAGs +description: "How to run automated Airflow DAG tests in your CI/CD pipeline using pytest and the Datacoves CLI to catch import errors before deploying to production." sidebar_position: 32 --- # Run DAG tests in your CI/CD diff --git a/docs/how-tos/airflow/DAGs/use-variables-and-connections.md b/docs/how-tos/airflow/DAGs/use-variables-and-connections.md index f0fa3dd6..5e4d8300 100644 --- a/docs/how-tos/airflow/DAGs/use-variables-and-connections.md +++ b/docs/how-tos/airflow/DAGs/use-variables-and-connections.md @@ -1,5 +1,7 @@ --- -title: DAGs - Using Variables and Connections +title: Use Airflow Variables and Connections in DAGs +sidebar_label: Variables & Connections +description: "How to access and use Airflow Variables and Connections in Datacoves DAGs, with best practices for avoiding performance issues during DAG parsing." sidebar_position: 33 --- # Variables and Connections diff --git a/docs/how-tos/airflow/README.md b/docs/how-tos/airflow/README.md index 9eec0528..4fee196c 100644 --- a/docs/how-tos/airflow/README.md +++ b/docs/how-tos/airflow/README.md @@ -1,5 +1,7 @@ --- -title: Airflow - What to know +title: "Airflow in Datacoves: Key Things to Know First" +sidebar_label: What to know +description: "Important notes before writing Airflow DAGs in Datacoves: Ruff linting, Datacoves decorators, and My Airflow for faster personal DAG development." sidebar_position: 1 id: airflow-index --- diff --git a/docs/how-tos/airflow/api-triggered-dag.md b/docs/how-tos/airflow/api-triggered-dag.md index b23c1e05..e4c89488 100644 --- a/docs/how-tos/airflow/api-triggered-dag.md +++ b/docs/how-tos/airflow/api-triggered-dag.md @@ -1,5 +1,7 @@ --- -title: Airflow - Trigger a DAG using Datasets +title: How to Trigger an Airflow DAG Using Datasets +sidebar_label: Trigger DAG via Datasets +description: "Step-by-step guide to triggering Airflow DAGs via dataset events in Datacoves, enabling data-driven pipeline orchestration without time-based schedules." sidebar_position: 6 --- # How to Trigger a DAG using Datasets diff --git a/docs/how-tos/airflow/customize-worker-environment.md b/docs/how-tos/airflow/customize-worker-environment.md index 570a33ea..63e2aa34 100644 --- a/docs/how-tos/airflow/customize-worker-environment.md +++ b/docs/how-tos/airflow/customize-worker-environment.md @@ -1,5 +1,7 @@ --- -title: Worker - Custom Worker Environment +title: Set Up a Custom Environment for Airflow Workers +sidebar_label: Worker - Custom Environment +description: "Configure a custom Docker image for Airflow workers in Datacoves to include specific Python packages, libraries, or dependencies your DAGs require." sidebar_position: 39 --- # How to set up a custom environment for your Airflow workers diff --git a/docs/how-tos/airflow/initial-setup.mdx b/docs/how-tos/airflow/initial-setup.mdx index d0eebf74..bd930514 100644 --- a/docs/how-tos/airflow/initial-setup.mdx +++ b/docs/how-tos/airflow/initial-setup.mdx @@ -1,5 +1,7 @@ --- -title: Airflow - Initial setup +title: Airflow Configuration Guide for Datacoves Admins +sidebar_label: Initial Setup +description: "Configure Airflow in Datacoves: set DAG paths, git sync branch, Kubernetes executor settings, and environment-level service connections for dbt jobs." sidebar_position: 1 --- import Tabs from '@theme/Tabs'; diff --git a/docs/how-tos/airflow/request-resources-on-workers.md b/docs/how-tos/airflow/request-resources-on-workers.md index f07771bc..0ada0080 100644 --- a/docs/how-tos/airflow/request-resources-on-workers.md +++ b/docs/how-tos/airflow/request-resources-on-workers.md @@ -1,5 +1,7 @@ --- -title: Worker - Request Memory and CPU +title: Request Custom CPU & Memory for Airflow Workers +sidebar_label: Worker - Request CPU & Memory +description: "Configure Kubernetes resource requests for individual Airflow tasks in Datacoves to allocate specific CPU and memory limits per DAG task." sidebar_position: 40 --- # How to request more memory or cpu resources on a particular DAG task diff --git a/docs/how-tos/airflow/send-emails.md b/docs/how-tos/airflow/send-emails.md index c5e9b98d..8e69f33d 100644 --- a/docs/how-tos/airflow/send-emails.md +++ b/docs/how-tos/airflow/send-emails.md @@ -1,5 +1,7 @@ --- -title: Notifications - Send Emails +title: Send Email Notifications on Airflow DAG Failure +sidebar_label: Notifications - Email +description: "Configure email alerts for Airflow DAG failures in Datacoves: set up SMTP integration, define recipient lists, and handle task-level notifications." sidebar_position: 34 --- # How to send email notifications on DAG's failure diff --git a/docs/how-tos/airflow/send-ms-teams-notifications.md b/docs/how-tos/airflow/send-ms-teams-notifications.md index fe61db17..96748e6b 100644 --- a/docs/how-tos/airflow/send-ms-teams-notifications.md +++ b/docs/how-tos/airflow/send-ms-teams-notifications.md @@ -1,5 +1,7 @@ --- -title: Notifications - Send Microsoft Teams notifications +title: Send MS Teams Alerts on Airflow DAG Failure +sidebar_label: Notifications - MS Teams +description: "Configure Microsoft Teams notifications for Airflow DAGs in Datacoves to receive alerts when pipeline tasks succeed, fail, or are retried." sidebar_position: 35 --- # How to send Microsoft Teams notifications on DAG's status diff --git a/docs/how-tos/airflow/send-slack-notifications.md b/docs/how-tos/airflow/send-slack-notifications.md index e451b1d1..938532c1 100644 --- a/docs/how-tos/airflow/send-slack-notifications.md +++ b/docs/how-tos/airflow/send-slack-notifications.md @@ -1,5 +1,7 @@ --- -title: Notifications - Send Slack notifications +title: Send Slack Notifications on Airflow DAG Status +sidebar_label: Notifications - Slack +description: "Set up Slack alerts for Airflow DAG events in Datacoves: connect a workspace, configure channel routing, and receive success or failure messages." sidebar_position: 36 --- # How to send Slack notifications on DAG's status diff --git a/docs/how-tos/airflow/sync-database.mdx b/docs/how-tos/airflow/sync-database.mdx index 764eba72..bb8f3817 100644 --- a/docs/how-tos/airflow/sync-database.mdx +++ b/docs/how-tos/airflow/sync-database.mdx @@ -1,5 +1,7 @@ --- -title: Airflow - Sync Internal Airflow database +title: Sync the Internal Airflow Database in Datacoves +sidebar_label: Sync Internal Database +description: "How to sync the internal Airflow metadata database in Datacoves to apply configuration changes, reset state, or recover from database inconsistencies." sidebar_position: 3 --- diff --git a/docs/how-tos/airflow/use-airflow-api.md b/docs/how-tos/airflow/use-airflow-api.md index 3e5dc679..bdd1d077 100644 --- a/docs/how-tos/airflow/use-airflow-api.md +++ b/docs/how-tos/airflow/use-airflow-api.md @@ -1,5 +1,7 @@ --- -title: Airflow - Accessing the Airflow API +title: Access the Airflow REST API in Datacoves +sidebar_label: Airflow REST API +description: "Authenticate with and call the Airflow REST API in Datacoves: generate API tokens, trigger DAGs, check run status, and query task instances programmatically." sidebar_position: 2 --- # How to use the Airflow API diff --git a/docs/how-tos/airflow/use-aws-secrets-manager.mdx b/docs/how-tos/airflow/use-aws-secrets-manager.mdx index 2a5924f9..78255f50 100644 --- a/docs/how-tos/airflow/use-aws-secrets-manager.mdx +++ b/docs/how-tos/airflow/use-aws-secrets-manager.mdx @@ -1,5 +1,7 @@ --- -title: Secrets - AWS Secrets Manager +title: Use AWS Secrets Manager for Airflow in Datacoves +sidebar_label: Secrets - AWS Secrets Manager +description: "Configure AWS Secrets Manager as the secrets backend for Apache Airflow in Datacoves to securely store and retrieve connections and variables." sidebar_position: 36 --- # How to use AWS Secrets Manager in Airflow diff --git a/docs/how-tos/airflow/use-datacoves-secrets-manager.mdx b/docs/how-tos/airflow/use-datacoves-secrets-manager.mdx index e44fc254..531216d1 100644 --- a/docs/how-tos/airflow/use-datacoves-secrets-manager.mdx +++ b/docs/how-tos/airflow/use-datacoves-secrets-manager.mdx @@ -1,5 +1,7 @@ --- -title: Secrets - Datacoves secrets manager +title: Use the Datacoves Secrets Manager in Airflow +sidebar_label: Secrets - Datacoves Manager +description: "How to use the built-in Datacoves Secrets Manager to store and inject secrets into Airflow connections and variables without exposing credentials in code." sidebar_position: 38 --- diff --git a/docs/how-tos/airflow/use-key-pair-authentication.md b/docs/how-tos/airflow/use-key-pair-authentication.md index b7249de0..8eacf1f1 100644 --- a/docs/how-tos/airflow/use-key-pair-authentication.md +++ b/docs/how-tos/airflow/use-key-pair-authentication.md @@ -1,5 +1,7 @@ --- -title: Airflow - Use Key-Pair Authentication +title: Use Key-Pair Authentication in Airflow +sidebar_label: Key-Pair Authentication +description: "Configure Snowflake key-pair authentication for Airflow connections in Datacoves instead of password-based credentials for improved security." sidebar_position: 10 --- # Using Key-Pair Authentication in Airflow diff --git a/docs/how-tos/datacoves/how_to_connection_template.md b/docs/how-tos/datacoves/how_to_connection_template.md index 9151b9dd..0d76b36e 100644 --- a/docs/how-tos/datacoves/how_to_connection_template.md +++ b/docs/how-tos/datacoves/how_to_connection_template.md @@ -1,5 +1,7 @@ --- -title: Configure Connection Templates +title: Create and Edit Datacoves Connection Templates +sidebar_label: Configure Connection Templates +description: "How to create and manage connection templates in Datacoves to standardize data warehouse credentials across projects and environments." sidebar_position: 42 --- # How to Create/Edit Connection Template diff --git a/docs/how-tos/datacoves/how_to_environment_variables.md b/docs/how-tos/datacoves/how_to_environment_variables.md index 7c4b1ad2..8ffccdfe 100644 --- a/docs/how-tos/datacoves/how_to_environment_variables.md +++ b/docs/how-tos/datacoves/how_to_environment_variables.md @@ -1,5 +1,7 @@ --- -title: Configure VSCode Environment Variables +title: Add Custom Environment Variables to VS Code +sidebar_label: Configure VS Code Env Vars +description: "Configure custom environment variables for the VS Code IDE in Datacoves environments to pass secrets, settings, or tool configuration to developers." sidebar_position: 52 --- # How to use custom VSCode Environment Variables diff --git a/docs/how-tos/datacoves/how_to_environments.md b/docs/how-tos/datacoves/how_to_environments.md index 0f5e664e..d682d017 100644 --- a/docs/how-tos/datacoves/how_to_environments.md +++ b/docs/how-tos/datacoves/how_to_environments.md @@ -1,5 +1,7 @@ --- -title: Configure Environments +title: Create and Configure Datacoves Environments +sidebar_label: Configure Environments +description: "Step-by-step guide to creating and editing Datacoves environments: configure VS Code, Airflow, Superset, and service connection settings per environment." sidebar_position: 44 --- # How to Create/Edit an Environment diff --git a/docs/how-tos/datacoves/how_to_groups.md b/docs/how-tos/datacoves/how_to_groups.md index 1f16176f..19f8e667 100644 --- a/docs/how-tos/datacoves/how_to_groups.md +++ b/docs/how-tos/datacoves/how_to_groups.md @@ -1,5 +1,7 @@ --- -title: Configure Groups +title: Create and Manage User Groups in Datacoves +sidebar_label: Configure Groups +description: "How to create and configure user groups in Datacoves to assign roles and control access to projects and environments at scale." sidebar_position: 45 --- # How to Create/Edit a Group diff --git a/docs/how-tos/datacoves/how_to_integrations.md b/docs/how-tos/datacoves/how_to_integrations.md index cb9386bd..6b0f7127 100644 --- a/docs/how-tos/datacoves/how_to_integrations.md +++ b/docs/how-tos/datacoves/how_to_integrations.md @@ -1,5 +1,7 @@ --- -title: Configure Integrations +title: Set Up Integrations in the Datacoves Admin Panel +sidebar_label: Configure Integrations +description: "How to create and configure integrations in Datacoves, including notification services like Slack and Teams for Airflow DAG alerts." sidebar_position: 46 --- # How to Create/Edit an Integration diff --git a/docs/how-tos/datacoves/how_to_invitations.md b/docs/how-tos/datacoves/how_to_invitations.md index 0f42ec73..f6110c4e 100644 --- a/docs/how-tos/datacoves/how_to_invitations.md +++ b/docs/how-tos/datacoves/how_to_invitations.md @@ -1,5 +1,7 @@ --- -title: Configure Invitations +title: Invite Users to Your Datacoves Account +sidebar_label: Configure Invitations +description: "Send email invitations to new Datacoves users, assign them to projects or environments, and configure their initial access permissions." sidebar_position: 47 --- # How to Invite a User to your Account diff --git a/docs/how-tos/datacoves/how_to_manage_users.md b/docs/how-tos/datacoves/how_to_manage_users.md index 0c48f1d7..37c66ea4 100644 --- a/docs/how-tos/datacoves/how_to_manage_users.md +++ b/docs/how-tos/datacoves/how_to_manage_users.md @@ -1,5 +1,7 @@ --- -title: Manage Users +title: "Manage Datacoves Users: Edit and Remove Access" +sidebar_label: Manage Users +description: "Edit user roles, change project and environment access, deactivate accounts, and permanently delete users from your Datacoves organization." sidebar_position: 56 --- # How to Manage Users diff --git a/docs/how-tos/datacoves/how_to_projects/README.md b/docs/how-tos/datacoves/how_to_projects/README.md index 4d32fdf5..8ef427c5 100644 --- a/docs/how-tos/datacoves/how_to_projects/README.md +++ b/docs/how-tos/datacoves/how_to_projects/README.md @@ -1,5 +1,7 @@ --- -title: Configure Projects +title: Create and Configure Datacoves Projects +sidebar_label: Configure Projects +description: "How to set up a Datacoves project: configure git repository access via SSH or HTTPS, link CI/CD pipelines, and configure the secrets backend." sidebar_position: 48 --- diff --git a/docs/how-tos/datacoves/how_to_projects/how_to_configure_aws_secrets_manager.md b/docs/how-tos/datacoves/how_to_projects/how_to_configure_aws_secrets_manager.md index bfb1d849..07d4b426 100644 --- a/docs/how-tos/datacoves/how_to_projects/how_to_configure_aws_secrets_manager.md +++ b/docs/how-tos/datacoves/how_to_projects/how_to_configure_aws_secrets_manager.md @@ -1,5 +1,7 @@ --- -title: Configure AWS Secrets Manager +title: "Add AWS Secrets Manager as a Datacoves Backend" +sidebar_label: "Configure AWS Secrets Manager" +description: "Connect AWS Secrets Manager to Datacoves as a project-level secrets backend to securely inject credentials into Airflow and VS Code environments." sidebar_position: 50 --- # Configuring AWS Secrets Manager diff --git a/docs/how-tos/datacoves/how_to_projects/how_to_configure_azure_DevOps.mdx b/docs/how-tos/datacoves/how_to_projects/how_to_configure_azure_DevOps.mdx index db6a533f..3a14747b 100644 --- a/docs/how-tos/datacoves/how_to_projects/how_to_configure_azure_DevOps.mdx +++ b/docs/how-tos/datacoves/how_to_projects/how_to_configure_azure_DevOps.mdx @@ -1,5 +1,7 @@ --- -title: Configure Azure DevOps +title: "Connect Azure DevOps Repos to Datacoves Projects" +sidebar_label: "Configure Azure DevOps" +description: "Set up Azure DevOps as your git provider in Datacoves using EntraID app authentication with certificate or client secret for repository access." sidebar_position: 51 --- diff --git a/docs/how-tos/datacoves/how_to_secrets.md b/docs/how-tos/datacoves/how_to_secrets.md index 261208d3..bd0fefe6 100644 --- a/docs/how-tos/datacoves/how_to_secrets.md +++ b/docs/how-tos/datacoves/how_to_secrets.md @@ -1,5 +1,7 @@ --- -title: Configure Datacoves Secret +title: "Create and Manage Secrets in Datacoves" +sidebar_label: "Configure Secrets" +description: "How to create, edit, and share secrets in Datacoves, including raw JSON and key-value formats for injecting credentials into developer environments." sidebar_position: 43 --- # How to Create/Edit a Secret diff --git a/docs/how-tos/datacoves/how_to_service_connections.md b/docs/how-tos/datacoves/how_to_service_connections.md index 0c4f9f0d..2a89d017 100644 --- a/docs/how-tos/datacoves/how_to_service_connections.md +++ b/docs/how-tos/datacoves/how_to_service_connections.md @@ -1,5 +1,7 @@ --- -title: Configure Service Connections +title: "Configure Data Warehouse Service Connections" +sidebar_label: "Configure Service Connections" +description: "Set up Datacoves service connections to securely deliver warehouse credentials to Airflow and VS Code as environment variables or Airflow connections." sidebar_position: 49 --- # How to Create/Edit a Service Connection diff --git a/docs/how-tos/datacoves/how_to_worker_usage.md b/docs/how-tos/datacoves/how_to_worker_usage.md index a2814e8e..9486d379 100644 --- a/docs/how-tos/datacoves/how_to_worker_usage.md +++ b/docs/how-tos/datacoves/how_to_worker_usage.md @@ -1,5 +1,7 @@ --- -title: Worker Usage Minutes API +title: "Use the Datacoves Billing API for Worker Minutes" +sidebar_label: "Worker Usage Minutes API" +description: "Call the Datacoves Billing API to retrieve Airflow and Airbyte worker usage minutes per environment, with date filtering and authentication setup." sidebar_position: 55 --- diff --git a/docs/how-tos/datacoves/metrics-and-logs/README.md b/docs/how-tos/datacoves/metrics-and-logs/README.md index fd55004d..88c62e69 100644 --- a/docs/how-tos/datacoves/metrics-and-logs/README.md +++ b/docs/how-tos/datacoves/metrics-and-logs/README.md @@ -1,5 +1,7 @@ --- -title: Metrics & Logs +title: "Monitor Services with Datacoves Metrics and Logs" +sidebar_label: "Metrics & Logs" +description: "How to use Grafana dashboards in Datacoves to monitor Airflow jobs, Docker image builds, and other platform metrics. Requires Admin or Project Admin role." sidebar_position: 70 --- # Metrics and Logs How Tos diff --git a/docs/how-tos/datacoves/metrics-and-logs/grafana.md b/docs/how-tos/datacoves/metrics-and-logs/grafana.md index 8e76da8b..845a8893 100644 --- a/docs/how-tos/datacoves/metrics-and-logs/grafana.md +++ b/docs/how-tos/datacoves/metrics-and-logs/grafana.md @@ -1,5 +1,7 @@ --- -title: Grafana +title: "Navigate and Use Grafana Dashboards in Datacoves" +sidebar_label: "Grafana" +description: "Access and navigate prebuilt Grafana dashboards in Datacoves to monitor Airflow tasks, Kubernetes resources, and platform service health." sidebar_position: 133 --- # Grafana Dashboards diff --git a/docs/how-tos/datacoves/metrics-and-logs/view-failed-git-sync.md b/docs/how-tos/datacoves/metrics-and-logs/view-failed-git-sync.md index ee840a6c..5f777368 100644 --- a/docs/how-tos/datacoves/metrics-and-logs/view-failed-git-sync.md +++ b/docs/how-tos/datacoves/metrics-and-logs/view-failed-git-sync.md @@ -1,5 +1,7 @@ --- -title: Git Sync/S3 Failures +title: "Monitor Git Sync and S3 Failures in Datacoves" +sidebar_label: "Git Sync/S3 Failures" +description: "View and diagnose git repository sync failures and S3 artifact upload errors in Datacoves using the Grafana monitoring dashboards." sidebar_position: 73 --- # Monitor git sync or s3 sync failure diff --git a/docs/how-tos/datahub/how_to_datahub_cli.md b/docs/how-tos/datahub/how_to_datahub_cli.md index e1f0fbd2..f8020e28 100644 --- a/docs/how-tos/datahub/how_to_datahub_cli.md +++ b/docs/how-tos/datahub/how_to_datahub_cli.md @@ -1,5 +1,7 @@ --- -title: Manage datahub using CLI +title: "Use the DataHub CLI from Datacoves VS Code" +sidebar_label: "DataHub CLI" +description: "How to install and use the DataHub CLI from the Datacoves VS Code terminal to manage metadata, run ingestion recipes, and interact with your DataHub instance." sidebar_position: 61 --- # How to use DataHub's CLI from your VS Code terminal diff --git a/docs/how-tos/datahub/how_to_datahub_dbt.md b/docs/how-tos/datahub/how_to_datahub_dbt.md index efe7de37..18dac198 100644 --- a/docs/how-tos/datahub/how_to_datahub_dbt.md +++ b/docs/how-tos/datahub/how_to_datahub_dbt.md @@ -1,5 +1,7 @@ --- -title: Configure dbt metadata ingestion +title: "Ingest dbt Metadata into DataHub from Datacoves" +sidebar_label: "dbt Metadata Ingestion" +description: "Set up and run dbt metadata ingestion into DataHub from Datacoves: configure the ingestion recipe, run the connector, and browse lineage in DataHub." sidebar_position: 59 --- # Ingesting dbt Metadata into DataHub diff --git a/docs/how-tos/datahub/how_to_datahub_snowflake.md b/docs/how-tos/datahub/how_to_datahub_snowflake.md index 5eb559e0..46350f4a 100644 --- a/docs/how-tos/datahub/how_to_datahub_snowflake.md +++ b/docs/how-tos/datahub/how_to_datahub_snowflake.md @@ -1,5 +1,7 @@ --- -title: Configure Snowflake metadata ingestion +title: "Connect Snowflake to DataHub via Datacoves" +sidebar_label: "Snowflake Metadata Ingestion" +description: "Configure Snowflake metadata ingestion into DataHub in Datacoves: set up the Snowflake DataHub connector, configure credentials, and run the recipe." sidebar_position: 60 --- # How to ingest Snowflake metadata into DataHub diff --git a/docs/how-tos/dataops/README.md b/docs/how-tos/dataops/README.md index 32a6723a..412209a7 100644 --- a/docs/how-tos/dataops/README.md +++ b/docs/how-tos/dataops/README.md @@ -1,5 +1,7 @@ --- -title: DataOps +title: "DataOps How-To Guides for Datacoves Teams" +sidebar_label: "Overview" +description: "How-to guides for DataOps practices in Datacoves: define workflows, develop and release features, and trigger CI/CD pipelines without code changes." sidebar_position: 4 --- # DataOps in Datacoves diff --git a/docs/how-tos/dataops/releasing-new-feature.md b/docs/how-tos/dataops/releasing-new-feature.md index d6957c69..154a56e5 100644 --- a/docs/how-tos/dataops/releasing-new-feature.md +++ b/docs/how-tos/dataops/releasing-new-feature.md @@ -1,5 +1,7 @@ --- -title: Releasing a new feature +title: "Develop and Release dbt Features in Datacoves" +sidebar_label: "Release a Feature" +description: "Step-by-step workflow for developing a new dbt feature in Datacoves: branch, build, test, open a PR, and promote changes through environments to production." sidebar_position: 63 --- # How to develop and release a feature diff --git a/docs/how-tos/dataops/trigger-cicd-workflow.md b/docs/how-tos/dataops/trigger-cicd-workflow.md index 3322b909..f7ae975d 100644 --- a/docs/how-tos/dataops/trigger-cicd-workflow.md +++ b/docs/how-tos/dataops/trigger-cicd-workflow.md @@ -1,5 +1,7 @@ --- -title: Trigger CI/CD without code changes +title: "Trigger CI/CD Pipelines Without Code Changes" +sidebar_label: "Trigger CI/CD" +description: "How to manually trigger a CI/CD workflow in Datacoves without committing code changes, using an empty commit or repository dispatch event." sidebar_position: 72 --- # How to trigger a CI/CD run without code changes diff --git a/docs/how-tos/dbt/advenced-dbt-debug.md b/docs/how-tos/dbt/advenced-dbt-debug.md index b322a8ed..915f6c24 100644 --- a/docs/how-tos/dbt/advenced-dbt-debug.md +++ b/docs/how-tos/dbt/advenced-dbt-debug.md @@ -1,5 +1,7 @@ --- -title: Advanced Debugging +title: "Debug dbt Models and Macros in Datacoves" +sidebar_label: "Advanced Debugging" +description: "Advanced techniques for debugging dbt models and macros in Datacoves: use VS Code breakpoints, dbt compile previews, and SQLFluff to diagnose errors." sidebar_position: 65 --- # How to Debug dbt Models and Macros diff --git a/docs/how-tos/dbt/compilation-errors.md b/docs/how-tos/dbt/compilation-errors.md index a200a325..fb74def1 100644 --- a/docs/how-tos/dbt/compilation-errors.md +++ b/docs/how-tos/dbt/compilation-errors.md @@ -1,5 +1,7 @@ --- -title: Compilation Errors +title: "Fix dbt Compilation Errors in Datacoves" +sidebar_label: "Compilation Errors" +description: "Identify and resolve common dbt compilation errors in Datacoves, including undefined refs, missing sources, invalid Jinja syntax, and YAML parsing issues." sidebar_position: 66 --- # How to Fix dbt Compilation Errors diff --git a/docs/how-tos/dbt/database-errors.md b/docs/how-tos/dbt/database-errors.md index d448c495..2129f86d 100644 --- a/docs/how-tos/dbt/database-errors.md +++ b/docs/how-tos/dbt/database-errors.md @@ -1,5 +1,7 @@ --- -title: Database Errors +title: "How to Fix dbt Database and SQL Errors" +sidebar_label: "Database Errors" +description: "Troubleshoot and resolve dbt database errors in Datacoves, including permission issues, schema mismatches, and warehouse connection failures." sidebar_position: 67 --- # How to Fix dbt Database Errors diff --git a/docs/how-tos/dbt/dependency-errors.md b/docs/how-tos/dbt/dependency-errors.md index 13cfe6dd..21557de8 100644 --- a/docs/how-tos/dbt/dependency-errors.md +++ b/docs/how-tos/dbt/dependency-errors.md @@ -1,5 +1,7 @@ --- -title: Dependency Errors +title: "Fix dbt Package Dependency Errors in Datacoves" +sidebar_label: "Dependency Errors" +description: "Resolve dbt dependency and package errors in Datacoves, including dbt deps failures, version conflicts, and missing package configurations in packages.yml." sidebar_position: 68 --- # How to Fix dbt Dependency Errors diff --git a/docs/how-tos/dbt/runtime-errors.md b/docs/how-tos/dbt/runtime-errors.md index 2a1bb48e..1ae4c5f8 100644 --- a/docs/how-tos/dbt/runtime-errors.md +++ b/docs/how-tos/dbt/runtime-errors.md @@ -1,5 +1,7 @@ --- -title: Runtime Errors +title: "Troubleshoot and Fix dbt Runtime Errors" +sidebar_label: "Runtime Errors" +description: "Diagnose and fix dbt runtime errors in Datacoves including model execution failures, test failures, missing variables, and Jinja rendering errors." sidebar_position: 69 --- # How to Fix dbt Runtime Errors diff --git a/docs/how-tos/git/README.md b/docs/how-tos/git/README.md index 13ddfaa3..3e3fb6f0 100644 --- a/docs/how-tos/git/README.md +++ b/docs/how-tos/git/README.md @@ -1,5 +1,7 @@ --- -title: Git +title: "How to Use Git in Datacoves: Tips and How-Tos" +sidebar_label: "Git" +description: "Git how-to guides for Datacoves developers: configure SSH keys, manage branches, and follow git best practices in the Datacoves environment." sidebar_position: 6 --- # How to use Git diff --git a/docs/how-tos/git/ssh-keys.md b/docs/how-tos/git/ssh-keys.md index 798c9754..0b6e4e29 100644 --- a/docs/how-tos/git/ssh-keys.md +++ b/docs/how-tos/git/ssh-keys.md @@ -1,5 +1,7 @@ --- -title: SSH Keys configuration +title: "Configure SSH Keys for Git Repos in Datacoves" +sidebar_label: "SSH Keys" +description: "Generate and configure SSH keys in Datacoves to clone git repositories, including adding your public key as a deployment key in GitHub or GitLab." sidebar_position: 71 --- # How to configure a SSH Key to clone a git repository diff --git a/docs/how-tos/my_airflow/README.mdx b/docs/how-tos/my_airflow/README.mdx index 34793eac..de6746b8 100644 --- a/docs/how-tos/my_airflow/README.mdx +++ b/docs/how-tos/my_airflow/README.mdx @@ -1,5 +1,7 @@ --- -title: My Airflow +title: "My Airflow: Personal DAG Testing in Datacoves" +sidebar_label: "My Airflow" +description: "My Airflow gives each developer a personal Airflow instance to test DAGs in Datacoves without pushing to a shared branch or affecting team pipelines." sidebar_position: 8 --- # My Airflow 101 diff --git a/docs/how-tos/my_airflow/migrating-service-connections.md b/docs/how-tos/my_airflow/migrating-service-connections.md index dc127f7b..2116d5dd 100644 --- a/docs/how-tos/my_airflow/migrating-service-connections.md +++ b/docs/how-tos/my_airflow/migrating-service-connections.md @@ -1,5 +1,7 @@ --- -title: Migrating from Environment Service Connections +title: "Migrate to Airflow-Level Service Connections" +sidebar_label: "Migrate Service Connections" +description: "How to migrate Datacoves service connections from environment-level delivery to Airflow-level connections for better secret management in My Airflow." sidebar_position: 75 --- # Migrating from Environment Service Connections to Airflow Service Connections diff --git a/docs/how-tos/my_airflow/my-import.md b/docs/how-tos/my_airflow/my-import.md index ed6eedc4..aae4947d 100644 --- a/docs/how-tos/my_airflow/my-import.md +++ b/docs/how-tos/my_airflow/my-import.md @@ -1,5 +1,7 @@ --- -title: My Import +title: "Import Variables and Connections into My Airflow" +sidebar_label: "My Import" +description: "Use the datacoves my import command to sync Airflow connections and variables from Team Airflow to your personal My Airflow instance in Datacoves." sidebar_position: 76 --- # Importing connections and variables from Team Airflow diff --git a/docs/how-tos/my_airflow/start-my-airflow.md b/docs/how-tos/my_airflow/start-my-airflow.md index 9b2a9578..eb1da1e4 100644 --- a/docs/how-tos/my_airflow/start-my-airflow.md +++ b/docs/how-tos/my_airflow/start-my-airflow.md @@ -1,5 +1,7 @@ --- -title: Use My Airflow +title: "How to Start and Use My Airflow in Datacoves" +sidebar_label: "Start My Airflow" +description: "How to start, stop, and use your personal My Airflow instance in Datacoves for rapid DAG development and testing before pushing to Team Airflow." sidebar_position: 77 --- # How to use My Airflow diff --git a/docs/how-tos/my_airflow/use-my-airflow-api.md b/docs/how-tos/my_airflow/use-my-airflow-api.md index 8b2c6ba1..58228aa0 100644 --- a/docs/how-tos/my_airflow/use-my-airflow-api.md +++ b/docs/how-tos/my_airflow/use-my-airflow-api.md @@ -1,5 +1,7 @@ --- -title: Access the My Airflow API +title: "Access and Use the My Airflow REST API" +sidebar_label: "My Airflow API" +description: "Generate API keys and make REST API calls to your personal My Airflow instance in Datacoves using the datacoves my api-key command." sidebar_position: 78 --- # How to use the My Airflow API diff --git a/docs/how-tos/snowflake/snowflake-key-based-auth.md b/docs/how-tos/snowflake/snowflake-key-based-auth.md index 09da2260..fe1b9c3e 100644 --- a/docs/how-tos/snowflake/snowflake-key-based-auth.md +++ b/docs/how-tos/snowflake/snowflake-key-based-auth.md @@ -1,5 +1,7 @@ --- -title: Setting up Snowflake Key-Based Auth +title: "Set Up Snowflake Key-Based Auth for CI Pipelines" +sidebar_label: "Key-Based Auth" +description: "Configure Snowflake key-pair authentication for CI/CD service accounts in Datacoves to securely authenticate dbt runs in GitHub Actions or GitLab CI." sidebar_position: 79 --- # How to set up Snowflake Key-Based Auth for CI Service Accounts diff --git a/docs/how-tos/snowflake/warehouses-schemas-roles.md b/docs/how-tos/snowflake/warehouses-schemas-roles.md index b198e5e2..9dbcde21 100644 --- a/docs/how-tos/snowflake/warehouses-schemas-roles.md +++ b/docs/how-tos/snowflake/warehouses-schemas-roles.md @@ -1,5 +1,7 @@ --- -title: Warehouses, Schemas and Roles +title: "Add Snowflake Warehouses, Schemas, and Roles" +sidebar_label: "Warehouses, Schemas & Roles" +description: "How to create and configure Snowflake warehouses, schemas, and roles for Datacoves environments, including sizing recommendations and access control setup." sidebar_position: 80 --- # How to add Warehouses, Schemas, and Roles to Snowflake diff --git a/docs/how-tos/superset/how_to_data_set.md b/docs/how-tos/superset/how_to_data_set.md index 0de1e01b..4fd68689 100644 --- a/docs/how-tos/superset/how_to_data_set.md +++ b/docs/how-tos/superset/how_to_data_set.md @@ -1,5 +1,7 @@ --- -title: Add a Dataset +title: "Add a Dataset to Apache Superset in Datacoves" +sidebar_label: "Add a Dataset" +description: "Connect a database table or view as a dataset in Apache Superset within Datacoves to make it available for charts, dashboards, and analysis." sidebar_position: 83 --- # How to Add a Dataset in Superset diff --git a/docs/how-tos/superset/how_to_database.md b/docs/how-tos/superset/how_to_database.md index 17e522ed..2fe66590 100644 --- a/docs/how-tos/superset/how_to_database.md +++ b/docs/how-tos/superset/how_to_database.md @@ -1,5 +1,7 @@ --- -title: Add a Database +title: "Add a Database Connection in Apache Superset" +sidebar_label: "Add a Database" +description: "How to add a Snowflake database connection in Apache Superset within Datacoves: select the connector type, enter credentials, and save the configuration." sidebar_position: 82 --- ## How to Add a Database Connection in Superset diff --git a/docs/how-tos/vs-code/bash-custom.md b/docs/how-tos/vs-code/bash-custom.md index 5b01bf67..6ee80cc6 100644 --- a/docs/how-tos/vs-code/bash-custom.md +++ b/docs/how-tos/vs-code/bash-custom.md @@ -1,5 +1,7 @@ --- -title: Customize Your Shell with .bash_custom +title: Customize Your Shell Environment in Datacoves +sidebar_label: Customize Shell +description: "Add aliases, environment variables, and custom functions to your VS Code shell in Datacoves using the .bash_custom file for persistent terminal customization." sidebar_position: 30 --- # How to Customize Your Shell Environment diff --git a/docs/how-tos/vs-code/csv-in-datacoves.md b/docs/how-tos/vs-code/csv-in-datacoves.md index 0f45a714..411437df 100644 --- a/docs/how-tos/vs-code/csv-in-datacoves.md +++ b/docs/how-tos/vs-code/csv-in-datacoves.md @@ -1,5 +1,7 @@ --- -title: CSVs +title: Work with CSV Files in the Datacoves VS Code IDE +sidebar_label: CSV Files +description: "How to upload, view, edit, and use CSV seed files in the Datacoves VS Code environment for dbt seeds and reference data management." sidebar_position: 10 --- # CSVs in VS Code diff --git a/docs/how-tos/vs-code/datacoves-copilot/README.md b/docs/how-tos/vs-code/datacoves-copilot/README.md index 663445a7..07fcf3f6 100644 --- a/docs/how-tos/vs-code/datacoves-copilot/README.md +++ b/docs/how-tos/vs-code/datacoves-copilot/README.md @@ -1,5 +1,7 @@ --- -title: Datacoves Copilot +title: "Datacoves Copilot: AI LLM Integration in VS Code" +sidebar_label: Datacoves Copilot +description: "Configure Datacoves Copilot to connect ChatGPT, Azure OpenAI, or other LLM providers to the VS Code IDE for AI-assisted dbt and Airflow development." sidebar_position: 40 --- # AI LLMs for Datacoves Copilot diff --git a/docs/how-tos/vs-code/datacoves-copilot/v1.md b/docs/how-tos/vs-code/datacoves-copilot/v1.md index edcefea0..6f6d8fe9 100644 --- a/docs/how-tos/vs-code/datacoves-copilot/v1.md +++ b/docs/how-tos/vs-code/datacoves-copilot/v1.md @@ -1,5 +1,7 @@ --- -title: V1 +title: Configure Datacoves Copilot v1 with ChatGPT +sidebar_label: v1 (ChatGPT) +description: "Set up and use Datacoves Copilot v1 with ChatGPT or Azure OpenAI: create a Datacoves secret, configure the LLM API key, and use preset prompts for dbt." sidebar_position: 2 --- diff --git a/docs/how-tos/vs-code/datacoves-copilot/v2.md b/docs/how-tos/vs-code/datacoves-copilot/v2.md index bca20789..91db3df0 100644 --- a/docs/how-tos/vs-code/datacoves-copilot/v2.md +++ b/docs/how-tos/vs-code/datacoves-copilot/v2.md @@ -1,5 +1,7 @@ --- -title: V2 +title: "Datacoves Copilot v2: Multi-LLM AI in VS Code" +sidebar_label: v2 (Multi-LLM) +description: "Configure Datacoves Copilot v2 (Datacoves v4+) with Anthropic, OpenAI, Azure OpenAI, DeepSeek, Google Gemini, Grok, and other LLM providers in VS Code." sidebar_position: 6 --- diff --git a/docs/how-tos/vs-code/environment-variables.md b/docs/how-tos/vs-code/environment-variables.md index 8c69e545..4a84e101 100644 --- a/docs/how-tos/vs-code/environment-variables.md +++ b/docs/how-tos/vs-code/environment-variables.md @@ -1,5 +1,7 @@ --- -title: Custom Environment Variables +title: Set Environment Variables in Datacoves VS Code +sidebar_label: Environment Variables +description: "How to add custom environment variables to the Datacoves VS Code IDE for use in dbt profiles, scripts, or custom tooling across your team's environments." sidebar_position: 20 --- # How to add Environment variables to VS Code diff --git a/docs/how-tos/vs-code/external-ai-tools/openai-codex.md b/docs/how-tos/vs-code/external-ai-tools/openai-codex.md index f8e4ac56..dde00c2a 100644 --- a/docs/how-tos/vs-code/external-ai-tools/openai-codex.md +++ b/docs/how-tos/vs-code/external-ai-tools/openai-codex.md @@ -1,5 +1,7 @@ --- -title: OpenAI Codex +title: Use OpenAI Codex in the Datacoves VS Code IDE +sidebar_label: OpenAI Codex +description: "Set up and use OpenAI Codex in the Datacoves VS Code environment to get AI-powered code suggestions and autocompletion for SQL and Python files." sidebar_position: 1 --- diff --git a/docs/how-tos/vs-code/initial.mdx b/docs/how-tos/vs-code/initial.mdx index f72f77d7..e7b8bf58 100644 --- a/docs/how-tos/vs-code/initial.mdx +++ b/docs/how-tos/vs-code/initial.mdx @@ -1,5 +1,7 @@ --- -title: Initial Configuration +title: Configure VS Code in the Datacoves Transform Tab +sidebar_label: Initial Setup +description: "Initial setup guide for VS Code in the Datacoves Transform tab: configure user settings, terminal profile, git credentials, and dbt environment." sidebar_position: 50 --- diff --git a/docs/how-tos/vs-code/override.md b/docs/how-tos/vs-code/override.md index 3085ea81..469c0768 100644 --- a/docs/how-tos/vs-code/override.md +++ b/docs/how-tos/vs-code/override.md @@ -1,5 +1,7 @@ --- -title: Override VS Code settings +title: Override Default VS Code Settings in Datacoves +sidebar_label: Override Settings +description: "How to override Datacoves VS Code default settings per workspace using a settings.json file in .vscode/ for custom extensions and editor preferences." sidebar_position: 60 --- # How to override default VS Code settings diff --git a/docs/how-tos/vs-code/reset-git.md b/docs/how-tos/vs-code/reset-git.md index 8729942f..42e7d5c9 100644 --- a/docs/how-tos/vs-code/reset-git.md +++ b/docs/how-tos/vs-code/reset-git.md @@ -1,5 +1,7 @@ --- -title: Reset Git +title: Reset Git in the Datacoves VS Code Environment +sidebar_label: Reset Git +description: "How to reset your git repository state in the Datacoves VS Code IDE when you encounter conflicts, detached HEAD, or corrupted workspace states." sidebar_position: 70 --- # Reset git diff --git a/docs/how-tos/vs-code/reset-user-env.md b/docs/how-tos/vs-code/reset-user-env.md index 432d5e67..50e19e38 100644 --- a/docs/how-tos/vs-code/reset-user-env.md +++ b/docs/how-tos/vs-code/reset-user-env.md @@ -1,5 +1,7 @@ --- -title: Reset User Env +title: Reset Your User Environment in Datacoves VS Code +sidebar_label: Reset User Env +description: "How to reset your personal VS Code user environment in Datacoves when the project's git repository changes or your workspace becomes inconsistent." sidebar_position: 80 --- # Reset the User's Env if the git Repository is Changed in the Project. diff --git a/docs/reference/admin-menu/README.md b/docs/reference/admin-menu/README.md index 527c9420..b104e6d7 100644 --- a/docs/reference/admin-menu/README.md +++ b/docs/reference/admin-menu/README.md @@ -1,5 +1,7 @@ --- -title: Administration Menu +title: Datacoves Administration Menu Reference +sidebar_label: Administration Menu +description: "Reference guide to the Datacoves Administration Menu, covering projects, environments, users, groups, service connections, secrets, and billing settings." sidebar_position: 1 --- # Admininstration Menu diff --git a/docs/reference/admin-menu/connection_templates.md b/docs/reference/admin-menu/connection_templates.md index 8fc4ec71..f39d5c83 100644 --- a/docs/reference/admin-menu/connection_templates.md +++ b/docs/reference/admin-menu/connection_templates.md @@ -1,5 +1,7 @@ --- -title: Connection Templates +title: "Connection Templates Reference: Datacoves Admin" +sidebar_label: Connection Templates +description: "Reference documentation for Datacoves connection templates: configure reusable data warehouse credential templates for use across projects and environments." sidebar_position: 20 --- # Connection Templates Admin diff --git a/docs/reference/admin-menu/environments.md b/docs/reference/admin-menu/environments.md index a6b6d0c0..613c2f81 100644 --- a/docs/reference/admin-menu/environments.md +++ b/docs/reference/admin-menu/environments.md @@ -1,5 +1,7 @@ --- -title: Environments +title: "Environments Reference: Datacoves Admin Panel" +sidebar_label: Environments +description: "Reference for the Datacoves Environments admin screen: configure VS Code, Airflow, Superset, integrations, and service connections per environment." sidebar_position: 30 --- # Environments Admin diff --git a/docs/reference/admin-menu/external_links.md b/docs/reference/admin-menu/external_links.md index 2883c914..4f8b50a2 100644 --- a/docs/reference/admin-menu/external_links.md +++ b/docs/reference/admin-menu/external_links.md @@ -1,5 +1,7 @@ --- -title: External Links +title: "External Links Reference: Datacoves Admin Panel" +sidebar_label: External Links +description: "Configure external links in the Datacoves admin panel to add custom URLs to the navigation menu for quick access to tools, dashboards, or documentation." sidebar_position: 40 --- # External Links diff --git a/docs/reference/admin-menu/groups.md b/docs/reference/admin-menu/groups.md index 9905c4a0..923430eb 100644 --- a/docs/reference/admin-menu/groups.md +++ b/docs/reference/admin-menu/groups.md @@ -1,5 +1,7 @@ --- -title: Groups +title: "Groups Reference: Datacoves Admin Panel" +sidebar_label: Groups +description: "Reference for the Datacoves Groups admin screen: create and configure role-based user groups with access to specific projects and environments." sidebar_position: 50 --- # Groups Admin diff --git a/docs/reference/admin-menu/integrations.md b/docs/reference/admin-menu/integrations.md index 89af457c..adc594c5 100644 --- a/docs/reference/admin-menu/integrations.md +++ b/docs/reference/admin-menu/integrations.md @@ -1,5 +1,7 @@ --- -title: Integrations +title: "Integrations Reference: Datacoves Admin Panel" +sidebar_label: Integrations +description: "Reference for the Datacoves Integrations admin screen: configure notification services like Slack and Microsoft Teams for Airflow pipeline alerts." sidebar_position: 60 --- # Integrations Admin diff --git a/docs/reference/admin-menu/invitations.md b/docs/reference/admin-menu/invitations.md index 42211166..f10b88ae 100644 --- a/docs/reference/admin-menu/invitations.md +++ b/docs/reference/admin-menu/invitations.md @@ -1,5 +1,7 @@ --- -title: Invitations +title: "Invitations Reference: Datacoves Admin Panel" +sidebar_label: Invitations +description: "Reference for the Datacoves Invitations admin screen: view pending invitations, resend invitation emails, and manage user access requests." sidebar_position: 60 --- # Invitations Admin diff --git a/docs/reference/admin-menu/projects.md b/docs/reference/admin-menu/projects.md index 461702ec..6b2a1f8e 100644 --- a/docs/reference/admin-menu/projects.md +++ b/docs/reference/admin-menu/projects.md @@ -1,5 +1,7 @@ --- -title: Projects +title: "Projects Reference: Datacoves Admin Panel" +sidebar_label: Projects +description: "Reference for the Datacoves Projects admin screen: manage git repository settings, CI/CD integration, and secrets backend per project." sidebar_position: 70 --- # Projects Admin diff --git a/docs/reference/admin-menu/secrets.md b/docs/reference/admin-menu/secrets.md index 3b9140be..928c9382 100644 --- a/docs/reference/admin-menu/secrets.md +++ b/docs/reference/admin-menu/secrets.md @@ -1,5 +1,7 @@ --- -title: Secrets +title: "Secrets Reference: Datacoves Admin Panel" +sidebar_label: Secrets +description: "Reference for the Datacoves Secrets admin screen: create and manage encrypted secrets for injecting credentials into developer environments." sidebar_position: 80 --- # Secrets Admin diff --git a/docs/reference/admin-menu/service_connections.md b/docs/reference/admin-menu/service_connections.md index b722b174..e2d2b7b3 100644 --- a/docs/reference/admin-menu/service_connections.md +++ b/docs/reference/admin-menu/service_connections.md @@ -1,5 +1,7 @@ --- -title: Service Connections +title: "Service Connections Reference: Datacoves Admin" +sidebar_label: Service Connections +description: "Reference for the Datacoves Service Connections admin screen: configure warehouse credential delivery to Airflow and VS Code environments." sidebar_position: 90 --- # Service Connections Admin diff --git a/docs/reference/admin-menu/settings_billing.md b/docs/reference/admin-menu/settings_billing.md index 9de0bb02..d7aec37c 100644 --- a/docs/reference/admin-menu/settings_billing.md +++ b/docs/reference/admin-menu/settings_billing.md @@ -1,5 +1,7 @@ --- -title: Account Settings & Billing +title: "Account Settings & Billing Reference: Datacoves" +sidebar_label: Account Settings & Billing +description: "Reference for Datacoves account settings and billing: view subscription details, manage API keys, access the Billing API URL, and monitor usage." sidebar_position: 10 --- # Account Settings & Billing diff --git a/docs/reference/admin-menu/users.md b/docs/reference/admin-menu/users.md index e526452c..e25828e7 100644 --- a/docs/reference/admin-menu/users.md +++ b/docs/reference/admin-menu/users.md @@ -1,5 +1,7 @@ --- -title: Users +title: "Users Reference: Datacoves Admin Panel" +sidebar_label: Users +description: "Reference for the Datacoves Users admin screen: view all platform users, modify roles and permissions, deactivate or delete user accounts." sidebar_position: 100 --- # Users Admin diff --git a/docs/reference/airflow/airflow-best-practices.md b/docs/reference/airflow/airflow-best-practices.md index e89a2783..b5a8d090 100644 --- a/docs/reference/airflow/airflow-best-practices.md +++ b/docs/reference/airflow/airflow-best-practices.md @@ -1,5 +1,7 @@ --- -title: Airflow Best Practices +title: Airflow DAG Best Practices for Datacoves Users +sidebar_label: Best Practices +description: "Recommended Airflow best practices for Datacoves: set static start dates, use catchup=False, avoid dynamic scheduled dates, and follow official Airflow docs." sidebar_position: 121 --- # Airflow Best Practices diff --git a/docs/reference/airflow/airflow-billing.md b/docs/reference/airflow/airflow-billing.md index ba214cea..e0d3d281 100644 --- a/docs/reference/airflow/airflow-billing.md +++ b/docs/reference/airflow/airflow-billing.md @@ -1,5 +1,7 @@ --- -title: Airflow Billing +title: Airflow Billing and Worker Usage in Datacoves +sidebar_label: Billing +description: "Understand how Datacoves bills Airflow usage based on Kubernetes worker pod running time, what is and isn't billed, and how to query task instance tables." --- # How Datacoves Billing Works diff --git a/docs/reference/airflow/airflow-config-defaults.md b/docs/reference/airflow/airflow-config-defaults.md index 8b49f32c..52a43d55 100644 --- a/docs/reference/airflow/airflow-config-defaults.md +++ b/docs/reference/airflow/airflow-config-defaults.md @@ -1,5 +1,7 @@ --- -title: Airflow Config Defaults +title: Airflow Default Configuration in Datacoves +sidebar_label: Config Defaults +description: "Reference for Datacoves Airflow default configuration: executor, parallelism, scheduler, Kubernetes worker timeout, and database retry settings." sidebar_position: 122 --- # Airflow Config Defaults diff --git a/docs/reference/airflow/airflow-variables.md b/docs/reference/airflow/airflow-variables.md index 76bf7770..ed246299 100644 --- a/docs/reference/airflow/airflow-variables.md +++ b/docs/reference/airflow/airflow-variables.md @@ -1,5 +1,7 @@ --- -title: Airflow Variables +title: Datacoves Airflow Environment Variables +sidebar_label: Variables +description: "Reference for Datacoves-injected Airflow variables: DAG paths, dbt settings, environment slugs, version info, and notification configuration." sidebar_position: 123 --- Datacoves injects several environment variables into Apache Airflow to streamline workflow configurations. Below is a list of important variables you may encounter: diff --git a/docs/reference/airflow/dag-generators.md b/docs/reference/airflow/dag-generators.md index 6de48151..37d0e659 100644 --- a/docs/reference/airflow/dag-generators.md +++ b/docs/reference/airflow/dag-generators.md @@ -1,5 +1,7 @@ --- -title: DAG Generators +title: "DAG Generators Reference: Airbyte and Fivetran" +sidebar_label: DAG Generators +description: "Reference for dbt-coves DAG generators in Datacoves: AirbyteGenerator, AirbyteDbtGenerator, FivetranGenerator, and FivetranDbtGenerator with all params." sidebar_position: 124 --- # DAG Generators diff --git a/docs/reference/airflow/datacoves-commands.md b/docs/reference/airflow/datacoves-commands.md index 641c118f..6aabd68b 100644 --- a/docs/reference/airflow/datacoves-commands.md +++ b/docs/reference/airflow/datacoves-commands.md @@ -1,5 +1,7 @@ --- -title: Datacoves CLI Commands +title: "Datacoves CLI Commands Reference: datacoves my" +sidebar_label: CLI Commands +description: "Reference for Datacoves CLI commands: datacoves my import, my pytest, and my api-key for managing My Airflow instances from the VS Code terminal." sidebar_position: 126 --- # Datacoves CLI Commands diff --git a/docs/reference/airflow/datacoves-decorators.md b/docs/reference/airflow/datacoves-decorators.md index 424cc6c2..a78da92b 100644 --- a/docs/reference/airflow/datacoves-decorators.md +++ b/docs/reference/airflow/datacoves-decorators.md @@ -1,5 +1,7 @@ --- -title: Datacoves Airflow Decorators +title: Datacoves Airflow Decorators Reference +sidebar_label: Decorators +description: "Reference for Datacoves Airflow decorators: @task.datacoves_bash and @task.datacoves_dbt — parameters, usage examples, and service connection integration." sidebar_position: 125 --- # Datacoves Airflow Decorators diff --git a/docs/reference/airflow/datacoves-operator.md b/docs/reference/airflow/datacoves-operator.md index 8afe0685..c6128357 100644 --- a/docs/reference/airflow/datacoves-operator.md +++ b/docs/reference/airflow/datacoves-operator.md @@ -1,5 +1,7 @@ --- -title: Datacoves Operators +title: Datacoves Airflow Operators and Generators +sidebar_label: Operators +description: "Reference for Datacoves Airflow operators: DatacovesBashOperator and DatacovesDbtOperator, their parameters, behavior, and usage examples in DAG files." sidebar_position: 128 --- # Datacoves Operators & Generators diff --git a/docs/reference/airflow/environment-service-connection-vars.md b/docs/reference/airflow/environment-service-connection-vars.md index cb94bad9..29000504 100644 --- a/docs/reference/airflow/environment-service-connection-vars.md +++ b/docs/reference/airflow/environment-service-connection-vars.md @@ -1,5 +1,7 @@ --- -title: Datacoves Environment Service Connection Variables +title: Datacoves Service Connection Variables Reference +sidebar_label: Service Connection Vars +description: "Environment variables injected by Datacoves service connections for Snowflake, Redshift, BigQuery, and Databricks warehouse authentication in Airflow." sidebar_position: 127 --- # Warehouse Environment Variables diff --git a/docs/reference/datacoves/rollback-strategy.md b/docs/reference/datacoves/rollback-strategy.md index 881372a9..12ea09a2 100644 --- a/docs/reference/datacoves/rollback-strategy.md +++ b/docs/reference/datacoves/rollback-strategy.md @@ -1,6 +1,7 @@ --- -title: Rollback Strategy +title: Datacoves Platform Rollback Strategy Reference sidebar_label: Rollback Strategy +description: "How Datacoves handles rollbacks across infrastructure, platform services, and customer image layers, including hotfix processes and rollback limitations." sidebar_position: 132 --- diff --git a/docs/reference/datacoves/versioning.md b/docs/reference/datacoves/versioning.md index 32aef3da..5c88ebc9 100644 --- a/docs/reference/datacoves/versioning.md +++ b/docs/reference/datacoves/versioning.md @@ -1,5 +1,7 @@ --- -title: Versioning +title: "Datacoves Versioning: Semantic Version Reference" +sidebar_label: Versioning +description: "How Datacoves uses semantic versioning (MAJOR.MINOR.PATCH) for Docker images and platform releases, including version bump criteria and image tag formats." sidebar_position: 130 --- # Datacoves versioning diff --git a/docs/reference/datacoves/vpc-deployment.md b/docs/reference/datacoves/vpc-deployment.md index 966f4e5a..08e61597 100644 --- a/docs/reference/datacoves/vpc-deployment.md +++ b/docs/reference/datacoves/vpc-deployment.md @@ -1,5 +1,7 @@ --- -title: VPC Deployment +title: Datacoves VPC Deployment Architecture Reference +sidebar_label: VPC Deployment +description: "Infrastructure requirements for deploying Datacoves on a private VPC: database, blob storage, Kubernetes, git server, CI/CD, DNS, and HTTPS certificates." sidebar_position: 131 --- # VPC Deployment diff --git a/docs/reference/security/README.md b/docs/reference/security/README.md index 94123140..938eb3c3 100644 --- a/docs/reference/security/README.md +++ b/docs/reference/security/README.md @@ -1,5 +1,7 @@ --- -title: Security +title: Datacoves Security Features and Compliance Info +sidebar_label: Security +description: "Datacoves security overview: SSO via Google or Microsoft, role-based access control, HTTPS enforcement, AES-128 encryption at rest, and cloud protocols." sidebar_position: 134 --- # Datacoves Security diff --git a/docs/reference/vscode/README.md b/docs/reference/vscode/README.md index b342fdea..d9b72e4c 100644 --- a/docs/reference/vscode/README.md +++ b/docs/reference/vscode/README.md @@ -1,5 +1,7 @@ --- -title: VS Code +title: VS Code Reference for Datacoves Environments +sidebar_label: VS Code +description: "Reference documentation for VS Code in the Datacoves Transform tab, including environment variables, settings overrides, and extension configurations." sidebar_position: 150 --- -# Datacoves reference - vscode \ No newline at end of file +# Datacoves reference - vscode diff --git a/docs/reference/vscode/datacoves-env-vars.md b/docs/reference/vscode/datacoves-env-vars.md index c29ed905..52ad6519 100644 --- a/docs/reference/vscode/datacoves-env-vars.md +++ b/docs/reference/vscode/datacoves-env-vars.md @@ -1,5 +1,7 @@ --- -title: Datacoves Environment Variables +title: Datacoves VS Code Environment Variables +sidebar_label: Environment Variables +description: "Reference for all Datacoves-injected environment variables in VS Code: workspace paths, dbt settings, version info, and warehouse connection details." sidebar_position: 137 --- # Datacoves Environment Variables diff --git a/docs/tutorials/educational-data-resources.mdx b/docs/tutorials/educational-data-resources.mdx index 6616c12f..6bdac7ea 100644 --- a/docs/tutorials/educational-data-resources.mdx +++ b/docs/tutorials/educational-data-resources.mdx @@ -1,5 +1,7 @@ --- title: Educational Data Resources +sidebar_label: Educational Data Resources +description: "A curated collection of free datasets and educational resources for learning and practicing data engineering and analytics skills." --- diff --git a/docs/tutorials/learning-resources.mdx b/docs/tutorials/learning-resources.mdx index 9d2a22fc..4187d8e7 100644 --- a/docs/tutorials/learning-resources.mdx +++ b/docs/tutorials/learning-resources.mdx @@ -1,5 +1,7 @@ --- -title: Learning Resources +title: Datacoves Learning Resources for Data Engineers +sidebar_label: Learning Resources +description: "Curated guides, videos, and documentation to help you get started with dbt, Airflow, and data engineering in the Datacoves platform." --- diff --git a/docusaurus.config.js b/docusaurus.config.js index 57e271ff..356c7e53 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -12,7 +12,7 @@ import {themes as prismThemes} from 'prism-react-renderer'; /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'Welcome to the Datacoves Documentation', + title: 'Datacoves', tagline: 'Our Mission is to be the best dbt platform for enterprises by offering a simple solution with robust orchestration that reduces time to market while handling the complexities of a large enterprise.', favicon: 'img/favicon.ico', diff --git a/src/pages/contact-us.md b/src/pages/contact-us.md index 936715ae..22a07f7e 100644 --- a/src/pages/contact-us.md +++ b/src/pages/contact-us.md @@ -1,5 +1,6 @@ --- -title: Contact Us +title: Contact Datacoves Support via Slack or Email +description: "Reach the Datacoves support team via Slack, email, or our Service Desk portal. Enterprise customers get priority response through a dedicated Slack channel." --- # Contact Us diff --git a/src/pages/index.js b/src/pages/index.js index 00fd3091..59e27176 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -14,7 +14,7 @@ function HomepageHeader() {
- {siteConfig.title} + Welcome to the Datacoves Documentation

{siteConfig.tagline}

@@ -33,8 +33,8 @@ export default function Home() { const {siteConfig} = useDocusaurusContext(); return ( + title="Datacoves Docs: dbt, Airflow & Data Engineering" + description="Official documentation for Datacoves — the enterprise dbt platform with Airflow orchestration, VS Code, and Superset. Get started in minutes.">
diff --git a/src/pages/sla.md b/src/pages/sla.md index a3420797..dd63eee0 100644 --- a/src/pages/sla.md +++ b/src/pages/sla.md @@ -1,3 +1,8 @@ +--- +title: Datacoves Service Level Agreement (SLA) +description: "Datacoves SLA: 99.9% uptime commitment, support severity levels with defined response times, credit schedule for outages, and availability exceptions." +--- + # Service Level Agreement (SLA) This document outlines Datacoves' responsibility with regards to outages and other issues with the Datacoves platform.