Skip to content

Commit

Permalink
docs home page
Browse files Browse the repository at this point in the history
  • Loading branch information
RossBugginsNHS committed May 30, 2024
1 parent 6bea313 commit c0566fc
Showing 1 changed file with 2 additions and 102 deletions.
104 changes: 2 additions & 102 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,106 +7,6 @@ title: Home
nav_order: 1
---

[![CI/CD Pull Request](https://github.com/NHSDigital/nhs-notify/actions/workflows/jekyll-gh-pages.yml/badge.svg)](https://github.com/NHSDigital/nhs-notify/actions/workflows/jekyll-gh-pages.yml)
[![CI/CD Pull Request](https://github.com/NHSDigital/nhs-notify-repository-template/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/NHSDigital/nhs-notify-repository-template/actions/workflows/cicd-1-pull-request.yaml)

## NHS Notify Technical Developer Documentation

> Please visit the [NHS Service Catalogue](https://digital.nhs.uk/services/nhs-notify) for:
>
> - NHS Notify web site.
> - Onboarding guidance.
> - Customer support.
> - Supplier support.
>
> ### 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 actively 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.
> - Information about the NHS England hosted NHS Notify platform
>
## Table of Contents

- [NHS Notify Technical Developer Documentation](#nhs-notify-technical-developer-documentation)
- [Table of Contents](#table-of-contents)
- [Related Repos](#related-repos)
- [Documentation](#documentation)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [Licence](#licence)

## Related Repos

- [nhs-notify](https://nhsdigital.github.io/nhs-notify)
- [nhs-notify-dns](https://nhsdigital.github.io/nhs-notify-dns)

## 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

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 (including pre-git hooks).
```shell
make config
```
## 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/).
## NHS Notify Template Repository Documentation Home Page

0 comments on commit c0566fc

Please sign in to comment.