mkdocs.yml

site_name: Harvest
repo_url: https://github.com/NetApp/harvest
repo_name: NetApp/harvest
copyright: Copyright © NetApp
edit_uri: ""

nav:
  - What is Harvest?: 'index.md'
  - Concepts: 'concepts.md'
  - Quickstart: 'quickstart.md'
  - Installation:
      - 'Overview': 'install/overview.md'
      - 'Package Managers': 'install/package-managers.md'
      - 'Containers':
          - 'Docker': 'install/containers.md'
          - 'K8': 'install/k8.md'
          - 'Podman': 'install/podman.md'
          - 'Containerd': 'install/containerd.md'
      - 'Native': 'install/native.md'
  - System Requirements: 'system-requirements.md'
  - Prepare Monitored Clusters:
      - 'ONTAP cDOT': 'prepare-cdot-clusters.md'
      - 'Amazon FSx for ONTAP': 'prepare-fsx-clusters.md'
      - 'ONTAP 7mode': 'prepare-7mode-clusters.md'
      - 'StorageGRID': 'prepare-storagegrid-clusters.md'
  - Configure Harvest (basic): 'configure-harvest-basic.md'
  - Configure Exporters:
      - 'Prometheus': 'prometheus-exporter.md'
      - 'InfluxDB': 'influxdb-exporter.md'
  - Configure Grafana: 'configure-grafana.md'
  - Configure Collectors:
      - 'ZAPI': 'configure-zapi.md'
      - 'REST': 'configure-rest.md'
      - 'KeyPerf': 'configure-keyperf.md'
      - 'EMS': 'configure-ems.md'
      - 'StorageGRID': 'configure-storagegrid.md'
      - 'Unix': 'configure-unix.md'
  - Templates: 'configure-templates.md'
  - Dashboards: 'dashboards.md'
  - Manage Harvest Pollers: 'manage-harvest.md'
  - Configure Harvest (advanced): 'configure-harvest-advanced.md'
  - Monitor Harvest: 'monitor-harvest.md'
  - Help:
      - 'Troubleshooting': 'help/troubleshooting.md'
      - 'FAQ': 'help/faq.md'
      - 'Log Collection': 'help/log-collection.md'
      - 'Config Collection': 'help/config-collection.md'
  - Reference:
      - 'EMS Alert Runbook': 'resources/ems-alert-runbook.md'
      - 'Matrix': 'resources/matrix.md'
      - 'ONTAP Metrics': 'ontap-metrics.md'
      - 'Power Algorithm': 'resources/power-algorithm.md'
      - 'Plugins': 'plugins.md'
      - 'REST Perf Metrics': 'resources/rest-perf-metrics.md'
      - 'REST Strategy': 'architecture/rest-strategy.md'
      - 'Templates And Metrics': 'resources/templates-and-metrics.md'
      - 'ZAPI and REST gaps': 'resources/zapi-and-rest-gap.md'
  - About:
      - 'License': 'license.md'
      - 'Release Notes': 'release-notes.md'

theme:
  logo: assets/harvest.svg
  favicon: assets/harvest.svg
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/discord
      link: https://github.com/NetApp/harvest/blob/main/SUPPORT.md#getting-help
    - icon: fontawesome/brands/github
      link: https://github.com/NetApp/harvest/discussions

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra_css:
  - assets/extra.css