-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feature/fragments-endpoints
- Loading branch information
Showing
34 changed files
with
510 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
arrange: | ||
- index.md | ||
- getting-started | ||
- catalyst-standards | ||
- architecture | ||
- appendix |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
arrange: | ||
- index.md | ||
- contributing.md | ||
- coc.md | ||
- security.md | ||
- license.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
--- | ||
icon: material/file-sign | ||
title: Code of Conduct | ||
--- | ||
|
||
<!-- markdownlint-disable first-line-h1 --> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
icon: fontawesome/solid/tags | ||
--- | ||
|
||
# Tag Index | ||
|
||
[TAGS] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
icon: octicons/goal-24 | ||
--- | ||
|
||
# Introduction and Goals | ||
|
||
<!-- See: https://docs.arc42.org/section-1/ --> | ||
|
||
## Requirements Overview | ||
|
||
## Quality Goals | ||
|
||
## Stakeholders | ||
|
||
| Role/Name | Contact | Expectations | | ||
|-------------|----------------|--------------------| | ||
| *~Role-1~* | *~Contact-1~* | *~Expectation-1~* | | ||
| *~Role-2~* | *~Contact-2~* | *~Expectation-2~* | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
icon: material/handcuffs | ||
--- | ||
|
||
# Architecture Constraints | ||
|
||
<!-- See: https://docs.arc42.org/section-2/ --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
icon: material/telescope | ||
--- | ||
|
||
# System Scope and Context | ||
|
||
<!-- See: https://docs.arc42.org/section-3/ --> | ||
|
||
## 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~** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
icon: material/strategy | ||
--- | ||
|
||
# Solution Strategy | ||
|
||
<!-- See: https://docs.arc42.org/section-4/ --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
icon: material/toy-brick-search | ||
--- | ||
|
||
# Building Block View | ||
|
||
<!-- See: https://docs.arc42.org/section-5/ --> | ||
|
||
## 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~* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
icon: material/run-fast | ||
--- | ||
|
||
# Runtime View | ||
|
||
<!-- See: https://docs.arc42.org/section-6/ --> | ||
|
||
## ~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~ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
icon: material/server-network | ||
--- | ||
|
||
# Deployment View | ||
|
||
<!-- See: https://docs.arc42.org/section-7/ --> | ||
|
||
## 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~* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
icon: material/thought-bubble | ||
--- | ||
|
||
# Cross-cutting Concepts | ||
|
||
<!-- See: https://docs.arc42.org/section-8/ --> | ||
|
||
## *~Concept 1~* | ||
|
||
... *~explanation~* | ||
|
||
## *~Concept 2~* | ||
|
||
... *~explanation~* | ||
|
||
… | ||
|
||
## *~Concept n~* | ||
|
||
... *~explanation~* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
title: Architecture Decisions |
Oops, something went wrong.