-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathmkdocs.yml
More file actions
246 lines (244 loc) · 10.4 KB
/
Copy pathmkdocs.yml
File metadata and controls
246 lines (244 loc) · 10.4 KB
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# workfloworchestrator.github.io uses site_name in the URL, don't change it
site_name: Orchestrator Core
site_description: An extensible workflow engine to manage customer facing resources and resource facing resources.
site_url: https://workfloworchestrator.org/orchestrator-core
theme:
name: material
icon:
repo: fontawesome/brands/github-alt
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:
- search.suggest
- search.highlight
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.instant
- navigation.indexes
- content.code.copy
- content.code.annotate
- content.tooltips
- content.tabs.link
- header.autohide
plugins:
- external-markdown
- search
- open-in-new-tab
- render_swagger
- macros
- include-markdown
- privacy
- social
- mkdocstrings:
default_handler: python
enable_inventory: true
handlers:
python:
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
docstring_options:
trim_doctest_flags: true
- redirects:
redirect_maps:
'architecture/product_modelling/imports.md': 'guides/product-modeling/imports.md'
'architecture/product_modelling/backfilling.md': 'guides/product-modeling/backfilling.md'
'architecture/application/tasks.md': 'guides/tasks.md'
'reference-docs/app/scaling.md': 'guides/scaling.md'
'reference-docs/app/pause-and-resume.md': 'guides/pause-and-resume.md'
'migration-guide/2.0.md': 'guides/upgrading/2.0.md'
'migration-guide/3.0.md': 'guides/upgrading/3.0.md'
'migration-guide/4.0.md': 'guides/upgrading/4.0.md'
'migration-guide/4.0.md': 'guides/upgrading/4.0.md'
'migration-guide/5.0.md': 'guides/upgrading/5.0.md'
'contributing/testing.md': 'guides/testing.md'
copyright: Copyright © 2018 - 2026 Workflow Orchestrator Programme
extra:
generator: false
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/fQkQn5ajFR
name: WFO on Discord!
repo_name: workfloworchestrator/orchestrator-core
repo_url: https://github.com/workfloworchestrator/orchestrator-core
edit_uri: edit/main/docs/
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.superfences
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
- pymdownx.keys
- pymdownx.inlinehilite
- pymdownx.blocks.admonition
- pymdownx.tabbed:
alternate_style: true
- attr_list
- codehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- abbr
extra_css:
- "css/termynal.css"
- "css/custom.css"
- "css/style.css"
- "css/markers.css"
extra_javascript:
- "js/termynal.js"
- "js/custom.js"
nav:
- Workflow Orchestrator:
- Workflow Orchestrator: index.md
- Orchestrator Framework: architecture/framework.md
- Orchestrator UI:
- Orchestrator UI: architecture/orchestration/orchestrator-ui.md
# - Env variables:
# - Dark Theme adjustment / dark theme env setting
# - Your own company logo
# - Component-lib
# - RBAC
# - Isallowed wrapper
# - OIDC
# - Code flow with PKCE
- User input forms:
- Generic solution: architecture/application/forms-frontend.md
# - Form page with all form field:
# - Extensibility:
# - Extra menu item
# - Add a new summary card
- Architecture:
- Architecture; TL;DR: architecture/tldr.md
- Orchestration Philosophy: architecture/orchestration/philosophy.md
- Domain Models: architecture/application/domainmodels.md
- How do Workflows work?: architecture/application/workflow.md
- Product modeling:
- Introduction: architecture/product_modelling/introduction.md
- Standards: architecture/product_modelling/standards.md
- Modelling: architecture/product_modelling/modelling.md
- Context: architecture/product_modelling/context.md
- Terminology: architecture/product_modelling/terminology.md
- Example Product Models:
- Node: architecture/product_modelling/node.md
- Port: architecture/product_modelling/port.md
- L2 Point-to-Point: architecture/product_modelling/l2_point_to_point.md
- L2 VPN: architecture/product_modelling/l2_vpn.md
- IP Static: architecture/product_modelling/ip_static.md
- Product Block Graph: architecture/product_modelling/product_block_graph.md
- Extensibility:
- Packaging: architecture/extensibility/packaging.md
- Optional Modules: architecture/extensibility/modules.md
- Guides:
- Getting Started:
- Prerequisites: getting-started/versions.md
- Application:
- Preparing source folder: getting-started/prepare-source-folder.md
- Base application: getting-started/base.md
- Workflows: getting-started/workflows.md
- Docker: getting-started/docker.md
- Orchestrator UI: getting-started/orchestration-ui.md
- Product Modeling:
- Importing Existing Products: guides/product-modeling/imports.md
- Backfilling Existing Subscriptions: guides/product-modeling/backfilling.md
- Creating Tasks and Schedules: guides/tasks.md
- Testing: guides/testing.md
- Scaling the Orchestrator: guides/scaling.md
- Pausing the Orchestrator: guides/pause-and-resume.md
- Generating a Config File: guides/generate-config-file.md
# These would ideally go here:
# - Migrations:
# - Subscriptions
# - Workflows
# - Tasks
- Upgrade Guides:
- v2.x: guides/upgrading/2.0.md
- v3.x: guides/upgrading/3.0.md
- v4.x: guides/upgrading/4.0.md
- v4.7: guides/upgrading/4.7.md
- v4.8: guides/upgrading/4.8.md
- v5.0: guides/upgrading/5.0.md
- Reference Documentation:
- TL;DR: reference-docs/tldr.md
- API docs:
- Rest API: reference-docs/api.md
- GraphQL: reference-docs/graphql.md
- Auth(n|z): reference-docs/auth-backend-and-frontend.md
- CLI Tools: reference-docs/cli.md
- Database: reference-docs/database.md
- Domain Models:
- Overview: reference-docs/domain_models/overview.md
- Domain Model Types:
- Product Types: reference-docs/domain_models/product_types.md
- Product Blocks: reference-docs/domain_models/product_blocks.md
- Model Attributes: reference-docs/domain_models/model_attributes.md
- Helpers:
- Generator: reference-docs/domain_models/generator.md
- Forms: reference-docs/forms.md
- Running the App:
- App.py: reference-docs/app/app.md
- Python Version: reference-docs/python.md
- Settings: reference-docs/app/settings-overview.md
- Workflows:
- Workflows: reference-docs/workflows/workflows.md
- Workflow Steps: reference-docs/workflows/workflow-steps.md
- Conditional Steps: reference-docs/workflows/conditional-steps.md
- Callback step: reference-docs/workflows/callbacks.md
- Run Predicates: reference-docs/workflows/run-predicates.md
# Recommend a non-guide doc answering "What are tasks?"
# - Tasks:
- Websockets: reference-docs/websockets.md
- Search: reference-docs/search.md
- MCP Server: reference-docs/mcp.md
- Monitoring:
- Error Tracking: reference-docs/monitoring/error-tracking.md
- Metrics: reference-docs/monitoring/metrics.md
- Parallelization:
- reference-docs/parallelization/index.md
- GÉANT: reference-docs/parallelization/geant.md
- SURF: reference-docs/parallelization/surf.md
- Contributing:
- Development setup: contributing/development.md
- Guidelines: contributing/guidelines.md
watch:
- includes
- orchestrator