Skip to content

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 ab5fad4 commit 06b3fff
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Docsmith is a RESTful API, built using Node.js and the [Fastify](https://fastify

### Why Docsmith?

Docsmith was created out of a need for an open-source document conversion service at [Yeovil District Hospital NHS Foundation Trust](https://yeovilhospital.co.uk/).
Docsmith was created in my spare time, after identifying the need for an open-source document conversion service at [Yeovil District Hospital NHS Foundation Trust](https://yeovilhospital.co.uk/).

Being open-source, with the ability to be self-hosted, enables a data processor (i.e. an NHS trust) to confirm that a service is not storing and logging files with confidential patient identifiable data (PID) in them, which is essential for preventing potential GDPR breaches. This is something that the majority of existing closed-source document conversion services cannot offer. Docsmith was built to remedy this.

Before Docsmith, Yeovil District Hospital was using expensive black-box conversion tools that would regularly produce unreadable documents with issues such as text running off the page, paragraphs overlapping each other, and Windows-1252 to UTF-8 character encoding problems. GP surgeries in Somerset and Dorset would receive these corrupted documents through [MESH](https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh) and be unable to read them. This resulted in time and money wasted either posting or faxing them again, opening up the potential for further data breaches.

Docsmith enables a data processor to use a robust, GDPR-compliant, open-source document conversion service. In comparison with equivalents in the market today it completes this vital task at a fraction of the cost (free!), whilst also ensuring a higher level of security and privacy for the data subjects.
Docsmith enables a data processor to use a comprehensive, GDPR-compliant, open-source document conversion service. In comparison with equivalents in the market today it completes this vital task at a fraction of the cost (free!), whilst also ensuring a higher level of security and privacy for the data subjects.

## Prerequisites

Expand Down Expand Up @@ -75,7 +75,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 @@ -85,7 +85,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 @@ -79,7 +79,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 @@ -132,7 +132,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 06b3fff

Please sign in to comment.