Docs: [AEA-0000] - update readme to include github pages notes (#54)

## Summary

- Routine Change

### Details

- update readme.md to include github pages instructions
- do not deploy to prod like environments to get a green build

Author: anthony-nhs

.github/workflows/release.yml

@@ -160,45 +160,3 @@ jobs:
       LOG_RETENTION_DAYS: 30
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.QA_CLOUD_FORMATION_DEPLOY_ROLE }}
-
-  release_int:
-    needs: [tag_release, release_qa, package_code, get_commit_id]
-    uses: ./.github/workflows/sam_release_code.yml
-    with:
-      ARTIFACT_BUCKET_PREFIX: ${{needs.tag_release.outputs.spec_version}}
-      STACK_NAME: fhir-validator
-      TARGET_ENVIRONMENT: int
-      BUILD_ARTIFACT: packaged_code
-      VERSION_NUMBER: ${{needs.tag_release.outputs.spec_version}}
-      COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}
-      LOG_LEVEL: INFO
-      LOG_RETENTION_DAYS: 30
-      CREATE_INT_RELEASE_NOTES: true
-      CREATE_INT_RC_RELEASE_NOTES: true
-    secrets:
-      CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.INT_CLOUD_FORMATION_DEPLOY_ROLE }}
-      DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
-      INT_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.INT_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
-      PROD_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.PROD_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
-      DEV_CLOUD_FORMATION_EXECUTE_LAMBDA_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_EXECUTE_LAMBDA_ROLE }}
-
-  release_prod:
-    needs: [tag_release, release_int, package_code, get_commit_id]
-    uses: ./.github/workflows/sam_release_code.yml
-    with:
-      ARTIFACT_BUCKET_PREFIX: ${{needs.tag_release.outputs.spec_version}}
-      STACK_NAME: fhir-validator
-      TARGET_ENVIRONMENT: prod
-      BUILD_ARTIFACT: packaged_code
-      VERSION_NUMBER: ${{needs.tag_release.outputs.spec_version}}
-      COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}
-      LOG_LEVEL: INFO
-      LOG_RETENTION_DAYS: 731
-      MARK_JIRA_RELEASED: true
-      CREATE_PROD_RELEASE_NOTES: true
-    secrets:
-      CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.PROD_CLOUD_FORMATION_DEPLOY_ROLE }}
-      DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
-      INT_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.INT_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
-      PROD_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.PROD_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
-      DEV_CLOUD_FORMATION_EXECUTE_LAMBDA_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_EXECUTE_LAMBDA_ROLE }}

README.md

@@ -1,9 +1,14 @@
 # eps-FHIR-validator-lambda
 
 ![Build](https://github.com/NHSDigital/eps-FHIR-validator-lambda/actions/workflows/ci.yml/badge.svg?branch=main)   
-Release history can be found ot https://github.com/NHSDigital/eps-FHIR-validator-lambda/releases. Descriptions for the types of changes in a release can be found in the [contributing guidelines](./CONTRIBUTING.md)   
+![Release](https://github.com/NHSDigital/eps-FHIR-validator-lambda/actions/workflows/release.yml/badge.svg?branch=main)   
+
+## Versions and deployments
+Version release history can be found ot https://github.com/NHSDigital/eps-FHIR-validator-lambda/releases.   
+We use eslint convention for commit messages for commits to main branch. Descriptions for the types of changes in a release can be found in the [contributing guidelines](./CONTRIBUTING.md)   
 Deployment history can be found at https://nhsdigital.github.io/eps-FHIR-validator-lambda/
 
+## Introduction
 This contains a cloud formation stack which contains a lambda which can be used to validate FHIR R4 messages against implementation guides on [Simplifier](https://simplifier.net/).
 
 - `scripts/` Utilities helpful to developers of this specification.
@@ -149,6 +154,7 @@ There are `make` commands that are run as part of the CI pipeline and help alias
 
 - `install-python` installs python dependencies
 - `install-hooks` installs git pre commit hooks
+- `install-node` installs node dependencies
 - `install` runs all install targets
 
 #### SAM targets
@@ -207,4 +213,12 @@ A combination of these checks are also run in CI.
 ### Github pages
 
 We use github pages to display deployment information. The source for github pages is in the gh-pages branch.   
-As part of the ci and release workflows, the release tag (either the short commit SHA or release tag) is appended to _data/{environment}_releases.csv so we have a history of releases and replaced in _data/{environment}_latest.csv so we now what the latest released version is
+As part of the ci and release workflows, the release tag (either the short commit SHA or release tag) is appended to _data/{environment}_releases.csv so we have a history of releases and replaced in _data/{environment}_latest.csv so we now what the latest released version is.   
+There are different makefile targets in this branch. These are
+- `run-jekyll` - runs the site locally so changes can be previewed during development
+- `sync-main` - syncs common files from main branch to gh-pages branch. You must commit and push after running this
+- `install-python` installs python dependencies
+- `install-hooks` installs git pre commit hooks
+- `install-node` installs node dependencies
+- `install-jekyll` installs dependencies to be able to run jekyll locally
+- `install` runs all install targets