mkdocs.yml

site_name: M3 Documentation

theme:
  # Provide source
  name: null
  custom_dir: docs/theme

  # 404 page
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Do not use tabs for navigation
  feature:
    tabs: false

  # Default values, taken from mkdocs_theme.yml
  language: en
  palette:
    primary: indigo
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/favicon.png
  logo:
    icon: "\uE80C"

edit_uri: edit/master/docs/

repo_name: m3db/m3
repo_url: https://github.com/m3db/m3

markdown_extensions:
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

pages:
  - "Introduction": "index.md"
  - "Overview":
    - "Components": "overview/components.md"
    - "Motivation": "overview/motivation.md"
    - "Media":      "overview/media.md"
  - "M3DB":
    - "Introduction": "m3db/index.md"
    - "Architecture":
      - "Overview": "m3db/architecture/index.md"
      - "Storage Engine": "m3db/architecture/engine.md"
      - "Sharding and Replication": "m3db/architecture/sharding.md"
      - "Consistency Levels": "m3db/architecture/consistencylevels.md"
      - "Storage": "m3db/architecture/storage.md"
      - "Commit Logs": "m3db/architecture/commitlogs.md"
      - "Peer Streaming": "m3db/architecture/peer_streaming.md"
      - "Caching": "m3db/architecture/caching.md"
  - "Coordinator":
    - "Introduction": "coordinator/index.md"
    - "API":
      - "Prometheus Remote Write/Read": "coordinator/api/remote.md"
  - "Query Engine":
    - "Introduction": "query_engine/index.md"
    - "API":
      - "Query": "query_engine/api/index.md"
    - "Architecture":
      - "Overview": "query_engine/architecture/index.md"
      - "Blocks": "query_engine/architecture/blocks.md"
      - "Query Fanout": "query_engine/architecture/fanout.md"
      - "Function Processing": "query_engine/architecture/functions.md"
    - "Configuration":
      - "Annotated Config File": "query_engine/config/annotated_config.md"
  - "How-To's":
    - "M3DB Single Node Deployment": "how_to/single_node.md"
    - "M3DB Cluster Deployment, Manually": "how_to/cluster_hard_way.md"
    - "M3DB on Kubernetes": "how_to/kubernetes.md"
    - "M3Query": "how_to/query.md"
    - "Use M3DB as a general purpose time series database": "how_to/use_as_tsdb.md"
  - "Operational Guides":
    - "Overview": "operational_guide/index.md"
    - "Replication and Deployment in Zones": "operational_guide/replication_and_deployment_in_zones.md"
    - "Replication Between Clusters": "operational_guide/replication_between_clusters.md"
    - "Repairs": "operational_guide/repairs.md"
    - "Tuning Availability, Consistency, and Durability": "operational_guide/availability_consistency_durability.md"
    - "Placement/Topology": "operational_guide/placement.md"
    - "Placement/Topology Configuration": "operational_guide/placement_configuration.md"
    - "Namespace Configuration": "operational_guide/namespace_configuration.md"
    - "Bootstrapping & Crash Recovery": "operational_guide/bootstrapping_crash_recovery.md"
    - "Docker & Kernel Configuration": "operational_guide/kernel_configuration.md"
    - "etcd": "operational_guide/etcd.md"
    - "Monitoring": "operational_guide/monitoring.md"
    - "Configuring Mapping & Rollup Rules": "operational_guide/mapping_rollup.md"
    - "Upgrading M3": "operational_guide/upgrading_m3.md"
  - "Integrations":
    - "Prometheus": "integrations/prometheus.md"
    - "Graphite": "integrations/graphite.md"
    - "Grafana": "integrations/grafana.md"
  - "Performance":
    - "Introduction": "performance/index.md"
    - "M3DB":
      - "M3DB Performance": "performance/m3db/index.md"
    - "m3query":
      - "m3query Performance":  "performance/m3query/index.md"
  - "Troubleshooting": "troubleshooting/index.md"
  - "FAQs": "faqs/index.md"
  - "Glossary": "glossary/index.md"
  - "Tips For Writing Documentation": "misc/writing_docs.md"