_docset.yml

project: 'doc-builder'
max_toc_depth: 2
# indicates this documentation set is not linkable by assembler.
# relaxes a few restrictions around toc building and file placement
dev_docs: true
cross_links:
  - docs-content
exclude:
  - '_*.md'
  - '!_search.md'
subs:
  a-global-variable: "This was defined in docset.yml"
  serverless-short: Serverless
  ech:  "Elastic Cloud Hosted"
  serverless-full: "Elastic Cloud Serverless"
  ecloud: "Elastic Cloud"
  dbuild: "docs-builder"
  # Substitutions used by Kibana settings-gen YAML samples (fixtures)
  kib: "Kibana"
  es: "Elasticsearch"
  fleet: "Fleet"
  fleet-server: "Fleet Server"
  ls: "Logstash"
  stack: "Elastic Stack"
  stack-monitor-app: "Stack Monitoring"
  stack-security-features: "Elastic Stack security features"
  security-features: "Elastic Stack security features"
  package-manager: "Elastic Package Manager"
  agent: "Elastic Agent"
  agents: "Elastic Agents"
  bedrock: "Amazon Bedrock"
  gemini: "Google Gemini"
  ibm-r: "IBM Resilient"
  opsgenie: "Opsgenie"
  sn-itsm: "ServiceNow ITSM"
  sn-sir: "ServiceNow SIR"
  sn-itom: "ServiceNow ITOM"
  swimlane: "Swimlane"
  webhook-cm: "Case Management webhook"
  hosted-ems: "hosted Elastic Maps Service"

features:
  primary-nav: false
  
suppress:
  - AutolinkElasticCoDocs
  - DeepLinkingVirtualFile

api:
   elasticsearch: elasticsearch-openapi.json
   kibana:
     - file: kibana-api-overview.md
     - spec: kibana-openapi.json
   dashboard: dashboard-openapi.json

toc:
  - file: index.md
  - hidden: 404.md
  - hidden: _search.md
  - hidden: developer-notes.md
  - hidden: contribute/cumulative-docs/index.md
  - hidden: contribute/cumulative-docs/guidelines.md
  - hidden: contribute/cumulative-docs/badge-placement.md
  - hidden: contribute/cumulative-docs/example-scenarios.md
  - hidden: contribute/cumulative-docs/reference.md
  - folder: contribute
    children:
      - file: index.md
      - file: move.md
      - file: redirects.md
      - file: branching-strategy.md
      - file: add-repo.md
      - file: release-new-version.md
      - file: changelog.md
        children:
          - file: configure-changelogs.md
            children:
              - file: configure-changelogs-ref.md
          - file: create-changelogs.md
          - file: bundle-changelogs.md
          - file: publish-changelogs.md
      - hidden: locally.md
      - hidden: on-the-web.md
  - folder: building-blocks
    children:
      - file: index.md
      - file: documentation-set.md
      - file: assembled-documentation.md
      - file: distributed-documentation.md
      - file: link-service.md
      - file: link-index.md
      - file: link-catalog.md
      - file: outbound-cross-links.md
      - file: inbound-cross-links.md
      - file: documentation-set-navigation.md
      - file: global-navigation.md
  - folder: configure
    children:
      - file: index.md
      - folder: site
        children:
          - file: index.md
          - file: content.md
          - file: navigation.md
          - file: products.md
          - file: versions.md
          - file: legacy-url-mappings.md
          - file: synonyms.md
      - folder: content-set
        children:
          - file: index.md
          - file: file-structure.md
          - file: attributes.md
          - file: navigation.md
          - file: extensions.md
          - file: api-explorer.md
      - file: page.md
      - file: content-sources.md
  - folder: syntax
    children:
      - file: index.md
      - file: quick-ref.md
      - file: directives.md
      - file: headings.md
      - file: admonitions.md
      - file: agent-skill.md
      - file: applies.md
      - file: applies-switch.md
      - file: automated_settings.md
      - file: buttons.md
      - file: changelog.md
      - file: code.md
      - file: comments.md
      - file: conditionals.md
      - file: contributors.md
      - file: csv-include.md
      - file: dropdowns.md
      - file: definition-lists.md
      - file: example_blocks.md
      - file: file_inclusion.md
      - file: footnotes.md
      - file: frontmatter.md
      - file: icons.md
      - file: images.md
      - file: videos.md
      - file: kbd.md
      - file: math.md
      - file: diagrams.md
      - file: lists.md
      - file: task-lists.md
      - file: line_breaks.md
      - file: links.md
      - file: list-sub-pages.md
      - file: page-card.md
      - file: passthrough.md
      - file: sidebars.md
      - file: stepper.md
      - file: substitutions.md
      - file: version-variables.md
      - file: sundries.md
      - file: tables.md
      - file: tabs.md
      - file: tagged_regions.md
      - file: titles.md
  - cli: cli-schema.json
    folder: cli
    children:
      - file: installation.md
      - file: shell-autocompletion.md
      - file: cli-reference-how-to.md
        children:
          - file: cli-supplemental-docs.md
  - folder: mcp
    children:
      - file: index.md
  - folder: migration
    children:
      - file: index.md
      - file: syntax.md
      - file: ia.md
      - file: versioning.md
      - file: engineering.md
      - folder: guide
        children:
          - file: index.md
          - file: working-in-docs-content.md
          - file: automated.md
          - file: tooling.md
          - file: move-ref-docs.md
          - file: mapping.md
          - file: how-to-set-up-docs-previews.md
  # nested TOCs are only allowed from docset.yml by default
  # to prevent them from being nested deeply arbitrarily
  # use max_toc_depth to allow deeper nesting (Expert mode, consult with docs team)
  - toc: development
  - folder: testing
    children:
      - file: index.md
      - file: kibana-settings-yaml-samples.md
      - file: security-settings.md
      - file: req.md
      - folder: nested
        children:
          - file: index.md
      - file: cross-links.md
        children:
          - title: "Getting Started Guide"
            crosslink: docs-content://get-started/introduction.md
      - file: custom-highlighters.md
      - hidden: archive.md
      - hidden: landing-page.md
      - file: nest-under-index/index.md
        children:
          - file: nest-under-index/nested-page-1.md
          - file: nest-under-index/nested-page-2.md
      - folder: mover
        children:
          - file: first-page.md
          - file: second-page.md
      - folder: redirects
        children:
          - file: first-page.md
          - file: second-page.md
          - file: third-page.md
          - file: 5th-page.md
      - folder: deeply-nested
        children:
          - file: index.md
          - file: foo.md
          - file: bar.md
          - folder: baz
            children:
              - file: qux.md
      - folder: release-notes
        children:
          - file: index.md
          - file: highlights.md
          - file: breaking-changes.md
          - file: deprecations.md
          - file: known-issues.md
      - folder: release-notes-all
        children:
          - file: index.md