Skip to content

Commit 7eb8fab

Browse files
masl2masl2
committed
CCM-11207: starting some structure
1 parent 2d3d128 commit 7eb8fab

File tree

15 files changed

+168
-9
lines changed

15 files changed

+168
-9
lines changed

‎.tool-versions‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ terraform-docs 0.19.0
99
trivy 0.61.0
1010
vale 3.6.0
1111
poetry 2.1.4
12+
dotnet 8.0.414
1213

1314
# ==============================================================================
1415
# The section below is reserved for Docker image versions.

‎docs/_config.yml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,17 @@
1818
# You can create any custom variable you would like, and they will be accessible
1919
# in the templates via {{ site.myvariable }}.
2020

21-
title: NHS Notify Repo Template
21+
title: NHS Notify Supplier API
2222
# email: [email protected]
2323
description: >- # this means to ignore newlines until "baseurl:"
24-
Repository Template documentation for the NHS Notify Platform.
24+
Onboarding and technical documentation for the NHS Notify Supplier API
2525
baseurl: "" # the subpath of your site, e.g. /blog
2626
url: "https://nhsdigital.github.io" # the base hostname & protocol for your site, e.g. http://example.com
2727

2828
collections_dir: collections
2929

3030
collections:
3131
notify-repos:
32-
output: true
3332
sort_by: order
3433

3534
# Build settings
@@ -47,13 +46,15 @@ mermaid:
4746
aux_links:
4847
"NHS Notify Repo Template on GitHub":
4948
- "//github.com/NHSDigital/nhs-notify-repository-template"
49+
"NHS Notify Supplier API":
50+
- "//github.com/NHSDigital/nhs-notify-supplier-api"
5051

5152
aux_links_new_tab: false
5253

5354
# Footer "Edit this page on GitHub" link text
5455
gh_edit_link: true # show or hide edit this page link
5556
gh_edit_link_text: "Edit this page on GitHub."
56-
gh_edit_repository: "https://github.com/NHSDigital/nhs-notify-repository-template" # the github URL for your repo
57+
gh_edit_repository: "https://github.com/NHSDigital/nhs-notify-repository-template/docs" # the github URL for your repo
5758
gh_edit_branch: "main" # the branch that your docs is served from
5859
# gh_edit_source: docs # the source that your files originate from
5960
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

‎docs/collections/_notify-repos/notify-core.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Notify Core
3+
link: https://github.com/NHSDigital/comms-mgr
4+
---
5+
<!-- markdownlint-disable MD041 -->
6+
The communication management core of NHS Notify. It provides message request and communications functionality via API and MESH.
7+
<!-- markdownlint-enable MD041 -->

‎docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
layout: page
66
title: Home
77
nav_order: 1
8-
description: Home
9-
summary: Home
8+
description: NHS Notify Supplier API Homepage
9+
summary: Supplier API Home
1010
is_not_draft: false
1111
last_modified_date: 2024-05-28
1212
owner: NHS Notify

‎docs/pages/integration-main.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Integration Guide
7+
nav_order: 3
8+
has_children: true
9+
description: Guidance for Integrating with the NHS Notify Supplier API
10+
summary: Supplier API Integration
11+
is_not_draft: false
12+
last_modified_date: 2025-010-02
13+
owner: NHS Notify
14+
author: Mark Slowey
15+
---
16+
17+
18+
Details about the onboarding process, broken down into subpages if applicable
19+
20+
[Integration Guide Confluence](https://nhsd-confluence.digital.nhs.uk/spaces/RIS/pages/1187357446/Letter+Supplier+API+-+Integration+Guide)

‎docs/pages/integration/acceptance-pack.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
parent: Integration Guide
7+
title: Conformance Pack
8+
nav_order: 1
9+
description: Acceptance Scenarios to Demonstrate API Integration
10+
summary: Acceptance Scenarios
11+
is_not_draft: false
12+
last_modified_date: 2025-010-02
13+
owner: NHS Notify
14+
author: Mark Slowey
15+
---
16+
17+
Scenario breakdowns for each area of the API

‎docs/pages/notify-repos.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: NHS Notify Repositories
7+
nav_order: 2
8+
description: A list of NHS Notify related repositories
9+
summary: NHS Notify Repositories
10+
is_not_draft: false
11+
last_modified_date: 2025-010-02
12+
owner: NHS Notify
13+
author: Mark Slowey
14+
---
15+
<!-- vale off -->
16+
{% for repo in site.notify-repos %}
17+
18+
- ### {{ repo.name }}
19+
20+
[{{ repo.link }}]({{ repo.link }})
21+
{{ repo.content }}
22+
{% endfor %}
23+
<!-- vale on -->

‎docs/pages/technical-docs/api-specification.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: API Specification
7+
nav_order: 2
8+
parent: Technical Documentation
9+
description: API Specification
10+
summary: API Specification
11+
is_not_draft: false
12+
last_modified_date: 2025-010-02
13+
owner: NHS Notify
14+
author: Mark Slowey
15+
---
16+
17+
<!-- vale off -->
18+
- Swagger Display
19+
- Redocly Display
20+
<!-- vale on -->

‎docs/pages/technical-docs/sdk.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
parent: Technical Documentation
7+
nav_order: 3
8+
title: Source Development Kits
9+
description: Details of the provided SDKs
10+
summary: SDKs
11+
is_not_draft: false
12+
last_modified_date: 2025-010-02
13+
owner: NHS Notify
14+
author: Mark Slowey
15+
---
16+
17+
- SDKs are generated using
18+
- Generating SDKs
19+
- What SDKs are made available
20+
- Latest versions of SDKs
21+
- Child page / snippets for each supported version

‎docs/pages/technical-docs/supplier-api-overview.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Supplier API Repository
7+
nav_order: 1
8+
parent: Technical Documentation
9+
description: Overview of the Supplier API Repository
10+
summary: Supplier API Repository
11+
is_not_draft: false
12+
last_modified_date: 2025-010-02
13+
owner: NHS Notify
14+
author: Mark Slowey
15+
---
16+
17+
- Workflows
18+
- Docs and these pages
19+
- Infrastructure
20+
- Typescript: Lambdas, Internal, Scripts
21+
- Lambdas
22+
- OAS Specification
23+
- proxygen-cli
24+
- SDKs
25+
- Sandbox

0 commit comments

Comments
 (0)