Merge pull request #780 from ministryofjustice/ag--doc-moar-documenta…

…tion

Documentation: More details

README.md

@@ -19,8 +19,8 @@ machine](doc/running.md).
 
 ## Deployment
 
-Commits to the protected `master` branch will trigger a Concourse CI pipeline which will deploy the changes to our `dev` environment.
-Versioned Github releases will trigger another pipeline and deploy to our `alpha` environment.
+Commits to the protected `master` branch will trigger a [Concourse CI pipeline](https://concourse.services.dev.mojanalytics.xyz/teams/admin/pipelines/cpanel-api) which will deploy the changes to our `dev` environment.
+Versioned Github releases will trigger [another pipeline](https://concourse.services.alpha.mojanalytics.xyz/teams/admin/pipelines/cpanel-api) and deploy to our `alpha` environment.
 
 
 ## Documentation

doc/environment.md

@@ -19,11 +19,9 @@
 | `ELASTICSEARCH_USERNAME` | | |
 | `ENABLE_*` | See [Feature flags](feature-flags.md) | |
 | `ENV` | Environment name - either `dev` or `alpha` | `dev` |
-| `GITHUB_ORGS` | Comma-separated list of Github organisations searched for
-webapp repositories |
+| `GITHUB_ORGS` | Comma-separated list of Github organisations searched for webapp repositories |
 | `K8S_WORKER_ROLE_NAME` | the name of the IAM role assigned to Kubernetes nodes, e.g. `nodes.dev.mojanalytics.xyz`. Combined with the ARN base to generate a full ARN like `arn:aws:iam::123456789012:role/nodes.dev.mojanalytics.xyz` | |
-| `LOG_LEVEL` | The level of logging output - in increasing levels of verbosity:
-`DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` | `DEBUG` |
+| `LOG_LEVEL` | The level of logging output - in increasing levels of verbosity: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` | `DEBUG` |
 | `LOGS_BUCKET_NAME` | Name of S3 bucket where logs are stored | `moj-analytics-s3-logs` |
 | `NFS_HOSTNAME` | Hostname of NFS server for user homes | |
 | `OIDC_AUTH_EXTENSION_URL` | Base URL of Auth0 authorization API | |

doc/errors.md

@@ -3,7 +3,7 @@
 
     Error: file "mojanalytics/rstudio" not found
 
-It ran a Helm command but it can't find the chart. See [Helm set-up](helm.md).
+It ran a Helm command but it can't find the chart. See [Helm set-up](running.md#helm).
 
 ---
 

doc/frontend.md

@@ -7,14 +7,12 @@ interface for superusers to manage other users.
 
 ## Contributing
 
-### GOV.UK Frontend
+### Design System
 
-The Frontend app makes use of the
-[GOV.UK Frontend](https://design-system.service.gov.uk/get-started/production/)
-design system to markup and style the web interface.
+The Frontend app makes use of the [GOV.UK Frontend Design System](https://design-system.service.gov.uk/get-started/production/) and the [Ministry of Justice Design System](https://github.com/ministryofjustice/moj-design-system)  to markup and style the web interface.
 
-We install GOV.UK Frontend using npm, to easily track updated releases. The npm
-package is automatically installed as part of the Docker image build.
+We install the design systems using npm, to easily track updated releases. The npm
+packages are automatically installed as part of the Docker image build.
 
 We use the SASS styles and Javascript sources directly, but because the Nunjucks
 templates are not entirely compatible with Jinja2, we cannot use them (although

doc/running.md

@@ -15,7 +15,9 @@ pip3 install -r requirements.txt
 
 ## Kubernetes setup
 
-You need a kubeconfig (~/.kube/config) with the credentials for your k8s cluster. Once you've got that, this should work:
+You need a kubeconfig file (`~/.kube/config`) with the credentials for your kubernetes cluster.
+
+Once you've got that, this should work:
 ```sh
 kubectl cluster-info
 ```