mkdocs.yml

site_name: Event Driven Automation
nav:
  - Home: index.md
  - Getting started:
      - Try EDA: getting-started/try-eda.md
      - Units of automation: getting-started/units-of-automation.md
      - Details:
          - Installation process: getting-started/installation-process.md
          - Virtual network: getting-started/virtual-network.md
          - Verification: getting-started/verification.md
          - Resetting the Playground: getting-started/reset.md
  - Software Installation:
      - software-install/index.md
      - EDA installation overview: software-install/eda-installation-overview.md
      - Preparing for installation: software-install/preparing-for-installation.md
      - Air-gapped setup:
          - software-install/air-gapped/index.md
          - Preparing the Assets VM: software-install/air-gapped/preparing-the-assets-vm.md
          - Downloading the Assets: software-install/air-gapped/downloading-the-assets.md
          - Preparing the environment: software-install/air-gapped/preparing-the-air-gapped-environment.md
          - Deploying the Assets VM: software-install/air-gapped/deploying-the-assets-vm.md
      - Deploying EDA:
          - software-install/deploying-eda/index.md
          - Setting up the EDA nodes: software-install/deploying-eda/setting-up-the-eda-virtual-machine-nodes.md
          - Bootstrap the Talos cluster: software-install/deploying-eda/bootstrap-the-talos-kubernetes-cluster.md
          - Installing the EDA application: software-install/deploying-eda/installing-the-eda-application.md
      - Software Upgrade:
          - software-install/upgrades/index.md
      - Non-production installations:
          - software-install/non-production/index.md
          - On-prem cluster: software-install/non-production/on-prem-cluster.md
          - macOS: software-install/non-production/macos.md
          - Windows (WSL): software-install/non-production/wsl.md
          - KinD: software-install/non-production/kind.md
          - software-install/exposing-ui-api.md
          - software-install/customize-install.md
  - User guide:
      - Queries: user-guide/queries.md
      - Topologies: user-guide/topologies.md
      - Using the CLIs: user-guide/using-the-clis.md
      - Allocation Pools: user-guide/allocation-pools.md
      - Access Control: user-guide/access-control.md
      - user-guide/containerlab-integration.md
  - Apps:
      - Store: apps/app-store.md
      - Fabric: apps/fabric.md
      - Virtual Network: apps/virtualnetwork.md
      - Notifier: apps/notifier.md
      - Prometheus Exporter: apps/prometheus-exporter.md
      - Kafka Exporter: apps/kafka-exporter.md

  - Cloud Connect:
      - Cloud Connect: connect/cloud-connect.md
      - Troubleshooting: connect/troubleshooting.md
      - Audit: connect/audit.md
      - OpenShift Connect Plugin: connect/openshift-plugin.md
      - VMware vSphere Plugin: connect/vmware-plugin.md
      - OpenStack Connect Plugin:
          - OpenStack plugin: connect/openstack-plugin.md
          - CBIS Installation: connect/openstack-cbis.md
  - Development:
      - Applications:
          - There's an app for that: development/apps/index.md
          - Environment setup: development/apps/setup-env.md
          - Quick start: development/apps/quick-start.md
          - Project Layout: development/apps/project-layout.md
          - Components: development/apps/components.md
          - Build and Publish: development/apps/build-publish.md
          - Scripts:
              - development/apps/scripts/index.md
              - Config: development/apps/scripts/config.md
              - State: development/apps/scripts/state.md
              - Debugging: development/apps/scripts/debugging.md
              - Banner Script Walkthrough: development/apps/scripts/banner-script.md
          - EDABuilder: development/apps/edabuilder.md
          - Terminology: development/apps/terminology.md
          # - Workflows: development/apps/workflows.md
          # - Handling versions: development/apps/versions.md
      - API: development/api.md
      - Custom App Catalog: development/custom-catalog.md
      - Custom App Registry: development/custom-registry.md
  - Blog:
      # - blog_dir: blog
      - blog/index.md
      - Subscribe: blog/subscribe.md
      - Tags: blog/tags.md

site_author: Nokia
site_description: >-
  EDA is the platform for automating your infrastructure.
# Repository
repo_name: docs
repo_url: https://github.com/nokia-eda/docs
edit_uri: edit/main/docs/
site_url: "https://docs.eda.dev/"
copyright: Copyright © 2024 Nokia
theme:
  name: material
  custom_dir: docs/overrides

  # 404 page
  static_templates:
    - 404.html

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

  features:
    - navigation.top
    - navigation.tabs
    - navigation.sections
    - navigation.footer
    - search.suggest
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    - content.action.edit
    - toc.follow
    - content.tooltips
    - content.footnote.tooltips
    - navigation.indexes

  language: en
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  font:
    code: Nova
  icon:
    logo: nokia/eda
    repo: fontawesome/brands/github
    edit: material/file-edit-outline
  favicon: images/eda.svg

# Plugins
plugins:
  - meta
  - glightbox
  - macros:
      j2_block_start_string: "-{{%"
      j2_block_end_string: "%}}-"
      j2_variable_start_string: "-{{"
      j2_variable_end_string: "}}-"
      # include_yaml:
      #   - macros/vars.yml
      include_dir: macros
      module_name: macros/main
  - blog:
      post_url_format: "{slug}"
      archive: false
      categories: false
      post_excerpt_max_authors: 2
      authors_profiles: true
  - tags
  - typeset
  - search
  - minify:
      minify_html: true
  - rss:
      match_path: blog/posts/.*
      abstract_chars_count: 5000
      date_from_meta:
        as_creation: date
      categories:
        - tags
      comments_path: "#__comments"
  - git-revision-date-localized:
      enable_creation_date: true
      enabled: !ENV [CI, false]
  - git-committers:
      repository: https://github.com/nokia-eda/docs
      branch: main
      enabled: !ENV [CI, false]
  - social:
      enabled: !ENV [CI, false]
      # enabled: true
      # debug: true
      # debug_color: yellow
      cards_layout: custom

# Customization
extra:
  eda_version: "25.4.1" # current EDA version (provided without the v prefix)
  srl_version: "24.10.4" # latest SRL version for the current EDA version
  social:
    - icon: fontawesome/brands/discord
      link: https://eda.dev/discord
    - icon: fontawesome/brands/github
      link: https://github.com/nokia-eda/docs
  annotate:
    bash:
      - .s1
      - .s2
  version:
    provider: mike

# Extensions
markdown_extensions:
  - abbr
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.md_in_html
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - toc:
      permalink: "#"
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      line_spans: __span
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: nokia-eda
      repo: docs
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
      url_download: true
      dedent_subsections: true
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      disable_indented_code_blocks: true
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.blocks.tab:
      alternate_style: true
  - pymdownx.blocks.admonition
  - pymdownx.blocks.definition
  - pymdownx.blocks.details
  - pymdownx.blocks.html:
      custom:
        - tag: td
          mode: block
        - tag: th
          mode: block
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra_css:
  - stylesheets/nokia.css
  - stylesheets/nokia-fonts.css
  - stylesheets/diagrams.css
  - stylesheets/animations.css
  - stylesheets/steps.css