mkdocs.yml

site_name: Perses
site_url: "https://perses.dev"
site_description: "An open specification for dashboards. The open dashboard tool for Prometheus and other data sources."
repo_name: "perses/perses"
repo_url: "https://github.com/perses/perses"
theme:
  name: material
  logo: assets/images/favicon.png
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: black
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

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

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: black
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.tabs
    - content.code.copy
    - search.suggest
    - search.highlight
markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.blocks.caption
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: "#"
  - admonition
extra_css:
  - 'css/style.css'
# extra_javascript:
#   - 'js/main.js'

copyright: |
  The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href='https://www.linuxfoundation.org/trademark-usage/'>Trademark Usage</a>

extra:
  # used to remove the text "made with material for mkdocs: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice"
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/perses
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/PersesDev
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/persesdev
    - icon: fontawesome/brands/slack
      link: https://cloud-native.slack.com/messages/C07KQR95WBE
    - icon: fontawesome/solid/square-rss
      link: /feed_rss_created.xml
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/persesdev/perses

# Multi repo support
plugins:
  - search
  - blog
  - macros:
      render_by_default: false
      force_render_paths: index.md
  - multirepo:
      # (optional) tells multirepo to cleanup the temporary directory after site is built.
      cleanup: true
      # If set, the docs directory will not be removed when importing docs.
      # When using this with a nav section in an imported repo you must keep the
      # docs directory in the path (e.g., docs/path/to/file.md).
      keep_docs_dir: true
      nav_repos:
        - name: perses
          import_url: https://github.com/perses/perses?branch=main
          # forward slash is needed in '/README.md' so that only the README.md in the root
          # directory is imported and not all README.md files.
          imports: [docs/*]
        - name: "plugins"
          import_url: https://github.com/perses/plugins?branch=main
          imports: [docs/*]
        - name: "helm-charts"
          import_url: https://github.com/perses/helm-charts?branch=main
          imports: [docs/*]
        - name: "perses-operator"
          import_url: https://github.com/perses/perses-operator?branch=main
          imports: [docs/user-guide.md, docs/api.md]
  - tags
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags
nav:
  - Home: index.md
  - Blog:
      - blog/index.md
  - Docs:
      - Overview: perses/docs/overview.md
      - Concepts:
          - Open Specification: perses/docs/concepts/open-specification.md
          - Dashboard: perses/docs/concepts/dashboard.md
          - Plugin: perses/docs/concepts/plugin.md
          - Dashboard-as-Code: perses/docs/concepts/dashboard-as-code.md
          - Datasource: perses/docs/concepts/datasource.md
          - Variable: perses/docs/concepts/variable.md
          - Project: perses/docs/concepts/project.md
          - Datasource & Variable scopes: perses/docs/concepts/datasource-and-variable-scopes.md
          - Authentication: perses/docs/concepts/authentication.md
          - Authorization: perses/docs/concepts/authorization.md
          - Proxy: perses/docs/concepts/proxy.md
          - Ephemeral Dashboard: perses/docs/concepts/ephemeral-dashboard.md
      - User Docs:
          - Installation:
              - Installing Perses from Source: perses/docs/installation/from-source.md
              - Installing Perses with package managers: perses/docs/installation/third-party.md
              - Installing Perses in a Container: perses/docs/installation/in-a-container.md
              - Installing Perses with Helm: helm-charts/docs/installation.md
          - Configuration:
              - General: perses/docs/configuration/configuration.md
              - OAuth Helper: perses/docs/configuration/oauth-configuration-helpers.md
              - Provisioning: perses/docs/configuration/provisioning.md
              - Custom Lint Rules: perses/docs/configuration/custom-lint-rules.md
              - Datasource Discovery: perses/docs/configuration/datasource-discovery.md
              - Loading Plugin: perses/docs/configuration/load-plugin.md
          - Dashboard-as-Code:
              - Getting started: perses/docs/dac/getting-started.md
              - CUE:
                  - CUE SDK for Dashboard-as-Code: perses/docs/dac/cue/README.md
                  - Dashboard: perses/docs/dac/cue/dashboard.md
                  - Panel Groups: perses/docs/dac/cue/panelgroups.md
                  - Variable:
                      - Variable Group: perses/docs/dac/cue/variable/group.md
                      - List Variable: perses/docs/dac/cue/variable/list.md
                      - Text Variable: perses/docs/dac/cue/variable/text.md
                  - Plugins:
                      - Data sources:
                          - Prometheus:
                              - Filter: plugins/docs/prometheus/cue-sdk/filter.md
                              - Panel: plugins/docs/prometheus/cue-sdk/panel.md
                              - Label Names Variable: plugins/docs/prometheus/cue-sdk/variable/label-names.md
                              - Label Values Variable: plugins/docs/prometheus/cue-sdk/variable/label-values.md
                              - PromQL Variable: plugins/docs/prometheus/cue-sdk/variable/promql.md
                      - Variables:
                          - Datasource Variable: plugins/docs/datasourcevariable/cue-sdk.md
                          - Static List Variable: plugins/docs/staticlistvariable/cue-sdk.md
              - Go:
                  - Go SDK for Dashboard-as-Code: perses/docs/dac/go/README.md
                  - Dashboard: perses/docs/dac/go/dashboard.md
                  - Datasource: perses/docs/dac/go/datasource.md
                  - Panel: perses/docs/dac/go/panel.md
                  - Panel Group: perses/docs/dac/go/panel-group.md
                  - Query: perses/docs/dac/go/query.md
                  - Variable: perses/docs/dac/go/variable.md
                  - Variable Group: perses/docs/dac/go/variable-group.md
                  - Helpers:
                      - HTTP Proxy: perses/docs/dac/go/helper/http-proxy.md
                  - Plugins:
                      - Data sources:
                          - ClickHouse:
                              - Datasource: plugins/docs/clickhouse/go-sdk/datasource.md
                              - Log Query: plugins/docs/clickhouse/go-sdk/log-query.md
                              - Time Series Query: plugins/docs/clickhouse/go-sdk/timeseries-query.md
                          - Loki:
                              - Datasource: plugins/docs/loki/go-sdk/datasource.md
                              - Log Query: plugins/docs/loki/go-sdk/log-query.md
                              - Time Series Query: plugins/docs/loki/go-sdk/timeseries-query.md
                          - Prometheus:
                              - Datasource: plugins/docs/prometheus/go-sdk/datasource.md
                              - Query: plugins/docs/prometheus/go-sdk/query.md
                              - Label Names Variable: plugins/docs/prometheus/go-sdk/variable/label-names.md
                              - Label Values Variable: plugins/docs/prometheus/go-sdk/variable/label-values.md
                              - PromQL Variable: plugins/docs/prometheus/go-sdk/variable/promql.md
                          - Pyroscope:
                              - Datasource: plugins/docs/pyroscope/go-sdk/datasource.md
                              - Query: plugins/docs/pyroscope/go-sdk/query.md
                          - Tempo:
                              - Datasource: plugins/docs/tempo/go-sdk/datasource.md
                              - Query: plugins/docs/tempo/go-sdk/query.md
                          - VictoriaLogs:
                              - Datasource: plugins/docs/victorialogs/go-sdk/datasource.md
                              - Field Names Variable: plugins/docs/victorialogs/go-sdk/variable/field-names.md
                              - Field Values Variable: plugins/docs/victorialogs/go-sdk/variable/field-values.md
                              - Log Query: plugins/docs/victorialogs/go-sdk/log-query.md
                              - Time Series Query: plugins/docs/victorialogs/go-sdk/timeseries-query.md
                      - Panels:
                          - Bar Chart: plugins/docs/barchart/go-sdk.md
                          - Flame Chart: plugins/docs/flamechart/go-sdk.md
                          - Gauge Chart: plugins/docs/gaugechart/go-sdk.md
                          - HeatMap Chart: plugins/docs/heatmapchart/go-sdk.md
                          - Histogram Chart: plugins/docs/histogramchart/go-sdk.md
                          - Logs Table: plugins/docs/logstable/go-sdk.md
                          - Markdown: plugins/docs/markdown/go-sdk.md
                          - Pie Chart: plugins/docs/piechart/go-sdk.md
                          - Scatter Chart: plugins/docs/scatterchart/go-sdk.md
                          - Stat Chart: plugins/docs/statchart/go-sdk.md
                          - Status History Chart: plugins/docs/statushistorychart/go-sdk.md
                          - Table: plugins/docs/table/go-sdk.md
                          - Time Series Chart: plugins/docs/timeserieschart/go-sdk.md
                          - Time Series Table: plugins/docs/timeseriestable/go-sdk.md
                          - Trace Table: plugins/docs/tracetable/go-sdk.md
                          - Tracing Gantt Chart: plugins/docs/tracingganttchart/go-sdk.md
                      - Variables:
                          - Datasource Variable: plugins/docs/datasourcevariable/go-sdk.md
                          - Static List Variable: plugins/docs/staticlistvariable/go-sdk.md
          - Helm Charts:
              - Overview: helm-charts/docs/overview.md
              - Managing Resources:
                  - Using ConfigMaps: helm-charts/docs/managing-resources-with-configmaps.md
                  - Using OCI Artifacts: helm-charts/docs/packaging-resources-as-oci-artifacts.md
                  - Authentication Secrets: helm-charts/docs/auth-secrets.md
              - Upgrade Guide: helm-charts/docs/upgrade-guide.md
          - Perses Operator:
              - User Guide: perses-operator/docs/user-guide.md
              - API Reference: perses-operator/docs/api.md
          - Perses CLI (percli): perses/docs/cli.md
          - Plugins:
              - Bar Chart: plugins/docs/barchart/README.md
              - ClickHouse: plugins/docs/clickhouse/README.md
              - Datasource Variable: plugins/docs/datasourcevariable/README.md
              - Flame Chart: plugins/docs/flamechart/README.md
              - Gauge Chart: plugins/docs/gaugechart/README.md
              - HeatMap Chart: plugins/docs/heatmapchart/README.md
              - Histogram Chart: plugins/docs/histogramchart/README.md
              - Logs Table: plugins/docs/logstable/README.md
              - Loki: plugins/docs/loki/README.md
              - Markdown: plugins/docs/markdown/README.md
              - Pie Chart: plugins/docs/piechart/README.md
              - Prometheus: plugins/docs/prometheus/README.md
              - Pyroscope: plugins/docs/pyroscope/README.md
              - Scatter Chart: plugins/docs/scatterchart/README.md
              - Stat Chart: plugins/docs/statchart/README.md
              - Static List Variable: plugins/docs/staticlistvariable/README.md
              - Status History Chart: plugins/docs/statushistorychart/README.md
              - Table: plugins/docs/table/README.md
              - Tempo: plugins/docs/tempo/README.md
              - Time Series Chart: plugins/docs/timeserieschart/README.md
              - Time Series Table: plugins/docs/timeseriestable/README.md
              - Trace Table: plugins/docs/tracetable/README.md
              - Tracing Gantt Chart: plugins/docs/tracingganttchart/README.md
              - VictoriaLogs: plugins/docs/victorialogs/README.md
          - Upgrade Guide: perses/docs/upgrade-guide.md
          - Migrate from Grafana: perses/docs/migration.md
          - Troubleshooting:
              - TLS and HTTP Datasource: perses/docs/troubleshooting-tls-plain-http-datasource.md
      - Developer Docs:
          - API:
              - Introduction: perses/docs/api/README.md
              - Dashboard: perses/docs/api/dashboard.md
              - Datasource: perses/docs/api/datasource.md
              - Ephemeral Dashboard: perses/docs/api/ephemeral-dashboard.md
              - Project: perses/docs/api/project.md
              - Role: perses/docs/api/role.md
              - Role Binding: perses/docs/api/rolebinding.md
              - Secret: perses/docs/api/secret.md
              - User: perses/docs/api/user.md
              - Variable: perses/docs/api/variable.md
              - Migrate: perses/docs/api/migrate.md
              - Plugins: perses/docs/api/plugins.md
              - Validate: perses/docs/api/validate.md
          - Embedding Perses Panels: perses/docs/embedding-panels.md
          - Plugins:
              - Models:
                  - Data sources:
                      - ClickHouse: plugins/docs/clickhouse/model.md
                      - Loki: plugins/docs/loki/model.md
                      - Prometheus: plugins/docs/prometheus/model.md
                      - Pyroscope: plugins/docs/pyroscope/model.md
                      - Tempo: plugins/docs/tempo/model.md
                      - VictoriaLogs: plugins/docs/victorialogs/model.md
                  - Panels:
                      - Bar Chart: plugins/docs/barchart/model.md
                      - Flame Chart: plugins/docs/flamechart/model.md
                      - Gauge Chart: plugins/docs/gaugechart/model.md
                      - HeatMap Chart: plugins/docs/heatmapchart/model.md
                      - Histogram: plugins/docs/histogramchart/model.md
                      - Logs Table: plugins/docs/logstable/model.md
                      - Markdown: plugins/docs/markdown/model.md
                      - Pie Chart: plugins/docs/piechart/model.md
                      - Scatter Chart: plugins/docs/scatterchart/model.md
                      - Stat Chart: plugins/docs/statchart/model.md
                      - Status History Chart: plugins/docs/statushistorychart/model.md
                      - Table: plugins/docs/table/model.md
                      - Time Series Chart: plugins/docs/timeserieschart/model.md
                      - Time Series Table: plugins/docs/timeseriestable/model.md
                      - Trace Table: plugins/docs/tracetable/model.md
                      - Tracing Gantt Chart: plugins/docs/tracingganttchart/model.md
                  - Variables:
                      - Datasource Variable: plugins/docs/datasourcevariable/model.md
                      - Static List Variable: plugins/docs/staticlistvariable/model.md
                  - Common definitions: perses/docs/plugins/common.md
              - CUE in Perses: perses/docs/plugins/cue.md
              - Create a plugin: perses/docs/plugins/creation.md
      - Materials: perses/docs/materials.md
      - Adopters: adopters.md
  - Demo: https://demo.perses.dev
  - Contact: perses/docs/contact.md