Skip to content
This repository has been archived by the owner on Jan 28, 2024. It is now read-only.

Commit

Permalink
docs: grammar and clarity fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Jan 4, 2023
1 parent 938bd0a commit 6570cba
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The service should be up and running on the port set in the config. You should s
}
```

To quickly test it, use [Insomnia](https://insomnia.rest/) and import the example requests from `./test_resources/insomnia_test_requests.json`.
To test it, use [Insomnia](https://insomnia.rest/) and import the example requests from `./test_resources/insomnia_test_requests.json`.

### Deploying Using Docker

Expand All @@ -95,7 +95,7 @@ This requires [Docker](https://docker.com) installed.

### Deploying Using PM2

If you are unable to deploy this into production using Docker, it is recommended that you use a process manager such as [PM2](https://pm2.keymetrics.io/).
If you cannot deploy this into production using Docker, use a process manager such as [PM2](https://pm2.keymetrics.io/).

1. Run `npm ci --ignore-scripts --omit=dev` to install dependencies
2. Run `npm i -g pm2` to install pm2 globally
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/shared-schemas/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const S = require("fluent-json-schema");

/**
* @author Frazer Smith
* @description Plugin that adds collection of shared schemas for re-use throughout server.
* @description Plugin that adds a collection of shared schemas for re-use throughout the server.
* @param {object} server - Fastify instance.
*/
async function plugin(server) {
Expand Down
2 changes: 1 addition & 1 deletion src/routes/admin/healthcheck/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const accepts = ["text/plain"];
/**
* @author Frazer Smith
* @description Sets routing options for server for healthcheck endpoint.
* This is used by monitoring software to poll and confirm the API is running,
* Monitoring software polls this to confirm the API is running,
* so needs no authentication.
* @param {object} server - Fastify instance.
* @param {object} options - Route config values.
Expand Down
4 changes: 2 additions & 2 deletions src/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ async function plugin(server, config) {
// Register routes
await server
/**
* `x-xss-protection` and `content-security-policy` is set by default by Helmet.
* Helmet sets `x-xss-protection` and `content-security-policy` by default.
* These are only useful for HTML/XML content; the only CSP directive that
* is of use to other content is "frame-ancestors 'none'" to stop responses
* from being wrapped in iframes and used for clickjacking attacks
Expand Down Expand Up @@ -167,7 +167,7 @@ async function plugin(server, config) {

/**
* Encapsulate the docs routes into a child context, so that the
* CSP can be relaxed, and cache enabled, without impacting
* CSP can be relaxed, and cache enabled, without affecting
* security of other routes
*/
.register(async (publicContext) => {
Expand Down

0 comments on commit 6570cba

Please sign in to comment.