Skip to content

Commit ca59d49

Browse files
committed
doc: update structure of the documentation
1 parent cf70e1a commit ca59d49

22 files changed

Lines changed: 98 additions & 22 deletions

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,5 @@ yarn-error.log*
2525
.clj-kondo/
2626
.lsp/
2727
.vscode/
28-
.antigravity/
28+
.antigravity/
29+
extracted_text/

docs/architectural-decisions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# SPDX-License-Identifier: CC-BY-4.0
55

66
sidebar_position: 9
7+
description: Important, expensive, critical, large scale or risky architecture decisions including rationales.
78
---
89

910
# Architectural Decisions (ADRs)

docs/constraints.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# SPDX-License-Identifier: CC-BY-4.0
55

66
sidebar_position: 2
7+
description: Anything that constrains teams in design and implementation decisions or decision about related processes. Can sometimes go beyond individual systems and are valid for whole organizations and companies.
78
---
89

910
# Constraints

docs/context-and-scope.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# SPDX-License-Identifier: CC-BY-4.0
55

66
sidebar_position: 3
7+
description: Delimits your system from its (external) communication partners (neighboring systems and users). Specifies the external interfaces. Shown from a business/domain perspective (always) or a technical perspective (optional).
78
---
89

910
# Context and Scope

docs/crosscutting-concepts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# SPDX-License-Identifier: CC-BY-4.0
55

66
sidebar_position: 8
7+
description: Overall, principal regulations and solution approaches relevant in multiple parts (→ cross-cutting) of the system. Concepts are often related to multiple building blocks. Include different topics like domain models, architecture patterns and -styles, rules for using specific technology and implementation rules.
78
---
89

910
# Cross-cutting Concepts

docs/glossary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# SPDX-License-Identifier: CC-BY-4.0
55

66
sidebar_position: 12
7+
description: Important domain and technical terms that stakeholders use when discussing the system. Also, translation reference if you work in a multi-language environment.
78
---
89

910
# Glossary

docs/introduction-and-goals.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# SPDX-License-Identifier: CC-BY-4.0
55

66
sidebar_position: 1
7+
description: Short description of the requirements, driving forces, extract (or abstract) of requirements. Top three (max five) quality goals for the architecture which have highest priority for the major stakeholders. A table of important stakeholders with their expectation regarding architecture.
78
---
89

910
# Introduction and Goals
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "1+MG Infrastructure",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index"
6+
}
7+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
SPDX-FileCopyrightText: 2025 PNED G.I.E.
2+
3+
SPDX-License-Identifier: Apache-2.0

docs/building-block-view.md renamed to docs/oneplusmg-infrastructure/building-block-view.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# SPDX-License-Identifier: CC-BY-4.0
55

66
sidebar_position: 5
7+
description: Static decomposition of the system, abstractions of source-code, shown as hierarchy of white boxes (containing black boxes), up to the appropriate level of detail.
78
---
89

910
# Building Block View
@@ -12,8 +13,6 @@ sidebar_position: 5
1213

1314
The 1+MG Infrastructure is decomposed into three primary logical zones:
1415

15-
![Business Context](./assets/business_context.drawio.png)
16-
1716
| System | Responsibility |
1817
| :------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1918
| **1+MG User Portal (Central)** | **Functional Description:** The web-based entry point for researchers to discover data and request access.<br/>**Interfaces:** HTTPS (Web), OIDC (Auth), Beacon API (Query).<br/>**Quality:** High Usability, Public Accessibility.<br/>**Location:** `src/portal`, Hosted by Genome EDIC. |

0 commit comments

Comments
 (0)