mkdocs.yml

site_name: Splunk Connect for Syslog
plugins: 
  - search
  - include_dir_to_nav
extra:
  version:
    provider: mike

markdown_extensions:
  - toc:
      permalink: True
  - smarty
  - fenced_code
  - sane_lists
  - codehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.blocks.tab:
      alternate_style: true


theme:
  name: "material"
  palette:
    primary: "black"
    accent: "orange"
  favicon: "logo.png"
  logo: "logo.png"

nav:
  - Home: "index.md"
  - Architectural Considerations: "architecture.md"
  - Load Balancers: "lb.md"
  - Getting Started:
      - Read First: "gettingstarted/index.md"
      - Splunk Setup: "gettingstarted/getting-started-splunk-setup.md"
      - Runtime Configuration: "gettingstarted/getting-started-runtime-configuration.md"
      - Quickstart Guide: "gettingstarted/quickstart_guide.md"
      - Select Runtime:
        - Podman + systemd: "gettingstarted/podman-systemd-general.md"
        - Docker CE + systemd: "gettingstarted/docker-systemd-general.md"
        - MicroK8s + Linux: "gettingstarted/k8s-microk8s.md"
        - Docker Compose: "gettingstarted/docker-compose.md"
        - Docker Desktop + Compose (MacOS): "gettingstarted/docker-compose-MacOS.md"
        - Bring your own Envionment: "gettingstarted/byoe-rhel8.md"
        - Docker&Podman offline installation: "gettingstarted/docker-podman-offline.md"
        - Ansible:
          - Docker Swarm: "gettingstarted/ansible-docker-swarm.md"
          - Podman/Docker: "gettingstarted/ansible-docker-podman.md"
          - mk8s: "gettingstarted/ansible-mk8s.md"
      - Create a parser: "gettingstarted/create-parser.md"
  - Configuration: "configuration.md"
  - Destinations: "destinations.md"
  - Sources:
      - Read First: "sources/index.md"
      - Basic Onboarding: "sources/base"
      - Known Vendors: "sources/vendor"
  - Performance: "performance.md"
  - SC4S Lite (Experimental):
      - Intro: "lite.md"
      - Pluggable modules: "pluggable_modules.md"
  - Edge Processor (Experimental): "edge_processor.md"
  - Troubleshooting:
      - SC4S Startup and Validation: "troubleshooting/troubleshoot_SC4S_server.md"
      - SC4S Logging and Troubleshooting Resources: "troubleshooting/troubleshoot_resources.md"
  - Dashboard: "dashboard.md"
  - Experiments: "experiments.md"
  - Upgrading SC4S: "upgrade.md"
  - SC4S FAQ: "faq.md"