Skip to content

Commit

Permalink
Merge branch 'main' into alyo2-lambda-vs-containers
Browse files Browse the repository at this point in the history
  • Loading branch information
regularfry authored Oct 30, 2024
2 parents 5e1d4c9 + 811d685 commit e290c73
Show file tree
Hide file tree
Showing 25 changed files with 263 additions and 456 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/markdown-check-links.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"aliveStatusCodes": [200, 403],
"timeout": "20s"
"timeout": "30s"
}
4 changes: 2 additions & 2 deletions .github/workflows/markdown-check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: gaurav-nelson/github-action-markdown-link-check@9710f0fec812ce0a3b98bef4c9d842fc1f39d976 # 1.0.13
- uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec # 1.0.15
with:
use-quiet-mode: 'yes'
use-quiet-mode: "yes"
config-file: .github/workflows/markdown-check-links.json
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Thank you for your interest in improving the framework.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

The framework is concerned with engineering best practice at NHSD, however, operational matters (e.g. structure of teams, roles and responsibilities, etc.) are out of scope. Please consider this when adding new content, and if in doubt, any of the code owners will be more than happy to discuss.
The framework is concerned with engineering best practice, however, operational matters (e.g. structure of teams, roles and responsibilities, etc.) are out of scope. Please consider this when adding new content, and if in doubt, any of the code owners will be more than happy to discuss.

If you're new to Github and/or Markdown, Github's own [contributor's guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md) provides good signposting on these topics.
If you're new to Github and/or Markdown, Github's own [contributor's guide](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) provides good signposting on these topics.

## Using issues

Expand All @@ -23,6 +23,7 @@ When committing your changes, please reference the issue they're resolving, so i
* Preview your Markdown code to make sure the format is not broken.
* Check grammar, spelling and punctuation, no one wants to look pedantic by requesting changes due to typos or inconsistent grammar/syntax, but it's only fair to keep this tidy.
* The framework is open to the world. This has a few implications:
* Nothing in it should be confidential, private to NHSD or include any personal data.
* Nothing in it should be confidential, private to NHSE or include any personal data.
* All links in framework pages should be public.
* Consider comments and Readme text: comments in open source repos such as this are not official communications and don't go through the normal approval process for public communication. They can however still be interpreted as official communication, even if not intended as such. For further details please see ["Consider comments and Readme text" in "Create knowledge"](principles.md#3-create-knowledge)
* Use [inclusive language](inclusive-language.md): avoid terms which cause hurt and offence, including if they have historically been considered industry-standard terms.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,14 @@ The philosophy underpinning this framework advocates:
The framework is a companion to:

* The [NHS service standard](https://service-manual.nhs.uk/service-standard), with cross-references in this format: [SERVICE-RELIABILITY](https://service-manual.nhs.uk/service-standard/14-operate-a-reliable-service)
* The [NHS Digital architectural principles](https://digital.nhs.uk/about-nhs-digital/our-work/nhs-digital-architecture/principles), with cross-references in this format: [ARCHITECTURE-SECURITY](https://digital.nhs.uk/about-nhs-digital/our-work/nhs-digital-architecture/principles/adopt-appropriate-cyber-security-standards)
* The [NHS Digital architectural principles](https://digital.nhs.uk/about-nhs-digital/our-work/nhs-digital-architecture/principles), with cross-references in this format: [ARCHITECTURE-SECURITY](https://digital.nhs.uk/developer/architecture/principles/adopt-appropriate-cyber-security-standards)

## Contents

The framework consists of:

* [Engineering principles](principles.md)
* [Engineering principles](principles.md) and [blueprints](blueprints.md)
* [Engineering quality review tool](insights/review.md)
* [Communities of practice guidelines](communities/communities-of-practice.md) and active communities:
* [Product Development Test Automation Working Group](communities/pd-test-automation-working-group.md)
* [Product Development Engineering CoP](communities/pd-engineering-cop.md)
* [Product Development Cloud PaaS Working Group](communities/pd-cloud-working-group.md)
* [Secure Engineering CoP](communities/security-cop.md)
* Guidance on how to practice [continuous improvement](continuous-improvement.md)

## Contributing
Expand Down
14 changes: 14 additions & 0 deletions blueprints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Engineering blueprints

This is a list of blueprint solutions to common problems which are referenced within this [quality framework](README.md).

Where possible this will be a set of fully working components / solutions you can use. Where that's not possible, it will be instructions.

| Topic | Type of blueprint | Classification | Status |
| :--------------------------------------------------------------------------------------- | :---------------- | :------------- | :--------- |
| [Creating GitHub repositories](https://github.com/nhs-england-tools/repository-template) | Full solution | Recommended | Published |
| [Purging commits on GitHub](practices/guides/commit-purge.md) | Instructions | Mandatory | Published |
| [Signing commits on GitHub](practices/guides/commit-signing.md) | Instructions | Recommended | Published |
| [Automating performance-test decisions using APDEX](practices/performance-testing.md) | Instructions | Recommended | Published |
| [Scanning source code for secrets](tools/nhsd-git-secrets/README.md) | Full solution | Recommended | Published |
| Cross-account backups on AWS | Instructions | In progress | Draft |
Loading

0 comments on commit e290c73

Please sign in to comment.