Skip to content

Commit 6de2fdc

Browse files
Merge pull request #1 from NHSDigital/home-page
Update home page.
2 parents 1126d2b + e5c927c commit 6de2fdc

7 files changed

+35
-209
lines changed
+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# See:
2+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
3+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
4+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms
5+
6+
name: 🔧 Not In Use
7+
description: Not currently in use
8+
labels: ["blackhole"]
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Currently these are not monitored and will goto a blackhole.

.github/ISSUE_TEMPLATE/1_support_request.yaml

-52
This file was deleted.

.github/ISSUE_TEMPLATE/2_feature_request.yaml

-42
This file was deleted.

.github/ISSUE_TEMPLATE/3_bug_report.yaml

-63
This file was deleted.

.vscode/settings.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@
33
"MD013": false,
44
"MD024": { "siblings_only": true },
55
"MD033": false
6-
}
6+
},
7+
"cSpell.words": [
8+
"Licence"
9+
]
710
}

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing
2+
3+
NHS Notify is in the process of migrating to public git hub repositories.
4+
5+
At present we are not accepting contributions during this phase. public Issues / Support / Tickets should not be raised through GitHub.

README.md

+13-51
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# NHS Notify
22

3-
[![CI/CD Pull Request](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml)
4-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=repository-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=repository-template)
3+
[![CI/CD Pull Request](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml)
54

6-
Start with an overview or a brief description of what the project is about and what it does. For example -
5+
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).
76

8-
Welcome to our repository template designed to streamline your project setup! This robust template provides a reliable starting point for your new projects, covering an essential tech stack and encouraging best practices in documenting.
7+
## Who/what is this repository is for?
98

10-
This repository template aims to foster a user-friendly development environment by ensuring that every included file is concise and adequately self-documented. By adhering to this standard, we can promote increased clarity and maintainability throughout your project's lifecycle. Bundled within this template are resources that pave the way for seamless repository creation. Currently supported technologies are:
9+
- NHS Developers working on NHS Notify
10+
- Those who are interested in NHS Notify architecture and how it is developed.
1111

12-
- Terraform
13-
- Docker
12+
## Who/what is this repository not for?
1413

15-
Make use of this repository template to expedite your project setup and enhance your productivity right from the get-go. Enjoy the advantage of having a well-structured, self-documented project that reduces overhead and increases focus on what truly matters - coding!
14+
- Customer Support
15+
- Supplier Support
1616

1717
## Table of Contents
1818

1919
- [NHS Notify](#nhs-notify)
20+
- [Who/what is this repository is for?](#whowhat-is-this-repository-is-for)
21+
- [Who/what is this repository not for?](#whowhat-is-this-repository-not-for)
2022
- [Table of Contents](#table-of-contents)
2123
- [Documentation](#documentation)
2224
- [Setup](#setup)
2325
- [Prerequisites](#prerequisites)
2426
- [Configuration](#configuration)
2527
- [Usage](#usage)
26-
- [Testing](#testing)
2728
- [Design](#design)
2829
- [Diagrams](#diagrams)
2930
- [Modularity](#modularity)
@@ -38,51 +39,20 @@ Make use of this repository template to expedite your project setup and enhance
3839

3940
## Setup
4041

41-
By including preferably a one-liner or if necessary a set of clear CLI instructions we improve user experience. This should be a frictionless installation process that works on various operating systems (macOS, Linux, Windows WSL) and handles all the dependencies.
42-
4342
Clone the repository
4443

4544
```shell
46-
git clone https://github.com/nhs-england-tools/repository-template.git
47-
cd nhs-england-tools/repository-template
45+
git clone https://github.com/NHSDigital/nhs-notify.git
46+
cd nhs-notify
47+
code project.code-workspace
4848
```
4949

5050
### Prerequisites
5151

52-
The following software packages, or their equivalents, are expected to be installed and configured:
53-
54-
- [Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/),
55-
- [asdf](https://asdf-vm.com/) version manager,
56-
- [GNU make](https://www.gnu.org/software/make/) 3.82 or later,
57-
- [GNU coreutils](https://www.gnu.org/software/coreutils/) and [GNU binutils](https://www.gnu.org/software/binutils/) may be required to build dependencies like Python, which may need to be compiled during installation. For macOS users, this has been scripted and automated by the `dotfiles` project; please see this [script](https://github.com/nhs-england-tools/dotfiles/blob/main/assets/20-install-base-packages.macos.sh) for details,
58-
- [Python](https://www.python.org/) required to run Git hooks,
59-
- [`jq`](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor.
60-
61-
> [!NOTE]<br>
62-
> The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain `make` tasks will fail. On macOS, you will need [Homebrew](https://brew.sh/) installed, then to install `make`, like so:
63-
>
64-
> ```shell
65-
> brew install make
66-
> ```
67-
>
68-
> You will then see instructions to fix your `$PATH` variable to make the newly installed version available. If you are using [dotfiles](https://github.com/nhs-england-tools/dotfiles), this is all done for you.
69-
7052
### Configuration
7153

72-
Installation and configuration of the toolchain dependencies
73-
74-
```shell
75-
make config
76-
```
77-
7854
## Usage
7955

80-
After a successful installation, provide an informative example of how this project can be used. Additional code snippets, screenshots and demos work well in this space. You may also link to the other documentation resources, e.g. the [User Guide](./docs/user-guide.md) to demonstrate more use cases and to show more features.
81-
82-
### Testing
83-
84-
There are `make` tasks for you to configure to run your tests. Run `make test` to see how they work. You should be able to use the same entry points for local development as in your CI pipeline.
85-
8656
## Design
8757

8858
### Diagrams
@@ -100,19 +70,11 @@ Most of the projects are built with customisability and extendability in mind. A
10070
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
10171

10272
- Environment setup for contribution, i.e. `CONTRIBUTING.md`
103-
- Coding standards, branching, linting, practices for development and testing
104-
- Release process, versioning, changelog
105-
- Backlog, board, roadmap, ways of working
106-
- High-level requirements, guiding principles, decision records, etc.
10773

10874
## Contacts
10975

110-
Provide a way to contact the owners of this project. It can be a team, an individual or information on the means of getting in touch via active communication channels, e.g. opening a GitHub discussion, raising an issue, etc.
111-
11276
## Licence
11377

114-
> The [LICENCE.md](./LICENCE.md) file will need to be updated with the correct year and owner
115-
11678
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
11779

11880
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/).

0 commit comments

Comments
 (0)