mkdocs.yml

# Project information
site_name: CruiseKube
site_url: https://cruisekube.com
site_author: TrueFoundry
site_description: >-
  CruiseKube is an intelligent Kubernetes resource optimization controller that automatically monitors, analyzes, and applies resource recommendations to improve cluster efficiency and reduce costs.


extra_css:
  - assets/stylesheets/extra.css


# Repository
repo_name: truefoundry/CruiseKube
repo_url: https://github.com/truefoundry/CruiseKube

# Copyright
copyright: Copyright © 2026 TrueFoundry

theme:
  variant: modern
  name: material
  logo: assets/images/logo/cruiseKube_logo.svg
  favicon: assets/images/logo/favicon/favicon.ico
  custom_dir: docs/overrides
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    tag:
      default: lucide/hash
    previous: fontawesome/solid/angle-left
    next: fontawesome/solid/angle-right
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  features:
    - announce.dismiss
    # - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: lucide/moon-star
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: lucide/sun
        name: Switch to light mode


# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - zensical.extensions.preview:
      targets:
        include:
          - index.md
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:zensical.extensions.emoji.to_svg
      emoji_index: !!python/name:zensical.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: truefoundry
      repo: cruisekube
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - blog

extra:
  # homepage: https://cruisekube.com
  scope: /
  annotate:
    json: [.s2]
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Dqek4xJa3N
    - icon: fontawesome/brands/github
      link: https://github.com/truefoundry
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/truefoundry
  analytics:
    provider: google
    property: G-M8EDCBCCHY
  structured_data:
    organization:
      "@context": "https://schema.org"
      "@type": "Organization"
      name: "TrueFoundry"
      url: "https://truefoundry.com"
      logo: "https://cruisekube.com/assets/images/logo/variants/cruisekube-stacked-color.svg"
      sameAs:
        - "https://github.com/truefoundry"
        - "https://discord.gg/Dqek4xJa3N"
    software:
      "@context": "https://schema.org"
      "@type": "SoftwareApplication"
      name: "CruiseKube"
      applicationCategory: "DeveloperApplication"
      operatingSystem: "Kubernetes"
      description: "CruiseKube is an intelligent Kubernetes resource optimization controller that automatically monitors, analyzes, and applies resource recommendations to improve cluster efficiency and reduce costs."
      url: "https://cruisekube.com"
      downloadUrl: "https://github.com/truefoundry/CruiseKube"
      author:
        "@type": "Organization"
        name: "TrueFoundry"
        url: "https://truefoundry.com"
      license: "https://github.com/truefoundry/cruiseKube/blob/main/LICENSE"
      programmingLanguage: "Go"
      keywords: 
        - "Kubernetes"
        - "Resource Optimization"
        - "Operator"
        - "Cloud Native"
    website:
      "@context": "https://schema.org"
      "@type": "WebSite"
      name: "CruiseKube Documentation"
      url: "https://cruisekube.com"
      description: "Official documentation for CruiseKube - Kubernetes resource optimization controller"
      publisher:
        "@type": "Organization"
        name: "TrueFoundry"
        url: "https://truefoundry.com"
      potentialAction:
        "@type": "SearchAction"
        target: "https://cruisekube.com/search/?q={search_term_string}"
        "query-input": "required name=search_term_string"
    breadcrumb:
      "@context": "https://schema.org"
      "@type": "BreadcrumbList"
      itemListElement:
        - "@type": "ListItem"
          position: 1
          name: "Home"
          item: "https://cruisekube.com"
    documentation:
      "@context": "https://schema.org"
      "@type": "TechArticle"
      headline: "CruiseKube Documentation"
      description: "Comprehensive documentation for CruiseKube - Kubernetes resource optimization controller"
      author:
        "@type": "Organization"
        name: "TrueFoundry"
        url: "https://truefoundry.com"
      publisher:
        "@type": "Organization"
        name: "TrueFoundry"
        url: "https://truefoundry.com"
        logo:
          "@type": "ImageObject"
          url: "https://cruisekube.com/assets/images/logo/variants/cruisekube-stacked-color.svg"
      mainEntityOfPage:
        "@type": "WebPage"
        "@id": "https://cruisekube.com"
      datePublished: "2024-01-01"
      dateModified: "2025-01-01"
      articleSection: "Documentation"
      keywords:
        - "Kubernetes documentation"
        - "Resource Optimization"

# Page tree
nav:
  - Home: index.md
  - About: 
      - Introduction: about/overview.md
      - Use Cases: about/overview-use-cases.md
      - CruiseKube vs VPA: about/comp-vs-vpa.md
      - Adopters: about/adopters.md
      - FAQ: about/overview-faq.md
  - Install:
      - Installation: install/gs-installation.md
      - Basic Usage: install/basic-usage.md
      - Pre-Requisites: install/gs-prerequisites.md
  - Documentation:
      - Concepts:
        - Architecture: documentation/concepts/arch-introduction.md
        - Algorithm: documentation/concepts/arch-algorithm.md
        - TradeOffs: documentation/concepts/arch-tradeoffs.md
      - Operate:
        - Dashboard: documentation/operate/config-dashboard.md
        - Preflight / Health Check: documentation/operate/preflight.md
        - Login & authentication: documentation/operate/authentication.md
        - Policies & Modes: documentation/operate/operate-policies.md
        - Resource Pricing: documentation/operate/operate-resource-pricing.md
        - Troubleshooting: documentation/operate/operate-troubleshooting.md
      - Contribute:
        - Dev Environment: documentation/contribute/dev-env.md
        - Release Process: documentation/contribute/dev-release.md
        - Security: documentation/contribute/dev-security.md
        - Contributors: documentation/contribute/dev-contributors.md
      - Reference: 
        - Helm Chart: documentation/reference/reference-helm-chart.md
        - Configuration: documentation/reference/config.md
  - Blog:
      - CruiseKube Announcement: blog/posts/cruisekube_announcement.md