generated from NHSDigital/nhs-notify-repository-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from NHSDigital/RossBugginsNHS-patch-1
Symlink readme so it uses the docs and will be same as static site generated docs.
- Loading branch information
Showing
5 changed files
with
146 additions
and
79 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # NHS Notify Code Owners | ||
|
|
||
| * @rossbugginsnhs @m-houston @edmundcraske2-nhs @timireland | ||
|
|
||
| # Default protection for codeowners, must be last in file. | ||
| /.github/CODEOWNERS @NHSDigital/nhs-notify-code-owners | ||
| /CODEOWNERS @NHSDigital/nhs-notify-code-owners | ||
|
|
||
|
|
||
| # Each NHS Notify repository should have clear code owners set. | ||
| # Do not use GitHub team names, instead use the GitHub usernames | ||
| # of the people who are responsible for the code maintenance. | ||
|
|
||
| # This is a comment. | ||
| # Each line is a file pattern followed by one or more owners. | ||
|
|
||
| # These owners will be the default owners for everything in | ||
| # the repo. Unless a later match takes precedence, | ||
| # @global-owner1 and @global-owner2 will be requested for | ||
| # review when someone opens a pull request. | ||
| # * @global-owner1 @global-owner2 | ||
|
|
||
| # Order is important; the last matching pattern takes the most | ||
| # precedence. When someone opens a pull request that only | ||
| # modifies JS files, only @js-owner and not the global | ||
| # owner(s) will be requested for a review. | ||
| # *.js @js-owner #This is an inline comment. | ||
|
|
||
| # You can also use email addresses if you prefer. They'll be | ||
| # used to look up users just like we do for commit author | ||
| # emails. | ||
| # *.go [email protected] | ||
|
|
||
| # Teams can be specified as code owners as well. Teams should | ||
| # be identified in the format @org/team-name. Teams must have | ||
| # explicit write access to the repository. In this example, | ||
| # the octocats team in the octo-org organization owns all .txt files. | ||
| # *.txt @octo-org/octocats | ||
|
|
||
| # In this example, @doctocat owns any files in the build/logs | ||
| # directory at the root of the repository and any of its | ||
| # subdirectories. | ||
| # /build/logs/ @doctocat | ||
|
|
||
| # The `docs/*` pattern will match files like | ||
| # `docs/getting-started.md` but not further nested files like | ||
| # `docs/build-app/troubleshooting.md`. | ||
| # docs/* [email protected] | ||
|
|
||
| # In this example, @octocat owns any file in an apps directory | ||
| # anywhere in your repository. | ||
| # apps/ @octocat | ||
|
|
||
| # In this example, @doctocat owns any file in the `/docs` | ||
| # directory in the root of your repository and any of its | ||
| # subdirectories. | ||
| # /docs/ @doctocat | ||
|
|
||
| # In this example, any change inside the `/scripts` directory | ||
| # will require approval from @doctocat or @octocat. | ||
| # /scripts/ @doctocat @octocat | ||
|
|
||
| # In this example, @octocat owns any file in a `/logs` directory such as | ||
| # `/build/logs`, `/scripts/logs`, and `/deeply/nested/logs`. Any changes | ||
| # in a `/logs` directory will require approval from @octocat. | ||
| # **/logs @octocat | ||
|
|
||
| # In this example, @octocat owns any file in the `/apps` | ||
| # directory in the root of your repository except for the `/apps/github` | ||
| # subdirectory, as its owners are left empty. | ||
| # /apps/ @octocat | ||
| # /apps/github | ||
|
|
||
| # In this example, @octocat owns any file in the `/apps` | ||
| # directory in the root of your repository except for the `/apps/github` | ||
| # subdirectory, as this subdirectory has its own owner @doctocat | ||
| # /apps/ @octocat | ||
| # /apps/github @doctocat |
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 @@ | ||
| ../docs/README.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,80 +1,3 @@ | ||
| # NHS Notify | ||
|
|
||
| [](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml) | ||
|
|
||
| NHS Notify - for the NHS Notify web site, onboarding guidance, and customer support, please visit the [NHS Service Catalogue](https://digital.nhs.uk/services/nhs-notify). | ||
|
|
||
| ## Who/what is this repository is for? | ||
|
|
||
| - NHS Developers working on NHS Notify | ||
| - Those who are interested in NHS Notify architecture and how it is developed. | ||
|
|
||
| ## Who/what is this repository not for? | ||
|
|
||
| - Customer Support | ||
| - Supplier Support | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [NHS Notify](#nhs-notify) | ||
| - [Who/what is this repository is for?](#whowhat-is-this-repository-is-for) | ||
| - [Who/what is this repository not for?](#whowhat-is-this-repository-not-for) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Documentation](#documentation) | ||
| - [Setup](#setup) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Configuration](#configuration) | ||
| - [Usage](#usage) | ||
| - [Design](#design) | ||
| - [Diagrams](#diagrams) | ||
| - [Modularity](#modularity) | ||
| - [Contributing](#contributing) | ||
| - [Contacts](#contacts) | ||
| - [Licence](#licence) | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Built](https://nhsdigital.github.io/nhs-notify/) | ||
| - [Source](/docs/README.md) | ||
|
|
||
| ## Setup | ||
|
|
||
| Clone the repository | ||
|
|
||
| ```shell | ||
| git clone https://github.com/NHSDigital/nhs-notify.git | ||
| cd nhs-notify | ||
| code project.code-workspace | ||
| ``` | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| ### Configuration | ||
|
|
||
| ## Usage | ||
|
|
||
| ## Design | ||
|
|
||
| ### Diagrams | ||
|
|
||
| The [C4 model](https://c4model.com/) is a simple and intuitive way to create software architecture diagrams that are clear, consistent, scalable and most importantly collaborative. This should result in documenting all the system interfaces, external dependencies and integration points. | ||
|
|
||
|  | ||
|
|
||
| ### Modularity | ||
|
|
||
| Most of the projects are built with customisability and extendability in mind. At a minimum, this can be achieved by implementing service level configuration options and settings. The intention of this section is to show how this can be used. If the system processes data, you could mention here for example how the input is prepared for testing - anonymised, synthetic or live data. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like | ||
|
|
||
| - Environment setup for contribution, i.e. `CONTRIBUTING.md` | ||
|
|
||
| ## Contacts | ||
|
|
||
| ## Licence | ||
|
|
||
| Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. | ||
|
|
||
| Any HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/). | ||
| [Docs](docs/README.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,6 +1,70 @@ | ||
| # Documentation Home Page | ||
| # NHS Notify Documentation | ||
|
|
||
| [](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml) | ||
|
|
||
| NHS Notify - for the NHS Notify web site, onboarding guidance, and customer support, please visit the [NHS Service Catalogue](https://digital.nhs.uk/services/nhs-notify). | ||
|
|
||
| ## Related Repos | ||
|
|
||
| - [nhs-notify](https://nhsdigital.github.io/nhs-notify) | ||
| - [nhs-notify-dns](https://nhsdigital.github.io/nhs-notify-dns) | ||
|
|
||
| ## Who/what is this repository is for? | ||
|
|
||
| - NHS Developers working on NHS Notify | ||
| - Those who are interested in NHS Notify architecture and how it is developed. | ||
|
|
||
| ## Who/what is this repository not for? | ||
|
|
||
| - Customer Support | ||
| - Supplier Support | ||
|
|
||
| ## What this repo contains | ||
|
|
||
| - High level developer documentation for source code location, and build process. | ||
| - Acts as the "root" for all separate public NHS Notify repositories. | ||
|
|
||
| ## What this repo does not contain | ||
|
|
||
| - Any configuration of details of the Deployment phases or infrastructure of the NHS Notify Platform. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [NHS Notify Documentation](#nhs-notify-documentation) | ||
| - [Related Repos](#related-repos) | ||
| - [Who/what is this repository is for?](#whowhat-is-this-repository-is-for) | ||
| - [Who/what is this repository not for?](#whowhat-is-this-repository-not-for) | ||
| - [What this repo contains](#what-this-repo-contains) | ||
| - [What this repo does not contain](#what-this-repo-does-not-contain) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Documentation](#documentation) | ||
| - [Setup](#setup) | ||
| - [Contributing](#contributing) | ||
| - [Licence](#licence) | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Built](https://nhsdigital.github.io/nhs-notify/) | ||
| - [Source](/docs/README.md) | ||
|
|
||
| ## Setup | ||
|
|
||
| Clone the repository | ||
|
|
||
| ```shell | ||
| git clone https://github.com/NHSDigital/nhs-notify.git | ||
| cd nhs-notify | ||
| code project.code-workspace | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like | ||
|
|
||
| - Environment setup for contribution, i.e. `CONTRIBUTING.md` | ||
|
|
||
| ## Licence | ||
|
|
||
| Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. | ||
|
|
||
| Any HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/). |
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 |
|---|---|---|
|
|
@@ -15,3 +15,4 @@ idempotence | |
| onboarding | ||
| toolchain | ||
| [A-Z]+s | ||
| repo | ||