workfloworchestrator.github.io/mkdocs.yml at main · workfloworchestrator/workfloworchestrator.github.io · 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
site_name: Workflow Orchestrator Programme
site_url: https://workfloworchestrator.org
nav:
  - Home: index.md
  - The programme:
      - About: about.md
      - Contact: contact.md
      - Leadership: leadership.md
  - Community:
      - Members: members.md
      - Meetings: meetings.md
      - Media: media.md
  - Projects:
      - Orchestrator Core: "!include ./orchestrator-core/mkdocs.yml"
      # INCLUDED_REPO: https://github.com/workfloworchestrator/orchestrator-core.git
      - Orchestrator UI Library: "!include ./orchestrator-ui-library/mkdocs/mkdocs.yml"
      # INCLUDED_REPO: https://github.com/workfloworchestrator/orchestrator-ui-library.git
      - Lightweight Service Orchestrator: "!include ./lso/mkdocs.yml"
      # INCLUDED_REPO: https://github.com/workfloworchestrator/lso.git

theme:
  name: material
  favicon: "img/favicon.ico"
  logo: img/WFO-Emblem-White.png
  palette:
    - scheme: default
      primary: teal
      accent: amber
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/lightbulb-on
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: amber
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/lightbulb-outline
        name: Switch to system preference
    - primary: teal
      accent: amber
      media: "(prefers-color-scheme)"
      toggle:
        icon: material/lightbulb-auto
        name: Switch to light mode
  features:
    - navigation.sections
  icon:
    repo: fontawesome/brands/github-alt
extra_css:
  - css/style.css
repo_name: workfloworchestrator
repo_url: https://github.com/workfloworchestrator
copyright: Copyright &copy; 2018 - 2026 Workflow Orchestrator Programme
extra:
  generator: false
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/fQkQn5ajFR
      name: WFO on Discord!
hooks:
  # Merges markdown_extensions, extra_css, extra_javascript, and theme from included mkdocs.yml files,
  # as the monorepo plugin does not do this (https://github.com/backstage/mkdocs-monorepo-plugin/issues/138)
  - hooks/merge_subproject_configs.py
plugins:
  - search
  - privacy
  - social
  - monorepo
  # Keep in sync with orchestrator-core/mkdocs.yml plugins (can't be merged dynamically)
  - external-markdown
  - open-in-new-tab
  - render_swagger
  - macros
  - include-markdown
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
          paths:
            - lso/lso
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: null
            docstring_section_style: list
            annotations_path: full
            separate_signature: true
            line_length: 80
            show_signature_annotations: true
            unwrap_annotated: true
  - redirects:
      redirect_maps:
        "orchestrator-core/architecture/product_modelling/imports.md": "orchestrator-core/guides/product-modeling/imports.md"
        "orchestrator-core/architecture/product_modelling/backfilling.md": "orchestrator-core/guides/product-modeling/backfilling.md"
        "orchestrator-core/architecture/application/tasks.md": "orchestrator-core/guides/tasks.md"
        "orchestrator-core/reference-docs/app/scaling.md": "orchestrator-core/guides/scaling.md"
        "orchestrator-core/reference-docs/app/pause-and-resume.md": "orchestrator-core/guides/pause-and-resume.md"
        "orchestrator-core/migration-guide/2.0.md": "orchestrator-core/guides/upgrading/2.0.md"
        "orchestrator-core/migration-guide/3.0.md": "orchestrator-core/guides/upgrading/3.0.md"
        "orchestrator-core/migration-guide/4.0.md": "orchestrator-core/guides/upgrading/4.0.md"
  # orchestrator-ui-library plugins
  - termynal
  - awesome-pages