hugo.yaml

# cSpell:ignore docsy goldmark netlify wordmark
baseURL: https://opentelemetry.io
title: OpenTelemetry
disableKinds: [taxonomy]
theme: [docsy]
disableAliases: true # We do redirects via Netlify's _redirects file
enableGitInfo: true

# Language settings
enableMissingTranslationPlaceholders: true
languages:
  en:
    languageName: English
    params:
      description: The OpenTelemetry Project Site

imaging:
  resampleFilter: CatmullRom # cspell:disable-line
  quality: 75
  anchor: smart

markup:
  tableOfContents:
    endLevel: 5
  goldmark:
    extensions:
      linkify: false
    parser:
      attribute:
        block: true
      wrapStandAloneImageWithinParagraph: false
    renderer:
      unsafe: true
  highlight:
    noClasses: false

# Netlify _redirects file
mediaTypes:
  text/netlify: {}

outputFormats:
  REDIRECTS:
    mediaType: text/netlify
    baseName: _redirects
    notAlternative: true

outputs:
  home: [HTML, REDIRECTS]
  section: [HTML]

params:
  copyright:
    authors: >-
      OpenTelemetry Authors | Docs [CC BY
      4.0](https://creativecommons.org/licenses/by/4.0)
    from_year: 2019
  tagline: Effective observability requires high-quality telemetry
  sub_tagline: >-
    **OpenTelemetry** makes robust, portable telemetry a built-in feature of
    cloud-native software.
  sub_description: >-
    **OpenTelemetry** provides a single set of APIs, libraries, agents, and
    collector services to capture distributed traces and metrics from your
    application. You can analyze them using Prometheus, Jaeger, and other
    observability tools.
  github_repo: https://github.com/open-telemetry/opentelemetry.io
  github_branch: main
  gcs_engine_id: bde3d634eca9cd335

  ## Social media image path, such as Open Graph's og:image
  #
  # IMPORTANT: if you change the image but not the path, also increment the
  # version ID in the filename below. Otherwise, for new paths, start at version
  # `001`. Note that social-media images must be preserved (or redirected)
  # forever.
  images:
    - img/social/logo-wordmark-001.png

  ui:
    navbar_logo: true
    navbar_translucent_over_cover_disable: true
    showLightDarkModeMenu: true
    sidebar_menu_compact: true
    sidebar_menu_foldable: true
    sidebar_search_disable: true

  links:
    user:
      - name: Mailing Lists
        url: https://github.com/open-telemetry/community#mailing-lists
        icon: fa fa-envelope
        desc: List of mailing lists that the project uses.
      - name: Mastodon
        url: https://fosstodon.org/@opentelemetry
        icon: fab fa-mastodon
        desc: Follow us on Mastodon to get the latest news!
      - name: X
        url: https://x.com/opentelemetry
        icon: fab fa-x-twitter
        desc:
          Follow us on X, previously known as Twitter, to get the latest news!
      - name: Stack Overflow
        url: https://stackoverflow.com/questions/tagged/open-telemetry
        icon: fab fa-stack-overflow
        desc: Practical questions and curated answers
      - name: OTel logos
        url: https://github.com/cncf/artwork/tree/master/projects/opentelemetry
        icon: fas fa-image
        desc: Official OpenTelemetry logos
      - name: Meeting Recordings
        url: https://docs.google.com/spreadsheets/d/1SYKfjYhZdm2Wh2Cl6KVQalKg_m4NhTPZqq-8SzEVO6s
        icon: fas fa-video
        desc: Watch our meeting recordings on Zoom Cloud
      - name: Site analytics
        url: https://lookerstudio.google.com/s/tSTKxK1ECeU
        icon: fa-solid fa-chart-line
        desc: Google analytics for opentelemetry.io
    developer:
      - name: GitHub
        url: https://github.com/open-telemetry
        icon: fab fa-github
        desc: Find us on GitHub.
      - name: 'Slack #opentelemetry'
        url: https://cloud-native.slack.com/archives/CJFCJHG4Q
        icon: fab fa-slack
        desc: >-
          Chat with other project developers. Sign up via
          [slack.cncf.io](https://slack.cncf.io). Also see other channels
          starting with a `#otel-` prefix.
      - name: CNCF DevStats
        url: https://opentelemetry.devstats.cncf.io/d/8/dashboards?orgId=1&refresh=15m
        icon: fas fa-chart-area
        desc: See our activity on CNCF DevStats
      - name: Privacy Policy
        url: https://www.linuxfoundation.org/legal/privacy-policy
        icon: fa fa-book
        desc: CNCF and Linux Foundation privacy policy.
      - name: Trademark Usage
        url: https://www.linuxfoundation.org/legal/trademark-usage
        icon: fa-solid fa-trademark
        desc: Linux Foundation’s trademarks policy and guidelines.
      - name: Marketing Guidelines
        url: /community/marketing-guidelines/
        icon: fas fa-bullhorn
        desc: >-
          Important information on how to represent your personal or corporate
          contributions or participation in the OpenTelemetry project.
      - name: Site-build info
        url: /site/
        icon: fa-solid fa-hammer
        desc: Site-build information.

  logos:
    hero: opentelemetry-horizontal-color.png
    cncf: cncf.png

  social:
    - name: GitHub
      url: https://github.com/open-telemetry/
      color: black
      icon: fab fa-github
    - name: X
      url: https://x.com/opentelemetry
      color: twitter
      icon: fab fa-x-twitter
    - name: Slack
      url: https://cloud-native.slack.com/archives/CJFCJHG4Q
      color: slack
      icon: fab fa-slack
    - name: Medium
      url: https://medium.com/opentelemetry
      color: light
      icon: fab fa-medium
    - name: Mailing list
      url: https://lists.cncf.io/g/cncf-opentelemetry-community
      color: info
      icon: far fa-envelope

  fonts:
    - name: Noto Sans # cspell:disable-line
      sizes: [300, 400, 600, 700]
      type: sans_serif

  notes: # as markdown
    docker-compose-v2: |
      `docker-compose` is deprecated. For details, see
      [Migrate to Compose V2](https://docs.docker.com/compose/migrate/).
    browser-instrumentation: |
      Client instrumentation for the browser is **experimental** and mostly **unspecified**.
      If you are interested in helping out, get in touch with the
      [Client Instrumentation SIG](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w).

services:
  googleAnalytics:
    # The following is a placeholder (fake) ID useful for local test builds. The
    # real ID is set in the Netlify config. For details, see
    # https://github.com/open-telemetry/opentelemetry.io/issues/1626.
    id: UA-00000000-0 # TODO: switch to G-0000000000 once we get confirmation that it's ok to do so

security:
  funcs: # cspell:disable-line
    getenv: # cspell:disable-line
      # Netlify build env var
      - ^(BRANCH|BUILD_ID|COMMIT_REF|CONTEXT|DEPLOY_ID|NETLIFY|PULL_REQUEST|REVIEW_ID)$

module:
  mounts:
    - source: content/en
      target: content
    - source: tmp/otel/specification
      target: content/docs/specs/otel
    - source: tmp/opamp
      target: content/docs/specs/opamp
    - source: tmp/otlp/docs/specification.md
      target: content/docs/specs/otlp/_index.md
    - source: tmp/otlp/docs/img
      target: content/docs/specs/otlp/img
    - source: tmp/semconv/docs
      target: content/docs/specs/semconv
    - source: tmp/community/mission-vision-values.md
      target: content/community/mission.md
    - source: tmp/community/roadmap.md
      target: content/community/roadmap.md
    - source: static
      target: static
    - source: content-modules/semantic-conventions/schemas
      target: static/schemas
    - source: static/img
      target: static/img
    - source: content-modules/opentelemetry-specification/internal/img
      target: static/img
    - source: iconography/32x32
      target: static/img/logos/32x32