mkdocs.yml

site_name: Pelorus Docs
site_url: https://pelorus.readthedocs.io/en/latest/
site_description: Metrics that matter
repo_name: dora-metrics/pelorus
repo_url: https://github.com/dora-metrics/pelorus
theme:
  name: material
  logo: img/icon-white.png
  favicon: img/favicon.png
  font:
    text: Red Hat Text
    code: Red Hat Monospace
  palette:

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: pelorus
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - content.tooltips
  custom_dir: docs/custom
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - tables
nav:
  - Home: index.md
  - Docs:
    - Overview: GettingStarted/Overview.md
    - Installation: GettingStarted/Installation.md
    - Quickstart Tutorial: GettingStarted/QuickstartTutorial.md
    - Configuration:
      - Pelorus Core: GettingStarted/configuration/PelorusCore.md
      - Pelorus Exporters:
        - Overview: GettingStarted/configuration/PelorusExporters.md
        - Deploy Time: GettingStarted/configuration/ExporterDeploytime.md
        - Commit Time: GettingStarted/configuration/ExporterCommittime.md
        - Failure Time: GettingStarted/configuration/ExporterFailure.md
        - Webhook: GettingStarted/configuration/ExporterWebhook.md
      - Production best practices: GettingStarted/configuration/ProductionBestPractice.md
      - NooBaa for Long Term Storage: GettingStarted/configuration/Noobaa.md
    - Examples: GettingStarted/Examples.md
  - Our Philosophy:
    - Overview: philosophy/Overview.md
    - The Problem Today: philosophy/TheProblemToday.md
    - Finding the Right Bridge Outcomes: philosophy/BridgeOutcomes.md
    - Outcomes:
      - Overview: philosophy/outcomes/Overview.md
      - Software Delivery Performance: philosophy/outcomes/SoftwareDeliveryPerformance.md
      - Developer Adoption: philosophy/outcomes/developer_adoption.md
    - How Pelorus Can Help: philosophy/HowPelorusCanHelp.md
  - Architecture: Architecture.md
  - Contribution:
    - Dev Guide: Development.md
    - Development Choices: DevelopmentChoices.md
    - Upstream Support: UpstreamSupport.md
plugins:
  - social
  - redirects:
      redirect_maps:
           # Used by the Pelorus Operator v0.0.1
           'Configuration.md': 'GettingStarted/configuration/PelorusCore.md'
           'Install.md': 'GettingStarted/configuration/ProductionBestPractice.md'
           'Demo.md': 'GettingStarted/QuickstartTutorial.md'