mkdocs.yml

site_name: Datadog Agent
site_description: The home of Datadog Agent developer documentation
site_author: Datadog
site_url: https://datadoghq.dev/datadog-agent/
repo_name: datadog/datadog-agent
repo_url: https://github.com/DataDog/datadog-agent
edit_uri: blob/main/doc
copyright: Copyright © Datadog, Inc. 2024-present

docs_dir: doc
site_dir: site
theme:
  name: material
  custom_dir: doc/.overrides
  variant: classic
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/favicon.ico
  logo: assets/images/logo.svg
  icon:
    repo: fontawesome/brands/github-alt
  palette:
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: custom
    toggle:
      icon: material/weather-night
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: custom
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  features:
  - content.action.edit
  - content.code.copy
  - content.tabs.link
  - content.tooltips
  - navigation.expand
  - navigation.footer
  - navigation.indexes
  - navigation.instant
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky

nav:
- Home:
  - About: index.md
  - Setup:
    - Required: setup/required.md
    - Optional: setup/optional.md
    - Manual: setup/manual.md
- How-to:
  - Build:
    - Standalone agents: how-to/build/standalone.md
    - Distribution packages: how-to/build/distributions.md
  - Test:
    - Unit tests: how-to/test/unit.md
    - Static analysis: how-to/test/static-analysis.md
    - End-to-end tests:
      - how-to/test/e2e/index.md
      - Running tests: how-to/test/e2e/running.md
      - Writing tests: how-to/test/e2e/writing.md
      - Test dependencies: how-to/test/e2e/dependencies.md
      - Custom AMIs: how-to/test/e2e/custom-amis.md
    - Manual QA: 
      - how-to/test/manual-qa/index.md
      - AWS: 
        - VM: how-to/test/manual-qa/aws-vm.md 
        - Docker: how-to/test/manual-qa/aws-docker.md
        - EKS: how-to/test/manual-qa/aws-eks.md
        - ECS: how-to/test/manual-qa/aws-ecs.md
        - Kind: how-to/test/manual-qa/aws-kind.md
      - Azure: 
        - VM: how-to/test/manual-qa/azure-vm.md
      - GCP: 
        - VM: how-to/test/manual-qa/gcp-vm.md
      
  - Go:
    - Add nested modules: how-to/go/modules.md
  - Component framework:
    - Use components in binaries: how-to/components/using-components.md
    - Create bundles: how-to/components/creating-bundles.md
    - Use optional dependencies: how-to/components/optional-dependencies.md
    - Add flare data: how-to/components/flares.md
    - Add a status provider: how-to/components/status.md
  - Agent schema:
    - Add and document settings: how-to/agent-schema/settings.md
    - Validate and generate output: how-to/agent-schema/workflows.md
  - Checks:
    - Run JMXFetch: how-to/run-jmxfetch.md
  - Debug agents:
    - how-to/debug-agents/index.md
    - Linux: how-to/debug-agents/linux.md
    - Windows: how-to/debug-agents/windows.md
  - Memory profiling:
    - Overview: how-to/memory-profiling/overview.md
    - Go: how-to/memory-profiling/go.md
    - Python: how-to/memory-profiling/python.md
    - C++: how-to/memory-profiling/c++.md
- Tutorials:
  - Component framework:
    - Create a component: tutorials/components/creating-components.md
    - Test a component: tutorials/components/testing.md
  - Develop:
    - Environment usage: tutorials/dev/env.md
    - Lab environments:
      - tutorials/dev/lab/index.md
      - Kind: tutorials/dev/lab/kind.md
- Guidelines:
  - Contributing: guidelines/contributing.md
  - Documentation: guidelines/docs.md
  - Component framework: guidelines/components.md
  - Languages:
    - Go: guidelines/languages/go.md
    - Rust: guidelines/languages/RUST.md
  - Testing:
    - Test categories: guidelines/testing/test-categories.md
  - Conventions:
    - Logging: guidelines/conventions/logging.md
- Reference:
  - Component framework:
    - Status providers: reference/components/status.md
  - Agent schema:
    - Keywords: reference/agent-schema/keywords.md
    - CLI commands: reference/agent-schema/cli.md
  - Images:
    - Developer environment: reference/images/dev.md
    - Builders: reference/images/builders.md
  - Agent buildables:
    - Agent components: reference/builds/components.md
  - Developer docs: reference/docs.md
- Architecture:
  - Home: architecture/index.md
  - Component framework:
    - architecture/components/index.md
    - Fx: architecture/components/fx.md
  - Agent schema:
    - architecture/agent-schema/index.md
    - Annotated examples: architecture/agent-schema/examples.md
  - DogStatsD:
    - Internals: architecture/dogstatsd/internals.md

watch:
- .go-version

plugins:
  # Enable for bug reports
  # info: {}
  # Built-in
  search: {}
  # Extra
  glightbox: {}

markdown_extensions:
# Built-in
- zensical.extensions.macros:
    module_name: doc/.hooks/inject_variables
    on_error_fail: true
    on_undefined: strict
    # Macros are rendered before code blocks are extracted, so every delimiter must be a sequence
    # that never appears in quoted code. Jinja's defaults collide with Go composite literals,
    # GitHub Actions expressions and `attr_list` identifiers such as `{#custom-id}`.
    j2_variable_start_string: "<<<"
    j2_variable_end_string: ">>>"
    j2_block_start_string: "<<%"
    j2_block_end_string: "%>>"
    j2_comment_start_string: "<<#"
    j2_comment_end_string: "#>>"
- markdown.extensions.abbr:
- markdown.extensions.attr_list:
- markdown.extensions.footnotes:
- markdown.extensions.md_in_html:
- markdown.extensions.meta:
- markdown.extensions.tables:
- markdown.extensions.toc:
    permalink: true
# Extra
- pymdownx.arithmatex:
- pymdownx.betterem:
    smart_enable: all
- pymdownx.blocks.admonition:
    # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
    types:
    - abstract
    - bug
    - danger
    - example
    - failure
    - info
    - note
    - question
    - quote
    - success
    - tip
    - warning
- pymdownx.blocks.details:
    # Same as admonition types except prefixed by `details-`
    types:
    - name: details-abstract
      class: abstract
    - name: details-bug
      class: bug
    - name: details-danger
      class: danger
    - name: details-example
      class: example
    - name: details-failure
      class: failure
    - name: details-info
      class: info
    - name: details-note
      class: note
    - name: details-question
      class: question
    - name: details-quote
      class: quote
    - name: details-success
      class: success
    - name: details-tip
      class: tip
    - name: details-warning
      class: warning
- pymdownx.blocks.tab:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.caret:
- pymdownx.critic:
- pymdownx.details:
- pymdownx.emoji:
    # Zensical's helpers support inlining icons and emoji:
    # https://zensical.org/docs/setup/extensions/python-markdown-extensions/#emoji
    emoji_index: !!python/name:zensical.extensions.emoji.twemoji
    emoji_generator: !!python/name:zensical.extensions.emoji.to_svg
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    linenums_style: pymdownx-inline
    pygments_lang_class: true
- pymdownx.inlinehilite:
- pymdownx.keys:
- pymdownx.magiclink:
    repo_url_shortener: true
    repo_url_shorthand: true
    social_url_shortener: true
    social_url_shorthand: true
    normalize_issue_symbols: true
    provider: github
    user: DataDog
    repo: datadog-agent
- pymdownx.mark:
- pymdownx.progressbar:
- pymdownx.saneheaders:
- pymdownx.smartsymbols:
- pymdownx.snippets:
    check_paths: true
    base_path:
    - doc/.snippets
    # Repo root, so docs pages can embed a section of a normative in-repo file
    # (e.g. a codereview_guideline.md) rather than restating it.
    - .
    auto_append:
    - links.txt
    - abbrs.txt
- pymdownx.superfences:
- pymdownx.tasklist:
    custom_checkbox: true
- pymdownx.tilde:

extra:
  navigation_roots:
  - url: architecture/
    back_label: Back to main docs
    back_key: b
  social:
  - icon: fontawesome/solid/blog
    link: https://www.datadoghq.com/blog/engineering/
  - icon: fontawesome/brands/github-alt
    link: https://github.com/DataDog
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/datadoghq
  - icon: fontawesome/brands/instagram
    link: https://www.instagram.com/datadoghq
extra_css:
- assets/css/custom.css
- https://cdn.jsdelivr.net/npm/firacode@6.2.0/distr/fira_code.css
extra_javascript:
- assets/javascripts/navigation-roots.js