ksml/mkdocs.yml at main · Axual/ksml · 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
site_name: KSML Documentation
site_author: Axual
site_description: Documentation for the KSML project

site_dir: _site
exclude_docs: |
  ksml-language-spec.md
theme:
  name: material
  features:
    - content.code.copy

plugins:
  - search
  - include-markdown:
      encoding: ascii
      preserve_includer_indent: true
      dedent: true
      trailing_newlines: true
      comments: false
      rewrite_relative_urls: true
      heading_offset: 0
      recursive: true
  - autorefs:
      resolve_closest: true
  - mike:
      version_selector: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - docs                                            # the default docs dir
        - ksml/src/test/resources                        # unit test resources
        - ksml-integration-tests/src/test/resources      # integration test resources
        - ksml-test-runner/src/test/resources             # test runner resources
      check_paths: true
  - pymdownx.superfences
  - pymdownx.details
  - admonition

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike
    default: latest

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: getting-started/quick-start.md
      - Understanding KSML: getting-started/introduction.md
      - Editing Python Code: getting-started/editing-python-code.md
      - Testing Your Pipeline: getting-started/testing-your-pipeline.md
      - Schema Validation: getting-started/schema-validation.md
  - Tutorials:
      - Overview: tutorials/index.md
      - KSML Basics Tutorial: getting-started/basics-tutorial.md
      - Producer Tutorial: getting-started/producer-tutorial.md
      - Beginner Tutorials:
        - Overview: tutorials/beginner/index.md
        - Filtering and Transforming: tutorials/beginner/filtering-transforming.md
        - Different Data Formats: tutorials/beginner/data-formats.md
        - Avro Logical Types: tutorials/beginner/avro-logical-types.md
        - Logging and Monitoring: tutorials/beginner/logging-monitoring.md
      - Intermediate Tutorials:
        - Overview: tutorials/intermediate/index.md
        - Branching: tutorials/intermediate/branching.md
        - Aggregations: tutorials/intermediate/aggregations.md
        - Joins: tutorials/intermediate/joins.md
        - Windowing: tutorials/intermediate/windowing.md
        - Error Handling: tutorials/intermediate/error-handling.md
        - State Stores: tutorials/intermediate/state-stores.md
      - Advanced Tutorials:
        - Overview: tutorials/advanced/index.md
        - Complex Event Processing: tutorials/advanced/complex-event-processing.md
        - Custom State Stores: tutorials/advanced/custom-state-stores.md
        - Performance Optimization: tutorials/advanced/performance-optimization.md
        - Integration with External Systems: tutorials/advanced/external-integration.md
  - Use Case Guides:
      - Overview: use-cases/index.md
      - Data Transformation: use-cases/data-transformation.md
      - Event-Driven Applications: use-cases/event-driven-applications.md
      - IoT Data Processing: use-cases/iot-data-processing.md
      - Real-time Analytics: use-cases/real-time-analytics.md
      - Fraud Detection: use-cases/fraud-detection.md
  - References:
      - Overview: reference/index.md
      - KSML Definition Reference: reference/definition-reference.md
      - Pipeline Reference: reference/pipeline-reference.md
      - Function Reference: reference/function-reference.md
      - Operation Reference: reference/operation-reference.md
      - Data Types and Notations Reference: reference/data-and-formats-reference.md
      - State Store Reference: reference/state-store-reference.md
      - Configuration Reference: reference/configuration-reference.md
      - Metrics Reference: reference/metrics-reference.md
  - Upgrading to 2.0.0: migration-to-2.0.0.md
  - Release Notes: release-notes.md