Skip to content

Commit 79a2e86

Browse files
RossBugginsNHSRossBugginsNHS
authored
Added an events collection and link to architecture pages. (#73)
* Added an events collection and link to architecture pages. * Timer code diagram. * Diagrams collection on menu * refactor diagram names. * Made diagrams a referenable type in architecture front matter. * Added status report generation and descriptions to diagram layout. * added iframe titles. * Changed status report diagram names. * Added c4 type and link arch pages to events page.
1 parent 4e99e84 commit 79a2e86

47 files changed

Lines changed: 377 additions & 102 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/_config.yml‎

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,22 @@ collections:
3434
diagrams:
3535
output: true
3636
sort_by: order
37+
events:
38+
output: true
39+
sort_by: order
3740

38-
41+
just_the_docs:
42+
collections:
43+
events:
44+
name: Events
45+
nav_exclude: false
46+
nav_fold: true
47+
search_exclude: false
48+
diagrams:
49+
name: Diagrams
50+
nav_exclude: false
51+
nav_fold: true
52+
search_exclude: false
3953
# Build settings
4054
theme: just-the-docs
4155
plugins:
@@ -93,6 +107,17 @@ callouts:
93107

94108

95109
defaults:
110+
111+
112+
- scope:
113+
path: "architecture"
114+
type: "pages"
115+
values:
116+
layout: "architecture"
117+
owner: NHS Notify
118+
author: NHS Notify
119+
last_modified_date: 2025-01-01
120+
96121
- scope:
97122
path: "schemas"
98123
type: "pages"
@@ -121,7 +146,14 @@ defaults:
121146
owner: NHS Notify
122147
author: NHS Notify
123148
last_modified_date: 2025-01-01
124-
149+
- scope:
150+
path: ""
151+
type: "events"
152+
values:
153+
layout: "event"
154+
owner: NHS Notify
155+
author: NHS Notify
156+
last_modified_date: 2025-01-01
125157
# Exclude from processing.
126158
# The following items will not be processed, by default.
127159
# Any item listed under the `exclude:` key here will be automatically added to

‎docs/_includes/diagram.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,9 @@
22
| where_exp:"diagram", "diagram.title == include.title"
33
| first %}
44

5-
[Link to this diagram directly: {{ diagram.url |relative_url }}]({{ diagram.url |relative_url }})
5+
<h3>{{ diagram.title }}</h3>
6+
<div>{{ diagram.description }}</div>
7+
<div>C4: {{ diagram.c4type }}</div>
8+
9+
<a href="{{ diagram.url |relative_url }}">Link to this diagram directly: {{ diagram.url |relative_url }}</a>
610
{{ diagram.content | markdownify }}

‎docs/_includes/events.html‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<h2>Events Raised</h2>
2+
3+
<ul>
4+
{% for eventraised in page.events-raised %}
5+
6+
{% assign event = site.events
7+
| where_exp:"event", "event.title == eventraised"
8+
| first %}
9+
10+
<li>
11+
<a href="{{event.url | relative_url}}">
12+
{{ event.title }} - {{ event.type }}
13+
</a>
14+
</li>
15+
{% endfor %}
16+
</ul>
17+
18+
<h2>Events Consumed</h2>
19+
20+
<ul>
21+
{% for eventconsumed in page.events-consumed %}
22+
23+
{% assign event = site.events
24+
| where_exp:"event", "event.title == eventconsumed"
25+
| first %}
26+
27+
<li>
28+
<a href="{{event.url | relative_url}}">
29+
{{ event.title }} - {{ event.type }}
30+
</a>
31+
</li>
32+
{% endfor %}
33+
</ul>
34+
35+
</ul>

‎docs/_layouts/architecture.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default
3+
---
4+
5+
{% include page-info-header.html %}
6+
7+
{% include events.html %}
8+
9+
<h2>Diagrams</h2>
10+
11+
{% for diagramtitle in page.diagrams %}
12+
13+
{% assign diagram = site.diagrams
14+
| where_exp:"diagram", "diagram.title == diagramtitle"
15+
| first %}
16+
17+
{% include diagram.html title=diagram.title %}
18+
{% endfor %}
19+
20+
21+
22+
{{ content }}

‎docs/_layouts/event.html‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: default
3+
---
4+
5+
{% include page-info-header.html %}
6+
7+
Event Type: {{page.type}}
8+
9+
<h2>Raised by</h2>
10+
<ul>
11+
{% for archpage in site.pages %}
12+
13+
{% if archpage.layout =="architecture" %}
14+
15+
{% if archpage.events-raised contains page.title %}
16+
17+
<li>
18+
<a href="{{archpage.url | relative_url}}">
19+
{{ archpage.c4type }}: {{ archpage.title }}
20+
</a>
21+
</li>
22+
{% endif %}
23+
{% endif %}
24+
{% endfor %}
25+
</ul>
26+
27+
<h2>Consumed by</h2>
28+
<ul>
29+
{% for archpage in site.pages %}
30+
31+
{% if archpage.layout =="architecture" %}
32+
33+
{% if archpage.events-consumed contains page.title %}
34+
35+
<li>
36+
<a href="{{archpage.url | relative_url}}">
37+
{{ archpage.c4type }}: {{ archpage.title }}
38+
</a>
39+
</li>
40+
{% endif %}
41+
{% endif %}
42+
{% endfor %}
43+
</ul>
44+
45+
<h2>Envelope Schema</h2>
46+
<iframe title="Envelope Schema {{page.title}}" src="{{ page.schema_envelope }}" width="100%" height="600px"></iframe>
47+
48+
<h2>Data Schema</h2>
49+
<iframe title="Data Schema {{page.title}}" src="{{ page.schema_data }}" width="100%" height="600px"></iframe>
50+
51+
{{ content }}

‎docs/architecture/c4/index.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
layout: page
2+
33
title: Digital Letters - C4 System Context
44
parent: Architecture
55
nav_order: 6
@@ -8,6 +8,8 @@ is_not_draft: false
88
last_modified_date: 2024-05-28
99
owner: Ross Buggins
1010
author: Ross Buggins
11+
diagrams: [c4context-digital-letters]
12+
events-raised: []
13+
events-consumed: []
14+
c4type: context
1115
---
12-
13-
{% include diagram.html title="c4context" %}

‎docs/architecture/c4/notifhir/digitalletters/callback/index.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
layout: page
2+
33
title: Letter Viewer Callbacks
44
parent: Digital Letter Viewer Services
55
nav_order: 8
@@ -8,4 +8,8 @@ is_not_draft: false
88
last_modified_date: 2024-05-28
99
owner: Ross Buggins
1010
author: Ross Buggins
11+
diagrams: []
12+
events-raised: []
13+
events-consumed: []
14+
c4type: code
1115
---

‎docs/architecture/c4/notifhir/digitalletters/index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
layout: page
2+
33
title: Digital Letter Viewer Services
44
parent: NotiFHIR
55
nav_order: 8
@@ -8,4 +8,7 @@ is_not_draft: false
88
last_modified_date: 2024-05-28
99
owner: Ross Buggins
1010
author: Ross Buggins
11+
diagrams: []
12+
events-raised: []
13+
events-consumed: []
1114
---

‎docs/architecture/c4/notifhir/eventbus/eventbridge/index.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
layout: page
2+
33
title: AWS Event Bridge
44
parent: Event Bus
55
nav_order: 3
@@ -8,6 +8,8 @@ is_not_draft: false
88
last_modified_date: 2025-10-15
99
owner: Ross Buggins
1010
author: Ross Buggins
11+
diagrams: []
12+
events-raised: []
13+
events-consumed: []
14+
c4type: code
1115
---
12-
13-
{% include diagram.html title="" %}

‎docs/architecture/c4/notifhir/eventbus/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
layout: page
2+
33
title: Event Bus
44
parent: NotiFHIR
55
nav_order: 3
@@ -8,7 +8,7 @@ is_not_draft: false
88
last_modified_date: 2025-10-16
99
owner: Ross Buggins
1010
author: Ross Buggins
11+
diagrams: []
12+
events-raised: []
13+
events-consumed: []
1114
---
12-
13-
14-
{% include diagram.html title="" %}

0 commit comments

Comments
 (0)