Configuration docs

[arbiv]

null

Summary by CodeRabbit

• Documentation

  • Major documentation overhaul introducing new and updated guides, best practices, onboarding, integration instructions, and feature explanations for both Elementary Cloud and OSS.
  • Added comprehensive user guides for AI agents, anomaly detection, incident management, governance, data tests, performance monitoring, and integrations (e.g., Jira, Linear, Microsoft Teams, Bitbucket, Azure DevOps).
  • Expanded onboarding, quickstart, and best practices resources for new users and teams.
  • Introduced new documentation structure and navigation, including a new homepage, changelog, and detailed feature pages.
  • Updated and clarified instructions for connecting to various platforms (cloud data warehouses, BI tools, code repositories).
  • Added and improved troubleshooting guides, configuration references, and code examples.
  • Enhanced visual content with new images, videos, and illustrative examples throughout the docs.
  • Deprecated or removed outdated documentation and consolidated redundant pages.

• New Features

  • Introduced documentation for new AI-powered features, including AI data validations, test recommendation, governance, and triage agents.
  • Added guides for new integrations, such as Atlan, Okta, AWS PrivateLink, and expanded BI and incident management tool support.
  • Documented advanced platform capabilities like user activity logs, RBAC, and configuration-as-code.

• Refactor

  • Restructured and reorganized documentation navigation, grouping, and linking for improved usability and discoverability.

• Style

  • Improved formatting, consistency, and clarity across all documentation pages.

• Chores

  • Added and updated configuration files for documentation site theming, navigation, analytics, and search.
  • Removed deprecated configuration and documentation files.

This release delivers a significantly improved documentation experience, making it easier for users to onboard, configure, and leverage both Elementary OSS and Cloud Platform features.

[github-actions]

👋 @arbiv
Thank you for raising your pull request.
Please make sure to add tests and document all user-facing changes.
You can do this by editing the docs files in this pull request.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update is a major documentation overhaul for the Elementary platform, introducing a new, comprehensive documentation structure, navigation, and theming. It adds extensive new content covering Elementary Cloud and OSS features, AI agents, anomaly detection, data governance, integrations, best practices, and more. Numerous new guides, feature pages, and configuration instructions are included, while outdated or redundant documentation files are removed or replaced with modular snippets. The update also introduces new React components and configuration files for site navigation and layout.

Changes

Cohort / File(s)	Change Summary
Documentation Site Structure & Navigation docs/docs.json, docs/home.mdx, docs/mint.json (deleted)	Introduced a new documentation configuration (docs.json) with updated navigation, theming, and analytics. Added a new homepage with custom React components. Removed the old configuration file.
Cloud Platform Features & Architecture docs/cloud/introduction.mdx, docs/cloud/what-is-elementary.mdx, docs/cloud/cloud-vs-oss.mdx, docs/cloud/features.mdx, docs/cloud/resources/business-case-data-observability-platform.mdx, docs/cloud/resources/how-does-elementary-work, docs/cloud/general/security-and-privacy.mdx	Added and expanded introductory, feature, and architecture pages for the Elementary Cloud Platform, including business case and security overview. Updated or replaced existing content for clarity and completeness.
AI Agents & AI-Driven Features docs/cloud/ai-agents/overview.mdx, docs/cloud/ai-agents/catalog-agent.mdx, docs/cloud/ai-agents/governance-agent.mdx, docs/cloud/ai-agents/performance-cost-agent.mdx, docs/cloud/ai-agents/test-recommendation-agent.mdx, docs/cloud/ai-agents/triage-resolution-agent.mdx, docs/cloud/resources/ai-agents.mdx, docs/cloud/ai-agents/ai-privacy-policy-short.mdx, docs/cloud/general/ai-privacy-policy.mdx, docs/data-tests/ai-data-tests/*	Added detailed documentation for multiple AI agents, their privacy policy, and AI-powered data validation tests. Includes setup guides for supported platforms (Snowflake, Databricks, BigQuery, Redshift, Data Lakes), usage examples, and configuration instructions.
Best Practices & Guides docs/cloud/best-practices/introduction.mdx, docs/cloud/best-practices/governance-for-observability.mdx, docs/cloud/best-practices/detection-and-coverage.mdx, docs/cloud/best-practices/triage-and-response.mdx	Added comprehensive best practice guides for governance, detection, coverage, and incident triage/response, including checklists and YAML configuration examples.
Anomaly Detection & Data Testing docs/cloud/features/anomaly-detection/*, docs/data-tests/anomaly-detection-configuration/*, docs/data-tests/anomaly-detection-tests/*, docs/data-tests/anomaly-detection-tests-oss-vs-cloud.mdx, docs/data-tests/how-anomaly-detection-works.mdx, docs/data-tests/introduction.mdx, docs/data-tests/ai-data-tests/unstructured_data_validations.mdx, docs/data-tests/ai-data-tests/ai_data_validations.mdx, docs/data-tests/ai-data-tests/supported-platforms/*, docs/data-tests/dbt/dbt-artifacts.mdx, docs/data-tests/dbt/dbt-package.mdx, docs/data-tests/dbt/package-models.mdx, docs/data-tests/dbt/quickstart-package.mdx, docs/data-tests/quickstart-package.mdx, docs/data-tests/add-elementary-tests.mdx	Added and updated documentation on anomaly detection monitors, test configuration, troubleshooting, and comparison between OSS and Cloud anomaly detection. Introduced modular snippet inclusions for test configuration.
Alerts, Incidents, and Collaboration docs/cloud/features/alerts-and-incidents/*, docs/cloud/features/collaboration-and-communication/*, docs/cloud/features/config-as-code.mdx, docs/cloud/features/data-governance/*, docs/cloud/features/data-lineage/*, docs/cloud/features/performance-monitoring/*, docs/cloud/features/data-tests/*, docs/cloud/features/multi-env.mdx, docs/cloud/features/ci.mdx	Added or expanded documentation for alerting, incident management, data catalog, data health dashboards, governance, lineage, performance monitoring, and test coverage. Introduced modular cards and visuals for navigation.
Integrations (Cloud & OSS) docs/cloud/integrations/*, docs/oss/integrations/*, docs/_snippets/cloud/integrations/*	Added or updated integration guides for data warehouses, BI tools, code repositories, messaging/alerting platforms, and security/authentication providers (e.g., AWS PrivateLink, Okta, Microsoft Entra). Enhanced with step-by-step setup instructions, screenshots, and configuration details.
OSS Documentation & Quickstart docs/oss/oss-introduction.mdx, docs/oss/cli-commands.mdx, docs/oss/guides/*, docs/oss/general/troubleshooting.mdx, docs/oss/deployment-and-configuration/*, docs/oss/integrations/clickhouse.mdx, docs/_snippets/oss/*	Rewrote and expanded OSS introduction, CLI guides, troubleshooting, deployment, and integration documentation. Modularized content and improved clarity.
Changelog & Culture docs/changelog.mdx, docs/culture.mdx	Added a new changelog page with detailed feature release history and a new culture page outlining team principles and code of conduct.
Documentation Snippets & Modularization docs/_snippets/*	Added or updated numerous modular snippet files for use across documentation, improving maintainability and consistency. Includes cards, configuration examples, onboarding steps, and feature highlights.
Removed/Replaced Legacy Documentation docs/features/*, docs/guides/modules-overview/dbt-package.mdx, docs/oss/oss-introduction-opening.mdx, docs/_snippets/oss/oss-introduction.mdx	Deleted outdated or redundant documentation pages, replacing them with new, modular, or expanded content as appropriate.
Pre-commit & Dockerfile .pre-commit-config.yaml, docs/Dockerfile	Added a new pre-commit hook for Mintlify validation and updated the base Docker image from node:19 to node:20.3.0, removing a redundant install command.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs Site
    participant AI Agent Docs
    participant Cloud Platform Docs
    participant OSS Docs
    participant Integrations Docs

    User->>Docs Site: Navigates to documentation
    Docs Site->>Cloud Platform Docs: Loads cloud feature guides, best practices, architecture
    Docs Site->>OSS Docs: Loads OSS quickstart, CLI, troubleshooting
    Docs Site->>AI Agent Docs: Loads AI agent overviews, privacy, usage
    Docs Site->>Integrations Docs: Loads integration setup guides
    Docs Site-->>User: Renders modular, themed, navigable documentation

Loading

Estimated code review effort

🎯 5 (Critical) | ⏱️ ~90+ minutes

Complexity: The update is extensive, affecting nearly all documentation areas, introducing new navigation, modularization, React components, and many new/rewritten guides. Review requires checking for accuracy, completeness, and consistency across a large volume of interconnected files.

Poem

🐇✨
In burrows deep, I found my pen,
To write the docs anew again.
With guides and cards, and AI’s might,
Features shine both day and night.
From cloud to CLI, the warren’s wide—
Hop in, dear friends, and take a ride!
🥕📚

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch configuration-docs

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.