mkdocs.yml

site_name: ControlPlane Enterprise for Flux CD
site_description: |
  ControlPlane offers a hardened, enterprise-grade distribution and
  support services for the CNCF-graduated Flux project.
site_author: ControlPLane
site_url: https://fluxcd.control-plane.io
repo_name: distribution
repo_url: https://github.com/controlplaneio-fluxcd/distribution
edit_uri: ""
copyright: Copyright © 2025 ControlPlane Ltd.

home:
  image: images/logo/enterprise-for-flux-cd-icon-white.svg
  tagline: Assured Flux CD
  description: |
    ControlPlane Enterprise enhances the security and stability of
    Kubernetes GitOps delivery through comprehensive security assurance
    and compliance with required regulatory standards for Flux CD.
    The enterprise distribution extends Flux with self-service features
    and AI-assisted GitOps capabilities.
  features: true

theme:
  name: material
  logo: images/logo/enterprise-for-flux-cd-icon-white.png
  favicon: images/logo/enterprise-for-flux-cd-icon-colour.png
  language: en
  custom_dir: docs/theme/
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.sections
    - navigation.top
    - navigation.tabs

extra:
  social:
    - icon: fontawesome/brands/square-x-twitter
      link: https://x.com/controlplaneio
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/controlplane/mycompany/

docs_dir: docs

plugins:
  - search
  - social
  - redirects:
      redirect_maps:
        # Flux Operator redirects
        'operator/index.md': 'https://fluxoperator.dev/'
        'operator/install.md': 'https://fluxoperator.dev/docs/guides/install/'
        'operator/flux-config.md': 'https://fluxoperator.dev/docs/instance/controllers/'
        'operator/flux-sync.md': 'https://fluxoperator.dev/docs/instance/sync/'
        'operator/flux-kustomize.md': 'https://fluxoperator.dev/docs/instance/customization/'
        'operator/flux-sharding.md': 'https://fluxoperator.dev/docs/instance/sharding/'
        'operator/monitoring.md': 'https://fluxoperator.dev/docs/instance/monitoring/'
        'operator/flux-bootstrap-migration.md': 'https://fluxoperator.dev/docs/guides/migration/'
        'operator/fluxinstance.md': 'https://fluxoperator.dev/docs/crd/fluxinstance/'
        'operator/fluxreport.md': 'https://fluxoperator.dev/docs/crd/fluxreport/'
        'operator/resourceset.md': 'https://fluxoperator.dev/docs/crd/resourceset/'
        'operator/resourcesetinputprovider.md': 'https://fluxoperator.dev/docs/crd/resourcesetinputprovider/'
        'operator/cli.md': 'https://fluxoperator.dev/docs/guides/cli/'
        'operator/resourcesets/introduction.md': 'https://fluxoperator.dev/docs/resourcesets/introduction/'
        'operator/resourcesets/app-definition.md': 'https://fluxoperator.dev/docs/resourcesets/app-definition/'
        'operator/resourcesets/time-based-delivery.md': 'https://fluxoperator.dev/docs/resourcesets/time-based-delivery/'
        'operator/resourcesets/image-automation.md': 'https://fluxoperator.dev/docs/resourcesets/image-automation/'
        'operator/resourcesets/github-pull-requests.md': 'https://fluxoperator.dev/docs/resourcesets/github-pull-requests/'
        'operator/resourcesets/gitlab-merge-requests.md': 'https://fluxoperator.dev/docs/resourcesets/gitlab-merge-requests/'
        # Flux MCP Server redirects
        'mcp/index.md': 'https://fluxoperator.dev/mcp-server/'
        'mcp/install.md': 'https://fluxoperator.dev/docs/mcp/install/'
        'mcp/config.md': 'https://fluxoperator.dev/docs/mcp/config/'
        'mcp/prompt-engineering.md': 'https://fluxoperator.dev/docs/mcp/prompting/'
        'mcp/instructions.md': 'https://fluxoperator.dev/docs/mcp/instructions/'
        'mcp/config-api.md': 'https://fluxoperator.dev/docs/mcp/config/'
        'mcp/tools.md': 'https://fluxoperator.dev/docs/mcp/tools/'
        'mcp/prompts.md': 'https://fluxoperator.dev/docs/mcp/prompts/'

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - meta
  - codehilite
  - footnotes
  - pymdownx.tilde
  - pymdownx.progressbar
  - pymdownx.tasklist
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Flux Distribution:
    - Introduction: distribution/index.md
    - Installation: distribution/install.md
    - Upgrade: distribution/upgrade.md
    - Security: distribution/security.md
    - Guides:
        - Flux Architecture Overview: guides/flux-architecture.md
        - D1 Reference Architecture: guides/d1-architecture-reference.md
        - D2 Reference Architecture: guides/d2-architecture-reference.md
        - Flux Multitenant Policies: guides/flux-policies.md
        - Generic Helm Chart Pattern: guides/flux-generic-helm-chart.md
        - Flux CLI Quick Reference: guides/flux-cli-quick-reference.md
    - Marketplaces:
        - AWS Marketplace: marketplace/aws.md
    - Versions:
        - Release v2.8: releases/release-v2.8.md
        - Release v2.7: releases/release-v2.7.md
        - Release v2.6: releases/release-v2.6.md
        - Release v2.5: releases/release-v2.5.md
        - Release v2.4: releases/release-v2.4.md
        - Release v2.3: releases/release-v2.3.md
        - Release v2.2: releases/release-v2.2.md
  - Flux Operator: https://fluxoperator.dev/
  - Flux MCP Server: https://fluxoperator.dev/mcp-server/
  - Pricing: pricing/index.md
  - Contact: https://control-plane.io/contact/?inquiry=fluxcd