mkdocs.yml

site_name: kobs
site_description: Kubernetes Observability Platform
repo_name: kobsio/kobs
repo_url: https://github.com/kobsio/kobs
edit_uri: https://github.com/kobsio/kobs/edit/main/docs/
copyright: Copyright © 2021 Rico Berger

theme:
  name: material
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/favicon.png
  logo: assets/images/logo.png
  include_search_page: false
  search_index_only: true
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.tabs

nav:
  - Home: index.md
  - Getting Started:
      - Installation:
          - Helm: installation/helm.md
          - Kustomize: installation/kustomize.md
          - Demo: installation/demo.md
      - Configuration:
          - Getting Started: configuration/getting-started.md
          - Clusters: configuration/clusters.md
          - Plugins: configuration/plugins.md
          - Authentication: configuration/authentication.md
  - Resources:
      - Resources: resources/resources.md
      - Applications: resources/applications.md
      - Teams: resources/teams.md
      - Users: resources/users.md
      - Dashboards: resources/dashboards.md
  - Plugins:
      - Getting Started: plugins/getting-started.md
      - Applications: plugins/applications.md
      - Azure: plugins/azure.md
      - Dashboards: plugins/dashboards.md
      - Elasticsearch: plugins/elasticsearch.md
      - Flux: plugins/flux.md
      - Grafana: plugins/grafana.md
      - Harbor: plugins/harbor.md
      - Helm: plugins/helm.md
      - Istio: plugins/istio.md
      - Jaeger: plugins/jaeger.md
      - Kiali: plugins/kiali.md
      - klogs: plugins/klogs.md
      - Markdown: plugins/markdown.md
      - Opsgenie: plugins/opsgenie.md
      - Prometheus: plugins/prometheus.md
      - Resources: plugins/resources.md
      - RSS: plugins/rss.md
      - SonarQube: plugins/sonarqube.md
      - SQL: plugins/sql.md
      - Teams: plugins/teams.md
      - TechDocs: plugins/techdocs.md
      - Users: plugins/users.md
  - Community Plugins:
      - Getting Started: community-plugins/getting-started.md
  - Contributing:
      - Getting Started: contributing/getting-started.md
      - Develop a Plugin: contributing/develop-a-plugin.md
      - Development using the Demo: contributing/development-using-the-demo.md
      - Using the kobsio/app: contributing/using-the-kobsio-app.md
      - Release: contributing/release.md
  - Architecture Decision Records (ADR):
      - ADR001 - Facilitate Centralized Instance: adr/001_facilitate_centralized_instance.md

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  social:
    - icon: material/web
      link: https://kobs.io
    - icon: fontawesome/brands/github
      link: https://github.com/kobsio/kobs
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/kobsio/kobs
  version:
    provider: mike

extra_css:
  - assets/stylesheets/extra.css