minor documentation updates

* minor documentation updates

* minor documentation updates

* minor documentation updates

Author: tom-halpin

.wordlist.txt

@@ -3,6 +3,7 @@ Changelog
 CHANGELOG
 CRA
 Dbased
+dev
 Dockerfile
 dockerized
 dxc

CHANGELOG.md

@@ -5,8 +5,10 @@ All notable changes to the Sequences As Code (SaC) project will be documented in
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.0] - 2020-07-30
+## [1.0.1] - 2020-08-05
+
+- Minor documentation updates
 
-### Added
+## [1.0.0] - 2020-07-30
 
 - Initial version

CONTRIBUTING.md

@@ -17,7 +17,7 @@ We value and welcome all contributions including
 Contributions can be made to the improve the base repository.
 
 * The way to collaborate and work on the project is via GitHub: [github.com/dxc-technology/Sequences-as-Code](https://github.com/dxc-technology/Sequences-as-Code)
-* For issues, bug fixes or adding new features, please create and submit a pull request
+* For documentation updates, bug fixes or the addition of new features please create and submit a pull request
 * For raising an issue or a defect, please open a [new github issue](https://github.com/dxc-technology/Sequences-as-Code/issues/new)
 
 ### Your Missions and Sequences
@@ -30,7 +30,7 @@ For instructions on how to
 * Add your missions and sequences
 * Perform common SaC tasks please
 
-see the [documentation](./docs/README.md).
+see the **SaC (Sequences as Code)** [documentation](./docs/README.md).
 
 ## Pull Requests
 
@@ -42,11 +42,13 @@ If your pull request is not accepted at first, please try again after addressing
 
 ### How to create and submit a pull request
 
-* **Fork** the repository
-* Make **changes** on your local environment
+* **Fork** the [SaC (Sequences as Code)](https://dxc-technology.github.io/Sequences-as-Code/#/) repository
+* Make **changes** in your local environment
 * **Test** your changes
-* Submit **Pull Request** to the master repository including a brief description of the request. The **Pull Request** should include enough detail to enable the owner of the repository understand and process the request.
+* Submit a **Pull Request** to the master repository including a brief description of the request. The **Pull Request** should include enough detail to enable the owner of the repository understand and process the request.
 * **@Mention** the team/team members in the comment section so the notification is sent. This alerts the team members of the need to review the code.
 * Wait for the repo admins to review the changes and provide **feedback**.
 
-As noted above please do not submit a pull request with your dedicated missions and sequences, these should be added to a dedicated instance of SaC. For details on how to stand up a dedicated instance see the [documentation](./docs/README.md).
+As **noted** above please do not submit a pull request containing your dedicated missions and sequences, these should be added to a dedicated instance of SaC.
+
+For details on how to stand up a dedicated instance of SaC refer to the **SaC (Sequences as Code)** [documentation](./docs/README.md).

README.md

@@ -36,20 +36,20 @@ See a [history of the changes](CHANGELOG.md) to **SaC (Sequences as Code)**.
 
 ## Documentation
 
-For instructions on how to perform common SaC tasks please see the [documentation](./docs/README.md).
+For instructions on how to perform common **SaC (Sequences as Code)** tasks please see the [documentation](./docs/README.md).
 
 ## Contributing
 
 We welcome all contributions please refer to [CONTRIBUTING.MD](/CONTRIBUTING.md) for details on how to contribute to this repository.
 
 ## Issues
 
-If you experience some problems with the existing scenarios, please open an [issue](https://github.com/dxc-technology/Sequences-as-Code/issues/new/choose) and let us know about them.
+If you experience problems with the application including the provided sequences, please open an [issue](https://github.com/dxc-technology/Sequences-as-Code/issues/new/choose) and let us know about them.
 
 ## License
 
 This project is licensed under the Mozilla Public License Version 2.0 - see the [LICENSE](LICENSE) file for details.
 
 ## Create React App - Bootstrapped Readme.md
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). For your convenience the bootstrapped README.md is available at[CRA-README.md](./CRA-README.md).
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). For your convenience the bootstrapped README.md is available at [CRA-README.md](./CRA-README.md).

docs/README.md

@@ -1,36 +1,36 @@
 # README.md
 
-The following instructions describe how to perform common tasks related to Sequences as Code.
+The following instructions describe how to perform common tasks related to **SaC (Sequences as Code)**.
 
 ## Creating Sequences
 
-Using SaC sequences are created as UML and grouped together as Missions.
+When using SaC sequences are created as UML and grouped together as Missions.
 
-Details on how to create the missions and sequences can be found in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission and associated sequences.
+Details on how to create missions and sequences can be found in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission and it's associated sequences.
 
 ### Creating Sequences - Automatically
 
-The option to convert the UML files to SVG is offered on every code commit from the continuous integration GitHub Action.
+The option to convert the UML files to SVG is offered on every code commit from the code commit GitHub Action.
 
 ### Creating Sequences - Manually
 
 Additionally the UML files can be converted to SVG manually in a local copy of a [Sequences as Code](https://github.com/dxc-technology/Sequences-as-Code) repository.
 
-To generate the SVG files for a repository created from a release on the [Sequences as Code](https://github.com/dxc-technology/Sequences-as-Code), clone the repository then open a terminal session and run
+To generate the SVG files for a repository created from a release of [Sequences as Code](https://github.com/dxc-technology/Sequences-as-Code), clone the repository then open a terminal session and run
 
 ```bash
 ./generatesvg.sh
 ```
 
-The `./generatesvg.sh` script uses PlantUML a dockerized command line utility to convert UML files to SVG files. The script requires docker to be installed and running locally.
+The `./generatesvg.sh` script uses PlantUML a dockerized command line utility to convert UML files to SVG files. The `./generatesvg.sh` script requires docker to be installed and running locally.
 
-**Tip 1** `./generatesvg.sh` will generate SVG files for all the UML files it finds in the mission subfolders of the folder `src/sequences`. This may take some and should not be necessary for the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission. Prior to running `./generatesvg.sh` you can adjust the script to ensure it only finds and processes the UML files you need processed.
+**Tip 1** `./generatesvg.sh` will generate SVG files for all the UML files it finds in the mission subfolders of the folder `src/sequences`. This may take some time and should not be necessary for the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission. Prior to running `./generatesvg.sh` you can adjust the script to ensure it only finds and processes the UML files you need processed.
 
-**Tip 2** When running the `./generatesvg.sh` script you can ignore any WARNINGS reported. In the event of an ERROR unfortunately no details are provided by `think/plantuml`, so to view the specific error details you can use [PlantText](https://www.planttext.com/).
+**Tip 2** When running the `./generatesvg.sh` script you can ignore any WARNINGS reported. In the event of an ERROR unfortunately no details are provided by `think/plantuml`. If you need to view specific error details you can use [PlantText](https://www.planttext.com/).
 
 ## Linking Sequences to Sequences
 
-The create-react-app tool chain was used to create the single paged SaC application. The create-react-app scaffolder ensures each file inside of the build/static directory will have a unique hash appended to the filename. The unique hash is generated based on the contents of the file, this is to avoid browsers needing to re-download your assets if the file contents haven't changed. If the contents of a file changes in a subsequent build, the filename hash that is generated will be different.
+The [create-react-app](https://create-react-app.dev/docs/getting-started/) tool chain was used to create the single paged SaC application. The create-react-app scaffolder ensures each file inside of the build/static directory will have a unique hash appended to the filename. The unique hash is generated based on the contents of the file, the hash is used to avoid browsers needing to re-download your assets if the file contents haven't changed. If the contents of a file changes in a subsequent build the filename hash that is generated will be different.
 
 For images the filenames when built and deployed, both automatically and manually, are changed from
 
@@ -44,9 +44,9 @@ to
 image.hash.svg
 ``
 
-The fact that the sequence file names can change if the SVG files are regenerated prevents sequences from linking to other sequences.
+The fact that the sequence file names change if the SVG files are regenerated prevents sequences from being linked to other sequences.
 
-To allow sequences to link to other sequences a set of SaC "hashed" images are available in the `https://github.com/your_organisation/your_repository/images` folder. These images have consistent names as the SaC hash gives the image files the following names
+To allow sequences be linked to other sequences a set of SaC "hashed" images are available in the `https://github.com/your_organisation/your_repository/images` folder. These images have consistent names as the SaC hash gives the image files the following names
 
 ``
 sequence.image.svg
@@ -60,7 +60,7 @@ To do this:
 
 - Open a terminal session and go to your cloned copy of the SaC repository
 
-- Lint to verify react code is syntactically correct - `npm run lint`
+- Run linting against the code to verify the react code is syntactically correct - `npm run lint`
 
 - Run unit tests - `npm test`
 
@@ -76,7 +76,7 @@ When linting and testing is successful you can deploy the solution from your loc
 
 - `npm run deploy`
 
-as the solution has been configured to be hosted in a [GitHub pages site](https://github.com/gitname/react-gh-pages) after deployment it will be available at [http://github.com/pages/your_repository].
+Because the solution has been configured to be hosted in a [GitHub pages site](https://github.com/gitname/react-gh-pages) after deployment it will be available at [http://github.com/pages/your_repository].
 
 ## Releases