mkdocs.yml.in

site_name: Tremor Documentation
site_author: The Tremor Team
repo_url: https://github.com/tremor-rs/tremor-www-docs
repo_name: tremor-rs/tremor-www-docs
edit_uri: edit/main/docs
docs_dir: docs
site_dir: html
pages:
#  - Home: index.md
#  - Configuration: Configuration.md
theme:
  name: material
  logo: img/logo.png
  palette:
    primary: 'black'
    accent: 'indigo'
extra:
  repo_icon: github
markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: true
nav:
  - Home: index.md
  - 'Architecture Overview': overview.md
  - Tremor Query:
    - Overview: tremor-query/index.md
    - Operators: tremor-query/operators.md
    - Modules: tremor-query/modules.md
    - Lexical Preprocessor: tremor-query/pp.md
    - Walkthrough: tremor-query/walkthrough.md
    - Aggregate Function Reference:
      - Overview: tremor-query/functions.md
      - stats: tremor-query/functions/stats.md
      - win: tremor-query/functions/win.md
    - Recipes: tremor-query/recipes.md
  - Tremor Script:
    - Overview: tremor-script/index.md
    - Modules: tremor-script/modules.md
    - Lexical Preprocessor: tremor-script/pp.md
    - Function Reference:
      - Overview: tremor-script/functions.md
      - STDLIB
    - Extractor Reference:
      -  Overview: tremor-script/extractors.md
      -  Base64: tremor-script/extractors/base64.md
      -  CIDR: tremor-script/extractors/cidr.md
      -  Datetime: tremor-script/extractors/datetime.md
      -  Dissect: tremor-script/extractors/dissect.md
      -  Glob: tremor-script/extractors/glob.md
      -  Grok: tremor-script/extractors/grok.md
      -  Influx: tremor-script/extractors/influx.md
      -  JSON: tremor-script/extractors/json.md
      -  KV: tremor-script/extractors/kv.md
      -  Regex: tremor-script/extractors/regex.md
    - Recipes: tremor-script/recipes.md
  - Operations:
    - Configuration: operations/configuration.md
    - Monitoring: operations/monitoring.md
    - Tremor Tool: operations/cli.md
    - Configuration Walkthrough: operations/configuration-walkthrough.md
    - 'Circuit Breakers and Guaranteed Delivery': operations/gdcb.md
    - 'Linked Transports': operations/linked-transports.md
  - Artefacts:
    - Preprocessors: artefacts/preprocessors.md
    - Postprocessors: artefacts/postprocessors.md
    - Codecs: artefacts/codecs.md
    - Onramps: artefacts/onramps.md
    - Offramps: artefacts/offramps.md
  - API: api.md
  - History: history.md
  - Glossary: Glossary.md
  - Workshops:
    - Overview: workshop/README.md
    - Basic examples:
      - Passthrough: workshop/examples/00_passthrough/README.md
      - Filter: workshop/examples/01_filter/README.md
      - Transform: workshop/examples/02_transform/README.md
      - Validate: workshop/examples/03_validate/README.md
    - Integrations:
      - Logstash: workshop/examples/10_logstash/README.md
      - Influx: workshop/examples/11_influx/README.md
      - Timescale: workshop/examples/12_postgres_timescaledb/README.md
      - Grafana : workshop/examples/13_grafana/README.md
      - Syslog : workshop/examples/14_syslog_udp/README.md
      - DNS : workshop/examples/15_syslog_udp_dns/README.md
    - Delivery Guarantees:
      - Transient GD: workshop/examples/20_transient_gd/README.md
      - Persistent GD: workshop/examples/21_persistent_gd/README.md
      - Round Robin: workshop/examples/22_roundrobin/README.md
      - Kafka: workshop/examples/23_kafka_gd/README.md
    - Linked Ramps:
      - HTTP Server: workshop/examples/30_servers_lt_http/README.md
      - Websocket Server: workshop/examples/31_servers_lt_ws/README.md
      - HTTP Proxy: workshop/examples/32_proxies_lt_http/README.md
      - Websocket Proxy: workshop/examples/33_proxies_lt_ws/README.md
      - HTTP -> WS Bridge: workshop/examples/34_bridges_lt_http_ws/README.md
      - HTTP Load Balancing: workshop/examples/35_reverse_proxy_load_balancing/README.md
      - Quota Service: workshop/examples/36_quota_service/README.md
      - Configurator: workshop/examples/37_configurator/README.md
      - Polling and Alerting: workshop/examples/38_polling_alerts/README.md
      - Event Correlation from Kafka to Elasticsearch: workshop/examples/39_kafka_elastic_correlation/README.md
    - CNCF:
      - OpenTelemetry Passthrough: workshop/examples/40_otel_passthrough/README.md
      - Zipkin Interworking: workshop/examples/41_otel_zipkin/README.md
      - Jaeger Interworking: workshop/examples/42_otel_jaeger/README.md
      - Prometheus Interworking: workshop/examples/43_otel_prometheus/README.md
      - Elastic APM Interworking: workshop/examples/44_otel_elastic_apm/README.md
  - Development:
    - Quick Start Guide: development/quick-start.md
    - Local MkDocs Testing: internal/LocalMkdocsSetup.md
    - Setting up MkDocs on Manjaro: internal/RunDocumentationManjaro.md
    - Match to Functional: internal/transform.md
    - Profiling: development/profiling.md
    - 'Debugging with LLDB': development/debugging.md
    - Benchmarking:
      - Overview: development/benchmarking.md
      - Logstash: development/benchmarks/LogstashBenchmark.md
    - Testing: development/testing.md
    - Investigation: development/issue-investigation.md
  - Governance:
    - 'Code of Conduct': CodeOfConduct.md
    - 'Contributing': Contributing.md
    - 'Core Infrastructure Initiative': CII.md
    - 'Security': policies/security.md