Skip to content

Commit

Permalink
Merge pull request #1 from NHSDigital/home-page
Browse files Browse the repository at this point in the history
Update home page.
  • Loading branch information
RossBugginsNHS authored May 16, 2024
2 parents 1126d2b + e5c927c commit 6de2fdc
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 209 deletions.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/1_not_in_use.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# See:
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms

name: 🔧 Not In Use
description: Not currently in use
labels: ["blackhole"]
body:
- type: markdown
attributes:
value: |
Currently these are not monitored and will goto a blackhole.
52 changes: 0 additions & 52 deletions .github/ISSUE_TEMPLATE/1_support_request.yaml

This file was deleted.

42 changes: 0 additions & 42 deletions .github/ISSUE_TEMPLATE/2_feature_request.yaml

This file was deleted.

63 changes: 0 additions & 63 deletions .github/ISSUE_TEMPLATE/3_bug_report.yaml

This file was deleted.

5 changes: 4 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,8 @@
"MD013": false,
"MD024": { "siblings_only": true },
"MD033": false
}
},
"cSpell.words": [
"Licence"
]
}
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Contributing

NHS Notify is in the process of migrating to public git hub repositories.

At present we are not accepting contributions during this phase. public Issues / Support / Tickets should not be raised through GitHub.
64 changes: 13 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
# NHS Notify

[![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)
[![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)
[![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)

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

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.
## Who/what is this repository is for?

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:
- NHS Developers working on NHS Notify
- Those who are interested in NHS Notify architecture and how it is developed.

- Terraform
- Docker
## Who/what is this repository not for?

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!
- 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)
- [Testing](#testing)
- [Design](#design)
- [Diagrams](#diagrams)
- [Modularity](#modularity)
Expand All @@ -38,51 +39,20 @@ Make use of this repository template to expedite your project setup and enhance

## Setup

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.

Clone the repository

```shell
git clone https://github.com/nhs-england-tools/repository-template.git
cd nhs-england-tools/repository-template
git clone https://github.com/NHSDigital/nhs-notify.git
cd nhs-notify
code project.code-workspace
```

### Prerequisites

The following software packages, or their equivalents, are expected to be installed and configured:

- [Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/),
- [asdf](https://asdf-vm.com/) version manager,
- [GNU make](https://www.gnu.org/software/make/) 3.82 or later,
- [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,
- [Python](https://www.python.org/) required to run Git hooks,
- [`jq`](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor.

> [!NOTE]<br>
> 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:
>
> ```shell
> brew install make
> ```
>
> 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.
### Configuration

Installation and configuration of the toolchain dependencies
```shell
make config
```
## Usage

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.

### Testing

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.

## Design

### Diagrams
Expand All @@ -100,19 +70,11 @@ Most of the projects are built with customisability and extendability in mind. A
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`
- Coding standards, branching, linting, practices for development and testing
- Release process, versioning, changelog
- Backlog, board, roadmap, ways of working
- High-level requirements, guiding principles, decision records, etc.

## Contacts

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.

## Licence

> The [LICENCE.md](./LICENCE.md) file will need to be updated with the correct year and owner
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/).

0 comments on commit 6de2fdc

Please sign in to comment.