workshops/mkdocs.yml at main · network-observability/workshops · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
site_name: AutoCon5 · Modern Network Observability
site_description: The AutoCon5 hands-on workshop on Modern Network Observability — one continuous on-call investigation, the whole stack on your laptop.
site_url: https://network-observability.github.io/workshops/
repo_url: https://github.com/network-observability/workshops
repo_name: network-observability/workshops
edit_uri: edit/main/

copyright: Part of the <a href="https://network-observability.github.io/" target="_blank" rel="noopener">Modern Network Observability</a> ecosystem &middot; Copyright &copy; 2026

dev_addr: "127.0.0.1:8001"

theme:
  name: material
  language: en
  features:
    # Navigation
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.path
    - navigation.top
    - navigation.footer
    # Search
    - search.suggest
    - search.highlight
    - search.share
    # Code blocks
    - content.code.copy
    - content.code.annotate
    - content.code.select
    # Tabs (for vendor compare etc)
    - content.tabs.link
    # Tooltips
    - content.tooltips
    # Headers
    - header.autohide
    # TOC
    - toc.follow
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  logo: assets/book-cover.jpg
  favicon: assets/book-cover.jpg
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra_css:
  - stylesheets/autocon5.css

plugins:
  - search
  - include-markdown:
      preserve_includer_indent: true
      dedent: false
      trailing_newlines: true
      comments: false

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

  # PyMdown — the FastAPI / Prefect set
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
      base_path: ["docs", "."]
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Get started:
      - Install Docker and uv: install.md
      - Quickstart: quickstart.md
  - AutoCon5 workshop:
      - Overview: workshop/index.md
      - Tour the stack: workshop/tour.md
      - One workday, one investigation: workshop/guides.md
      - Part 1 — Telemetry and queries: workshop/part-1.md
      - Part 2 — Dashboards and Alerts: workshop/part-2.md
      - Part 3 — Alert response, Automation and AI: workshop/part-3.md
      - Advanced — End-to-end investigation: workshop/advanced.md
  - "Modern Network Observability hub ↗": https://network-observability.github.io/

extra:
  social:
    - icon: material/home-circle
      link: https://network-observability.github.io/
      name: Modern Network Observability hub
    - icon: fontawesome/brands/github
      link: https://github.com/network-observability/workshops
      name: workshops on GitHub
    - icon: fontawesome/brands/github
      link: https://github.com/network-observability/network-observability-lab
      name: companion lab on GitHub

watch:
  - workshops/autocon5/README.md
  - workshops/autocon5/guides
  - README.md