From 54bd4ec7849c8f0d9bdcc4a7a893c669d88cad72 Mon Sep 17 00:00:00 2001 From: Steven Johnson Date: Fri, 24 Nov 2023 13:52:40 +0700 Subject: [PATCH] docs(docs): Update to latest docs builder, add architecture docs templates (#153) Force merged due to long delay sitting in review, and it's blocking me from doing DB design docs. --- .config/dictionaries/project.dic | 3 +- .vscode/settings.recommended.json | 11 +++ docs/Earthfile | 6 +- docs/mkdocs.yml | 64 +++++++------- docs/src/.pages | 6 ++ docs/src/appendix/important/.pages | 6 ++ docs/src/appendix/important/coc.md | 1 + docs/src/appendix/tags.md | 7 ++ docs/src/architecture/.pages | 14 ++++ .../architecture/01_introduction_and_goals.md | 18 ++++ .../02_architecture_constraints.md | 7 ++ .../03_system_scope_and_context.md | 21 +++++ docs/src/architecture/04_solution_strategy.md | 7 ++ .../architecture/05_building_block_view.md | 78 ++++++++++++++++++ docs/src/architecture/06_runtime_view.md | 20 +++++ docs/src/architecture/07_deployment_view.md | 36 ++++++++ docs/src/architecture/08_concepts.md | 21 +++++ .../09_architecture_decisions/.pages | 1 + .../0001-arch-std.md | 55 ++++++++++++ .../09_architecture_decisions/0002-adr.md | 47 +++++++++++ .../09_architecture_decisions/index.md | 16 ++++ .../09_architecture_decisions/template/.pages | 1 + .../template/0xxx-template.md_ | 42 ++++++++++ .../architecture/10_quality_requirements.md | 11 +++ docs/src/architecture/11_technical_risks.md | 7 ++ docs/src/architecture/12_glossary.md | 12 +++ docs/src/architecture/images/arc42-logo.png | Bin 0 -> 8151 bytes docs/src/architecture/index.md | 25 ++++++ docs/src/important/coc.md | 5 -- docs/src/important/contributing.md | 5 -- docs/src/important/index.md | 5 -- docs/src/important/license.md | 15 ---- docs/src/important/security.md | 5 -- docs/src/monorepo-architecture/index.md | 8 -- 34 files changed, 510 insertions(+), 76 deletions(-) create mode 100644 docs/src/.pages create mode 100644 docs/src/appendix/important/.pages create mode 100644 docs/src/appendix/tags.md create mode 100644 docs/src/architecture/.pages create mode 100644 docs/src/architecture/01_introduction_and_goals.md create mode 100644 docs/src/architecture/02_architecture_constraints.md create mode 100644 docs/src/architecture/03_system_scope_and_context.md create mode 100644 docs/src/architecture/04_solution_strategy.md create mode 100644 docs/src/architecture/05_building_block_view.md create mode 100644 docs/src/architecture/06_runtime_view.md create mode 100644 docs/src/architecture/07_deployment_view.md create mode 100644 docs/src/architecture/08_concepts.md create mode 100644 docs/src/architecture/09_architecture_decisions/.pages create mode 100644 docs/src/architecture/09_architecture_decisions/0001-arch-std.md create mode 100644 docs/src/architecture/09_architecture_decisions/0002-adr.md create mode 100644 docs/src/architecture/09_architecture_decisions/index.md create mode 100644 docs/src/architecture/09_architecture_decisions/template/.pages create mode 100644 docs/src/architecture/09_architecture_decisions/template/0xxx-template.md_ create mode 100644 docs/src/architecture/10_quality_requirements.md create mode 100644 docs/src/architecture/11_technical_risks.md create mode 100644 docs/src/architecture/12_glossary.md create mode 100644 docs/src/architecture/images/arc42-logo.png create mode 100644 docs/src/architecture/index.md delete mode 100644 docs/src/important/coc.md delete mode 100644 docs/src/important/contributing.md delete mode 100644 docs/src/important/index.md delete mode 100644 docs/src/important/license.md delete mode 100644 docs/src/important/security.md delete mode 100644 docs/src/monorepo-architecture/index.md diff --git a/.config/dictionaries/project.dic b/.config/dictionaries/project.dic index e946395ed50..fc050401f3d 100644 --- a/.config/dictionaries/project.dic +++ b/.config/dictionaries/project.dic @@ -28,6 +28,7 @@ dotglob drep dreps encryptor +fontawesome gapless gcloud genhtml @@ -90,4 +91,4 @@ xcodeproj xctest xctestrun xcworkspace -yoroi \ No newline at end of file +yoroi diff --git a/.vscode/settings.recommended.json b/.vscode/settings.recommended.json index b532dac40d5..02dbcf79760 100644 --- a/.vscode/settings.recommended.json +++ b/.vscode/settings.recommended.json @@ -66,6 +66,17 @@ "tag:yaml.org,2002:python/name:materialx.emoji.twemoji", "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" ], + "[yaml]": { + "editor.insertSpaces": true, + "editor.tabSize": 2, + "editor.autoIndent": "advanced", + "diffEditor.ignoreTrimWhitespace": false, + "editor.quickSuggestions": { + "other": true, + "comments": false, + "strings": true + } + }, "[markdown]": { "editor.formatOnSave": true, "editor.formatOnPaste": true, diff --git a/docs/Earthfile b/docs/Earthfile index 9b340158595..5d8c5694f73 100644 --- a/docs/Earthfile +++ b/docs/Earthfile @@ -6,7 +6,7 @@ VERSION 0.7 # Copy all the source we need to build the docs src: # Common src setup - DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.5+SRC + DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.8+SRC # Now copy into that any artifacts we pull from the builds. COPY --dir ../+repo-docs/repo /docs/includes @@ -15,12 +15,12 @@ src: docs: FROM +src - DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.5+BUILD + DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.8+BUILD # Make a locally runable container that can serve the docs. local: # Build a self contained service to show built docs locally. - DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.5+PACKAGE + DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.8+PACKAGE # Copy the static pages into the container COPY +docs/ /usr/share/nginx/html diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a0a3924e86b..226139f568c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,32 +10,38 @@ site_url: https://input-output-hk.github.io/catalyst-docs repo_name: input-output-hk/catalyst-voices repo_url: https://github.com/input-output-hk/catalyst-voices -# Page tree -nav: - - Home: index.md - - Getting Started: - - Getting Started: getting-started/index.md - - Quick Start: getting-started/quick-start.md - - Advanced: getting-started/advanced.md - - Development: getting-started/development.md - - Monorepo Architecture: - - Monorepo Architecture: monorepo-architecture/index.md - - Catalyst Standards: - - Catalyst Standards: catalyst-standards/index.md - - Draft CIPs: - - Draft CIPs: catalyst-standards/draft-cips/index.md - - Role Registration: catalyst-standards/draft-cips/role-registration/cip-xxxx.md - - RBAC CIP30 Extension: catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md - - Catalyst Voting CIP30 Extension: catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md - - Catalyst Ballot Formats: - - Catalyst Ballot Formats: catalyst-standards/ballot/index.md - - Catalyst V1 Ballot: catalyst-standards/ballot/catalyst-v1.md - - Catalyst V2 Ballot: catalyst-standards/ballot/catalyst-v2.md - - Appendix: - - Appendix: appendix/index.md - - Important Information: - - Important Information: appendix/important/index.md - - Contributing: appendix/important/contributing.md - - Code of Conduct: appendix/important/coc.md - - Security: appendix/important/security.md - - License: appendix/important/license.md +# Page tree - is created automatically. +# See: https://henrywhitaker3.github.io/mkdocs-material-dark-theme/plugins/awesome-pages/ + +# Tags used in these docs +extra: + tags: + HTML5: html + JavaScript: js + CSS: css + Rust: rust + Flutter: flutter + Dart: dart + Python: python + Earthly: earthly + Github: github + Docker: docker + arc42: arc42 + ADR: adr + +# Icons associated with the tags +theme: + icon: + tag: + html: fontawesome/brands/html5 + js: fontawesome/brands/js + css: fontawesome/brands/css3 + rust: simple/rust + flutter: simple/flutter + dart: simple/dart + python: simple/python + earthly: material/earth-plus + github: simple/github + docker: simple/docker + arc42: material/pencil-ruler + adr: material/arrow-decision-auto diff --git a/docs/src/.pages b/docs/src/.pages new file mode 100644 index 00000000000..14d3d96d7c8 --- /dev/null +++ b/docs/src/.pages @@ -0,0 +1,6 @@ +arrange: + - index.md + - getting-started + - catalyst-standards + - architecture + - appendix diff --git a/docs/src/appendix/important/.pages b/docs/src/appendix/important/.pages new file mode 100644 index 00000000000..2386aeb6a21 --- /dev/null +++ b/docs/src/appendix/important/.pages @@ -0,0 +1,6 @@ +arrange: + - index.md + - contributing.md + - coc.md + - security.md + - license.md diff --git a/docs/src/appendix/important/coc.md b/docs/src/appendix/important/coc.md index 95610f557e3..20f13025910 100644 --- a/docs/src/appendix/important/coc.md +++ b/docs/src/appendix/important/coc.md @@ -1,5 +1,6 @@ --- icon: material/file-sign +title: Code of Conduct --- diff --git a/docs/src/appendix/tags.md b/docs/src/appendix/tags.md new file mode 100644 index 00000000000..b528bdd3492 --- /dev/null +++ b/docs/src/appendix/tags.md @@ -0,0 +1,7 @@ +--- +icon: fontawesome/solid/tags +--- + +# Tag Index + +[TAGS] diff --git a/docs/src/architecture/.pages b/docs/src/architecture/.pages new file mode 100644 index 00000000000..6422cc2c62f --- /dev/null +++ b/docs/src/architecture/.pages @@ -0,0 +1,14 @@ +arrange: + - index.md + - 01_introduction_and_goals.md + - 02_architecture_constraints.md + - 03_system_scope_and_context.md + - 04_solution_strategy.md + - 05_building_block_view.md + - 06_runtime_view.md + - 07_deployment_view.md + - 08_concepts.md + - 09_architecture_decisions + - 10_quality_requirements.md + - 11_technical_risks.md + - 12_glossary.md diff --git a/docs/src/architecture/01_introduction_and_goals.md b/docs/src/architecture/01_introduction_and_goals.md new file mode 100644 index 00000000000..8e8b9c04eb4 --- /dev/null +++ b/docs/src/architecture/01_introduction_and_goals.md @@ -0,0 +1,18 @@ +--- +icon: octicons/goal-24 +--- + +# Introduction and Goals + + + +## Requirements Overview + +## Quality Goals + +## Stakeholders + +| Role/Name | Contact | Expectations | +|-------------|----------------|--------------------| +| *~Role-1~* | *~Contact-1~* | *~Expectation-1~* | +| *~Role-2~* | *~Contact-2~* | *~Expectation-2~* | diff --git a/docs/src/architecture/02_architecture_constraints.md b/docs/src/architecture/02_architecture_constraints.md new file mode 100644 index 00000000000..6857c329d65 --- /dev/null +++ b/docs/src/architecture/02_architecture_constraints.md @@ -0,0 +1,7 @@ +--- +icon: material/handcuffs +--- + +# Architecture Constraints + + diff --git a/docs/src/architecture/03_system_scope_and_context.md b/docs/src/architecture/03_system_scope_and_context.md new file mode 100644 index 00000000000..504b72aa5c2 --- /dev/null +++ b/docs/src/architecture/03_system_scope_and_context.md @@ -0,0 +1,21 @@ +--- +icon: material/telescope +--- + +# System Scope and Context + + + +## Business Context + +... **~Diagram or Table~** + +... **~optionally: Explanation of external domain interfaces~** + +## Technical Context + +... **~Diagram or Table~** + +... **~optionally: Explanation of technical interfaces~** + +... **~Mapping Input/Output to Channels~** diff --git a/docs/src/architecture/04_solution_strategy.md b/docs/src/architecture/04_solution_strategy.md new file mode 100644 index 00000000000..ed860a9332b --- /dev/null +++ b/docs/src/architecture/04_solution_strategy.md @@ -0,0 +1,7 @@ +--- +icon: material/strategy +--- + +# Solution Strategy + + diff --git a/docs/src/architecture/05_building_block_view.md b/docs/src/architecture/05_building_block_view.md new file mode 100644 index 00000000000..9558ac9752a --- /dev/null +++ b/docs/src/architecture/05_building_block_view.md @@ -0,0 +1,78 @@ +--- +icon: material/toy-brick-search +--- + +# Building Block View + + + +## White box Overall System + +... ***~Overview Diagram~*** + +Motivation +... *~text explanation~* + +Contained Building Blocks +... *~Description of contained building block (black boxes)~* + +Important Interfaces +... *~Description of important interfaces~* + +### ~Name black box 1~ + +... *~Purpose/Responsibility~* + +... *~Interface(s)~* + +... *~(Optional) Quality/Performance Characteristics~* + +... *~(Optional) Directory/File Location~* + +... *~(Optional) Fulfilled Requirements~* + +... *~(optional) Open Issues/Problems/Risks~* + +### ~Name black box 2~ + +... *~black box template~* + +### ~Name black box n~ + +... *~black box template~* + +### ~Name interface 1~ + +… + +### ~Name interface m~ + +## Level 2 + +### White Box *~building block 1~* + +... *~white box template~* + +### White Box *~building block 2~* + +... *~white box template~* + +… + +### White Box *~building block m~* + +... *~white box template~* + +## Level 3 + +### White Box ~\_building block x.1\_\~ + +... *~white box template~* + +### White Box ~\_building block x.2\_\~ + +... *~white box template~* + +### White Box ~\_building block y.1\_\~ + +... *~white box template~* diff --git a/docs/src/architecture/06_runtime_view.md b/docs/src/architecture/06_runtime_view.md new file mode 100644 index 00000000000..99a501369d8 --- /dev/null +++ b/docs/src/architecture/06_runtime_view.md @@ -0,0 +1,20 @@ +--- +icon: material/run-fast +--- + +# Runtime View + + + +## ~Runtime Scenario 1~ + +* *~insert runtime diagram or textual description of the scenario~* + +* *~insert description of the notable aspects of the interactions + between the building block instances depicted in this diagram.~* + +## ~Runtime Scenario 2~ + +## … + +## ~Runtime Scenario n~ diff --git a/docs/src/architecture/07_deployment_view.md b/docs/src/architecture/07_deployment_view.md new file mode 100644 index 00000000000..16286a903d1 --- /dev/null +++ b/docs/src/architecture/07_deployment_view.md @@ -0,0 +1,36 @@ +--- +icon: material/server-network +--- + +# Deployment View + + + +## Infrastructure Level 1 + +... ***~Overview Diagram~*** + +Motivation +... *~explanation in text form~* + +Quality and/or Performance Features +... *~explanation in text form~* + +Mapping of Building Blocks to Infrastructure +... *~description of the mapping~* + +## Infrastructure Level 2 + +### *~Infrastructure Element 1~* + +... *~diagram + explanation~* + +### *~Infrastructure Element 2~* + +... *~diagram + explanation~* + +… + +### *~Infrastructure Element n~* + +... *~diagram + explanation~* diff --git a/docs/src/architecture/08_concepts.md b/docs/src/architecture/08_concepts.md new file mode 100644 index 00000000000..5fff894c370 --- /dev/null +++ b/docs/src/architecture/08_concepts.md @@ -0,0 +1,21 @@ +--- +icon: material/thought-bubble +--- + +# Cross-cutting Concepts + + + +## *~Concept 1~* + +... *~explanation~* + +## *~Concept 2~* + +... *~explanation~* + +… + +## *~Concept n~* + +... *~explanation~* diff --git a/docs/src/architecture/09_architecture_decisions/.pages b/docs/src/architecture/09_architecture_decisions/.pages new file mode 100644 index 00000000000..689ce31ffda --- /dev/null +++ b/docs/src/architecture/09_architecture_decisions/.pages @@ -0,0 +1 @@ +title: Architecture Decisions \ No newline at end of file diff --git a/docs/src/architecture/09_architecture_decisions/0001-arch-std.md b/docs/src/architecture/09_architecture_decisions/0001-arch-std.md new file mode 100644 index 00000000000..1c0535cffc2 --- /dev/null +++ b/docs/src/architecture/09_architecture_decisions/0001-arch-std.md @@ -0,0 +1,55 @@ +--- + title: 0001 Architecture Documentation Standard + adr: + author: Steven Johnson + created: 15-Nov-2023 + status: accepted + tags: + - arc42 +--- + +## Context + +There needs to be a commonly understood and well documented structure to Architecture Documentation. +Architecture Documentation is the responsibility of the entire team. +A standardized structure to that documentation helps with collaboration. + +## Assumptions + +* Architecture documentation is the collective responsibility of the development team. +* A well documented structure to that documentation will aid in collaboration and maintenance of the documentation. + +## Decision + +We will be using the [arc42] standard for organizing architecture documentation. + +## Risks + +* That [arc42] becomes unmaintained upstream, or some flaw is found with its methodology. +* That the team does not understand the structure of the architecture documentation or necessity to maintain it. + +## Consequences + +If we do: + +* It is easier to maintain documentation when there is an agreed structure to it. +* It is easier to on-board new members of the team when there are resources to help understand the documentation and its structure. +* Architecture Documentation will be of higher quality and more meaningfully reviewed in the context of an agreed structure. + +If we don't: + +* Architecture docs will be "ad-hoc". +* Difficult for the team to meaningfully collaborate on Architecture. +* Difficult to maintain. +* Difficult to ensure the necessary information is captured. +* Difficult to iterate and be agile. + +## More Information + +* [arc42] +* [Original Templates](https://github.com/arc42/arc42-template/tree/master/dist) +* [Main Documentation](https://docs.arc42.org/home/) +* [Books](https://leanpub.com/b/arc42complete) +* [Examples](https://arc42.org/examples) + +[arc42]: https://arc42.org diff --git a/docs/src/architecture/09_architecture_decisions/0002-adr.md b/docs/src/architecture/09_architecture_decisions/0002-adr.md new file mode 100644 index 00000000000..1566338b9f8 --- /dev/null +++ b/docs/src/architecture/09_architecture_decisions/0002-adr.md @@ -0,0 +1,47 @@ +--- + title: 0002 Architecture Decision Records + adr: + author: Steven Johnson + created: 15-Nov-2023 + status: accepted + extends: + - 0001-arch-std + tags: + - arc42 + - ADR +--- + +## Context + +Architecture Decision Records are part of [arc42]. +We need an efficient and automated way to manage them. +The system needs to be easy for anyone to use as documenting Architecture Decisions is a team responsibility. + +## Assumptions + +* The team as a whole is responsible for creating and maintaining Architecture Decision Records. + +## Decision + +We will use the [MkDocs Material ADR Plugin] to assist in ADR documentation and automation. + +## Risks + +* The plugin doesn't get maintained or has technical issues + +This risk can be mitigated because the plugin is simple, and it would be easy for us to fork and maintain it as required. + +## Consequences + +* ADR become easier for people to author. +* This should assist in making the team more pro-active in their creation and maintenance. + +## More Information + +* [arc42] +* [arc42 ADR Guide](https://docs.arc42.org/section-9/) +* [MkDocs Material ADR Plugin] +* [Fixed fork of MkDocs Material ADR Plugin](https://github.com/stevenj/mkdocs-material-adr) + +[arc42]: https://arc42.org +[MkDocs Material ADR Plugin]: https://github.com/Kl0ven/mkdocs-material-adr/tree/main diff --git a/docs/src/architecture/09_architecture_decisions/index.md b/docs/src/architecture/09_architecture_decisions/index.md new file mode 100644 index 00000000000..025822f75e4 --- /dev/null +++ b/docs/src/architecture/09_architecture_decisions/index.md @@ -0,0 +1,16 @@ +--- +icon: material/arrow-decision-auto +--- + +# Architecture Decisions + + + +Index + +[GRAPH] diff --git a/docs/src/architecture/09_architecture_decisions/template/.pages b/docs/src/architecture/09_architecture_decisions/template/.pages new file mode 100644 index 00000000000..0dcafb34370 --- /dev/null +++ b/docs/src/architecture/09_architecture_decisions/template/.pages @@ -0,0 +1 @@ +hide: true \ No newline at end of file diff --git a/docs/src/architecture/09_architecture_decisions/template/0xxx-template.md_ b/docs/src/architecture/09_architecture_decisions/template/0xxx-template.md_ new file mode 100644 index 00000000000..d39406974f3 --- /dev/null +++ b/docs/src/architecture/09_architecture_decisions/template/0xxx-template.md_ @@ -0,0 +1,42 @@ +--- + title: 0xxx all + adr: + author: Steven Johnson + created: 15-Nov-2023 + status: draft / proposed / accepted / rejected / superseded + superseded_by: 0007-accepted + extends: + - 0001-draft + - 0002-proposed + - 0003-accepted + tags: + - tag2 + - tag3 +--- + +--- *This is a template ADR to be copied and completed when adding new ADR* --- + +## Context + +What is the issue that we're seeing that is motivating this decision or change? + +## Assumptions + +Anything that could cause problems if untrue now or later + +## Decision + +What is the change that we're proposing and/or doing? + +## Risks + +Anything that could cause malfunction, delay, or other negative impacts + +## Consequences + +What becomes easier or more difficult to do because of this change? + +## More Information + +Provide additional evidence/confidence for the decision outcome +Links to other decisions and resources might here appear as well. diff --git a/docs/src/architecture/10_quality_requirements.md b/docs/src/architecture/10_quality_requirements.md new file mode 100644 index 00000000000..6ef42e6c5e1 --- /dev/null +++ b/docs/src/architecture/10_quality_requirements.md @@ -0,0 +1,11 @@ +--- +icon: material/quality-high +--- + +# Quality Requirements + + + +## Quality Tree + +## Quality Scenarios diff --git a/docs/src/architecture/11_technical_risks.md b/docs/src/architecture/11_technical_risks.md new file mode 100644 index 00000000000..8a5d83386a7 --- /dev/null +++ b/docs/src/architecture/11_technical_risks.md @@ -0,0 +1,7 @@ +--- +icon: fontawesome/solid/biohazard +--- + +# Risks and Technical Debts + + diff --git a/docs/src/architecture/12_glossary.md b/docs/src/architecture/12_glossary.md new file mode 100644 index 00000000000..689a2a3a94c --- /dev/null +++ b/docs/src/architecture/12_glossary.md @@ -0,0 +1,12 @@ +--- +icon: material/format-list-group-plus +--- + +# Glossary + + + +| Term | Definition | +|-------------|-------------------| +| *~Term-1~* | *~definition-1~* | +| *~Term-2~* | *~definition-2~* | diff --git a/docs/src/architecture/images/arc42-logo.png b/docs/src/architecture/images/arc42-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..88c76d06319442a14d956d2513c04a919aca0ac3 GIT binary patch literal 8151 zcmbVR002u~PDc#r}X}0Dv-IUP@fc8+dMn z;jcB)@m0XhlaG3b91Qk>qQ1`w7or0Gz^iUWmGT#JtX;V;W-9P*{pPD!xny9!gb=f< z?Z5Joi3UeneSt|r!Z_(l1}Kh;hZyp{Yt7B-B8Yd*a%(Mo!y+U1(b8=;i)+sLb!(b$ z%bzO}ojPg<6Wv`49ZKH1E7OC8E{6`mgl`u}YWBl}u{WM&4zQ5f+2;!x;p}3OPJzYO z$RG&hXr6!_QXt9Kr|uI5#Kd&BL9Zb1ypuU7Rtfp_Q$cz9*(gY1f;dL46TQd))%3z2 ziO`DL8=X#pPeIyRLY@YfJEVV$9J(4$73%hCyzo7v2cJdG?e&K)np1+*sGkY?yntJ3 z<5KbLZcMr)+A#_lQ>Yp~wL28o0wVS+BZfXzvp@S2#)#i48GHDB8f=?R3D6Vcew9zd zS`=)$P5BvrA2stx6kdnYn=5K-0O9Bkgz0rZibe+ynL0y!M`Qn>43sL5eW?!a-sqM^%E0zTAZoJOE4-_z9h?@Pt` zmwWe3Lz_X`6N6;34R$1$;5bf~-Jn-;<}SfZUL*}S%0YRcm?)~S4+2RaepLa&{>0Ie z>MU%p#JF5vNkCL)BN1I(bl-O_jjNnijWJEB1+0Z z^MP#Mg*}RM?wmibgW+_=qX;XtZmkazhR8Sp=AAArKoV(l=)o8 z4!_y@Mw3QPP=*&m6*DY*DaZBtZ%D<+j@)WS;t4fgRmv0Ts*gKn4OxK%kFYVMgTKx* znB=U2tdzx+gwFi1nEsK!)5^K-!2&Z5I}yo3DLfMEZed1(&y zVfwn1Jwx-qXe4d*#@BUHzJR zSxFj)O-GOR_>QX4&c^soafwDIxwXOR*XA4iJiTo*d%c7%(ZW+k|HFUQw_OxIrd`*& zOevJEpfo9U+dn@S%RT|6Qk!Q%r*YM7Zu9a?Xktz&P ziY0C*@&AtZhqGIaUZ3vpUqDqVTNo1Dddp6{X)?6Tg4*iN}X|U zcpMCkMxsH&fiI1JZ|VeyBpvMtN|6Zo9f`&4ToWjSvvUiW@gD9&>GfC(Vwo$j`-eP7 zZFjq}PuHKZFv=Xbr%?^}qu)+#CjjQwETGl2*oK^4-wIOM7Jti+PAy;q+#vjeeNhJA zwG6G9{B`i#jN^~~41{E(kz3`S_^&r*Y*P_7H}Aqpkm5wk*_>DN6DRBO>RSfxVhB)5mw?@1wcF)kVh!}i7oj!T5X7nNS`kLGUzMiSI z(z>o22Xp*$q0`t-4lIdNrP}-H{@3_+9p{_W^uYUeA`-I73=<8>rAV*Y9I6BVArCS1 z;RDnp(Y+0=$+QWHLND>RP0?x36l5#EhNdpUo3IQ=rGMSem5j1OarTIU%8Xzg%uk!Q zmM;yh$981EYm63I-aylMc+%n4Q2tV)>GvB;^|>aqp(0N1>^8OP$M9$?Xztyht1KJK z8J&2`FgB+zX3_6n!^TD?cl19uydNM1+n-hOPf`+%kZ$&f0dD%4%bC~X@%N4Le%M?& zcWa5~0vb(M%LOR!M^sa!>q|<1z=ENZ+L`zp!G@g(w?7-ZYVa@u$jT?^LhlZF9)n_& z?|sU0Hpv+$_k0QBZIP2)dp#SzHILp#=(^;Q$b46vUnwj%86~(|UGKnG&BuiIK z>%+R;LW_*2qFpIjw5sXa@jb5Xsw%EEUwTy|^?jMsx560f`k!JzO4o3PydW~DLp8>a z&$#AafMupP6R*bU1FK*SRDn0u`IGk%MbY1hWTVb)l2kqF*q8#XVz?!^3?T&2Vq$^S zNgsS0A+o2py1kXL1sqX0W32qK0bmo1eH>Mv%`elY}`46e5J2g`R=LDVRy3 zZfi?aN6z!m;)S7bZdv4q6?4~ryoYDSotv!&aY)ryxUB;gF9JK0TLd)e$GJU1`dVkG zqMqjC8gBX&p4A%(o=3ADV=u)c%S7c1i$b)-B4rTxEjhDG1@oJ*@9PxcHC2reX`s~q z$$ECg+EDPJhk7frDE+NVBRly+rY@?-m8gsV8-_qp$o-@yk`lwvl$NOjDlL!Hvxya~Zig$a@~KGLMjd z#uXKMJ)-w4MPgUYv1ai}uWyjnr4c}Nxag0hgv8trR8-S`dn$cS$h)LN!(vbt*uu1S%9P7aS4&C?z?UfQL;$nI2(&QWX>LMJ(Xmxn;mb8UGWbD7NW8(`h}l0K&a>b*#AP9K%O zYXXj^c+0hTj4p7Ug`3^_1p9LYHzRVqDML)OimZ(3G>J=fSVwZtX=lfa88qY1yBdhT z&=?_|=EbI@WF7E=Pn}rmZgJ8@ZWk^&Cn=hK4zG-EuEDkJvVyX5AJDUD+V4iSsNHoO z7zd$ohOyWTXu|&*^Gn3@Z_hk63=nY-O})o)oPJ3B(?m@6cz-dbF_6NicKWV3{Gm4_ zp?j|6h%{z8>(K{`bfpVFY9WW063BV^kDXCZ*&E#dW*~N@DDZW@M{VMzs=|7QP$R=R zSk(1sC)7AXx^`)PIrmow@{OJ}wI<*-_Nw{k?Pp?R-+&r1^oYYk0=#G085ns|wd3R% zloQ2`H+L!#=YS)dSy4bn%b!^mSaxc@?^e^rO9~{J>!IYKNw$dgas5R*9K^~_b!#m4T+CguV@x1Bxdt>w7aS))Q`MITrk>B*6h??^HmA9by zl{QWj2}yXw$PN0IWMZi3kaRWzorM(Bk;C%eC)Msnt0yDfwVCiOrmB@5BeQP_W!SzC z_8P5YjP$0QLNQ5fjp&B3kTchMY{}bWjD+N`rh@>gU#|_+Plz{B@(&JTlqDT=%=HjI z8+_dH<;USPc6bhsmbK~ltsB+u#>3(n>xl5w7GM9RZ2q_pyCuZen@9D`{nGRUZ@D>l z8K1aAzk&WGVFVpKKgq1F^;8M)63X1P|^(h?G(wJo;}U0~-9hVUICiQg&7$;sp7lQZGA zicHMRFTR4r^sKB{vW!)kw2QI(T*&Q?*&q8X{@r1&vhsYr)U%FP=FTCV&VwBvng*@w z`Xjeg?k)12_zv1NuUVZg6h{WkWY5!M0^Z+UgT5)N#6UA2L_mpB4tPd+ zCV~p?9^igyY@IVs$YM##!7Rd_C9;ZMB;3C~1O>v;pr|^wi>K|@=|RUwJsfew4g=>^W{;SSQ2-BI{q5~BNjeSMj|+rE#hv+xep1(e`#JG-Ua~Jz zonmu<-1p@Io{yr|XaJs1Tahx-c@5DewU{oHZ1$tm9aj3ai6izHu!`+cO-SFZ70;RP z4*$S)bi>6?=-_Zf7e(2WcSW&IoDFJDI#sLVv9%S5<#qn>(#_GD@>ZE}>BCVaA3JN- zG{upuXNmK{vDS{gDeh-~&11z|#4JQ27cJn`xnR@ZJ+ zskvV(t8{T5uFC6Bh&dBBo=5`q(gty^KdFHiHQLYhB8d!k92X2=Ae$s_{|Oy+OW*cY z1$nKqpqfx@=_|ugE`{uqkt7YD+P;h^+WbP)n~?9BZMzAn5EQW-nMYmQ=Nm&Yklz|a zcDSpLfP8Gx*g!0|N0B;4`JB4jPS{9cHl-7CUHF3&4YLDq>03DDgy)42aeG6G`t_9Y z;IOpZTGX}?S`U}179^h3k`LcV9>k-cU7lF{QuYp9`DAACU}SD0o#hrjuxZ!bn^&dv z!8^d@Ga-ETsK@5}K*e`!iNm&dnj9R7x*J*n_o~AoHyqls7lxaJnXYtj+Zu`PAq(%J zs>v%hf{G;D4lqz1Cv>{G`l&`P%!CMC8Ni_sXfr$K@-U8;MUJHtX{-|}zTP7z`Z&At z7lfLh$LmNU2L9!^WgG}_*4aH&0rA7pOHM-4C#{`%D&L zk$8GqqSOa;H=U#z6IDuc{`Pv&ZcFLb?rprcKo#+6m!g_ zmK8-68KDF9u04qd_EHcr3SpZCmK7j)rKsshj)a_~6hV>gt;=b1zs)dkp?%%qnKh#T&WuNd^AE1?&Z6Vb$zF`4EtO+F|A(tKh+;cM&mBHogN*~Jx~S<-C}(io*UXBG zenel<-A-b_<{`p+w@)750q`K)qQ&Q`$?JH|&8wZYm!w{uz(r9(!LD~wk$wXJ<6>l+ zPSOeCBIuK=QUlIJ1BD7nA*-_TOkgxe%|1FO`P^YJ^@&U04=X|XEx(S9r{ASvS%h}h z_`j9*iR&}U@8)%_(_V7M>+C zDvkqj<4Mt|a+KYaR;9lxyS%o$d3Yj0`W;pFjpeq`>}q+ z0T|x+pMb+wRUVuS?nLw>eE;+v(<_J}10!>d9~!2H(^fd8Xuqd@KQqSOg+QnT zK6T9#d}+w3#-eqZe(r;6eweadMKvf~^(vnRxZ=kSdeiwbdCf(nGZiX*?YyXD^fSvt z{AiCoO!eApE%4vN4)dvB@9rr2^?mDp({2WNFDhfl`Ob%7;Hj)G$J${--+lEkZ)>l? zw1bg8<&MnviCNg#jEWYg?DpcW{nBuNHg1bG^W7;nty@*qWZpWo4{%jcptnJ$l!KFO zr^+h&I_};0lL%_4_-yzO$lmurqf`HEuDJWnTDM;Qqawx^QMVDb;Gis=hZQ&NM`@v8 zljXLmD)%(!o{&w%D8?TDm!SY;P#Q2Y2pi>@Q+bpufU4e4S$C%gzxhX^K0;s?5i&Xj z`ZH&o&_oF1B$rKFtRVA5+eCEDt#d7N>5xVPH^WH1B&i!!cW9p5p z*f4iuC>!6-bp9>_L*V(&${#1jMEqhK^4a#pUaD7W6-W75ih4w+0` zF+AuBfoTPquT;{x%OySeR#P z;!^yp|K;Imd9a+N<)hs@qrt8iMgKv0p7Z7F>!bXRlv3@$x)a!MihYDU+j@nZAe$f( zhGr3@YrkQzPLY1S7U4O$)KT5hQvmJ6vQglU*)Q7FeO8M`!F!b!iJvYEOc$yD3RP-? zN1rbKx-m%Cj-l%n@CQZD?rD5wA{+28SRG@#PE5)u7+mj&wlZEVh!XuoFTzZ{yn@s! zQl3oNcFAD$w^=?kcaGnPrg6ddOTmdlU%*-EGKSak5L6mJYfSeCYJHXkl=1bIc?< zywyF%xxXzrtgM_!@8#QSYNHnJuBVMlK3B5S7>b~B*15{lwgFm$eZk)cPcNdlucue- z*fdwH0!1e|yi8VFO|~2$_qs;81?#GC%+Al39PnAhhZU((_wu9)#Ga8asnNJE2(fg; zj`EQ^X9cs+`wm0frY)B{$0qvoqxNIhxH1tWux{h>x<3WadZR5ldQ)9)8TJot59o5o z+`u65k0vrV!~VQQlA4_Ellg}PA@$?7@!y)!?cNT!p#6=%vmLqzekHh^KSC1KgfzJ8 zKXGJ{8hAtq3`oV6-Z;V++@q{B4JVynctfY(*_|7?j&IE_j5m|%8dQv|4^XJ~ee0gX zGq|G>eY`QKb((T*kv2Bv0*I;J5O@#)et>ibrMoxf59%cYF`p|mLM6)VQUHl07)p`N1l-rlK zsq|sMA7*GuBovXYNBJ|_+B}VnAJr;^ekQ*m;I@DsBSrwLe}Y7OS9b~&J=7JBc^Ypc z2&;MUuX{Py%4gtQZ26x24sPEZV;{rx4~jDCHBEn|lR4NIJHz)n{t}?t(?MRo{~aGp zNZS->L=4n(R9L&*UmB|&oo$xg13Zh2c#3*vq~~2Q?9tm1*rWqTfBki$AYk!5y5TZ>ecGDN!(9|{WX@q^OIEtK7FWT z%vk;}B30v3=w~^8i3rS_N(>7%8m~;@1UI>RU6v9Ol-Kn{vIW7ch}zguIcGU}*W_!y zhxkDpqNyVS{va8(bCHTL5Niu{=FWSh&^kmn<>qbs)1S*d{O72%7_oYG12)(94<|#1 z(85DK!8~ASR;P-li~9r-K`%*rzfBo-h{8RB5YBDoJbEw-4(870yV&Fd|6MR%oTZ3q z@pTkFba{sx1#*+j@Tb|^D%8~o6PJ-Ra`B?yv`>&c;R!!(fdZ!f1W%PAmNvP(;s+8? zQV$sK4P0$qJkGY?mx-w%_b31EF}=U>sHrC4bKcYq-_(rZy!Za7JUQ>(i{78iH0lc= z>l*lU(vukW7FKbn(fyCqSfJII6V-RG*&{+Z#HO*bl!5EP0(Y7A`mm#;gYD;egE1b$ zA=)Es0bfZ3x%V37@Fdl6MaE<$=%K6tl*G+$h>DJw2NL`1Loe3AD)lSVrxZ4fAAE)a zRiok_htUJIjJIVs;NdbCRaI5qHC0uZ#omk6Vl6(D&yLV-mNWa6V;U_0AA)_L zu$WQG#kWMSigeMx7aK1;SG%QA9SFyPVfIv`o(yq92WX#~&M-c`eV?ql{_6N^`QhBy zi)xRa3Mo`2bZlDJ1*>zYs>mlL*IFMrj@&#SObuH*U-#ixe-;XMgGl8Nz)|vOlE;!S zrCq#s3+3`@Nsd+}qcr$e(+v~6>vNQLUp^(!O+b>9vFlvtL_ej^1Z}8;NjKOi)+FGOYxBr8^S0qK zmv4Z=nGj`sEs0uB_)~AW=9FZm(W-;I=*7CWyAXj`3AQlf#Io>sVduFF@{h;_GJ&S* zvMd}Gh8$H4gGlp0=k5NdYzs`9wn#jLzbJSB;POLP qMx9pmzi5U=Rg-q)|1%4DLs22YiEa+}eE(ly50IBuk*bq`hyEYBHHY^A literal 0 HcmV?d00001 diff --git a/docs/src/architecture/index.md b/docs/src/architecture/index.md new file mode 100644 index 00000000000..00fd70dba28 --- /dev/null +++ b/docs/src/architecture/index.md @@ -0,0 +1,25 @@ +--- +icon: material/pencil-ruler +tags: + - arc42 +--- + + + + +# Architecture + +## About arc42 + +The architecture documentation is based upon the [Arc42 documentation standard](https://arc42.org/overview). + +arc42, the template for documentation of software and system +architecture. + +Template Version 8.2 EN. (based upon AsciiDoc version), January 2023 + +Created, maintained and © by Dr. +Peter Hruschka, Dr. +Gernot Starke and +contributors. +See . diff --git a/docs/src/important/coc.md b/docs/src/important/coc.md deleted file mode 100644 index 60fbf695c66..00000000000 --- a/docs/src/important/coc.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -icon: material/file-sign ---- - -# Code of Conduct diff --git a/docs/src/important/contributing.md b/docs/src/important/contributing.md deleted file mode 100644 index 9cb8036773d..00000000000 --- a/docs/src/important/contributing.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -icon: material/pen-plus ---- - -# Contributing diff --git a/docs/src/important/index.md b/docs/src/important/index.md deleted file mode 100644 index df6e9085fba..00000000000 --- a/docs/src/important/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -icon: material/alert-decagram-outline ---- - -# Important diff --git a/docs/src/important/license.md b/docs/src/important/license.md deleted file mode 100644 index f89f9e0ed65..00000000000 --- a/docs/src/important/license.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -icon: material/license ---- - -# License - - - -??? note "Apache 2 License" - - {{ include_file('..', 0, 4) }} - -??? note "MIT License" - - MIT diff --git a/docs/src/important/security.md b/docs/src/important/security.md deleted file mode 100644 index bb71804c822..00000000000 --- a/docs/src/important/security.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -icon: material/security ---- - -# Security diff --git a/docs/src/monorepo-architecture/index.md b/docs/src/monorepo-architecture/index.md deleted file mode 100644 index 36c95764f79..00000000000 --- a/docs/src/monorepo-architecture/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -icon: material/pencil-ruler ---- - - -# Monorepo Architecture - -TODO, add description and diagram of Monorepo architecture.