update software template docs

docs/features/software-templates/adding-templates.md

@@ -58,7 +58,7 @@ Currently the catalog supports loading definitions from GitHub + Local Files. To
 load from other places, not only will there need to be another preparer, but the
 support to load the location will also need to be added to the Catalog.
 
-For loading from a file the following command should work when the backend is
+For loading from a file, the following command should work when the backend is
 running:
 
 ```sh
@@ -69,7 +69,7 @@ curl \
   --data-raw "{\"type\": \"file\", \"target\": \"${YOUR PATH HERE}/template.yaml\"}"
 ```
 
-If loading from a git location, you can run the following
+If loading from a Git location, you can run the following
 
 ```sh
 curl \
@@ -83,7 +83,7 @@ This should then have added the catalog, and also should now be listed under the
 create page at http://localhost:3000/create.
 
 Alternatively, if you want to get setup with some mock templates that are
-already provided for you, you can run the following to load those templates:
+already provided, run the following to load those templates:
 
 ```
 yarn lerna run mock-data

docs/features/software-templates/extending/create-your-own-publisher.md

@@ -7,8 +7,8 @@ Publishers are responsible for pushing and storing the templated skeleton after
 the values have been templated by the `Templater`. See
 [Create your own templater](./create-your-own-templater.md) for more info.
 
-They recieve a directory or location where the templater has sucessfully run on,
-and is now ready to store somewhere. They also get given some other options
+They receive a directory or location where the templater has sucessfully run
+and is now ready to store somewhere. They also are given some other options
 which are sent from the frontend, such as the `storePath` which is a string of
 where the frontend thinks we should save this templated folder.
 
@@ -17,7 +17,7 @@ Currently we provide the following `publishers`:
 - `github`
 
 This publisher is passed through to the `createRouter` function of the
-`@spotify/plugin-scaffolder-backend`. Currently only one publisher is supported,
+`@spotify/plugin-scaffolder-backend`. Currently, only one publisher is supported,
 but PR's are always welcome.
 
 An full example backend can be found

docs/features/software-templates/extending/create-your-own-templater.md

@@ -8,14 +8,14 @@ returned by the preparers, and then executing the templating command on top of
 the file and returning the completed template path. This may or may not be the
 same directory as the input directory.
 
-They also recieve additional values from the frontend, which can be used to
+They also receive additional values from the frontend, which can be used to
 interpolate into the skeleton files.
 
 Currently we provide the following templaters:
 
 - `cookiecutter`
 
-This templater is added the `TemplaterBuilder` and then passed into the
+This templater is added to the `TemplaterBuilder` and then passed into the
 `createRouter` function of the `@spotify/plugin-scaffolder-backend`
 
 An full example backend can be found
@@ -48,7 +48,7 @@ This `TemplaterKey` is used to select the correct templater from the
 `spec.templater` in the
 [Template Entity](../../software-catalog/descriptor-format.md#kind-template).
 
-If you wish to add a new templater you'll need to register it with the
+If you wish to add a new templater, you'll need to register it with the
 `TemplaterBuilder`.
 
 ### Creating your own Templater to add to the `TemplaterBuilder`
@@ -83,10 +83,10 @@ follows:
 - `dockerClient` - a [dockerode](https://github.com/apocas/dockerode) client to
   be able to run docker containers.
 
-_note_ currently the templaters that we provide are basically docker action
+_note_ Currently the templaters that we provide are basically Docker action
 containers that are run on top of the skeleton folder. This keeps dependencies
 to a minimal for running backstage scaffolder, but you don't /have/ to use
-docker. You could create your own templater that spins up an EC2 instance and
+Docker. You could create your own templater that spins up an EC2 instance and
 downloads the folder and does everything using an AMI if you want. It's entirely
 up to you!
 
@@ -138,7 +138,7 @@ spec:
         description: Description of the component
 ```
 
-You see that the `spec.templater` is set as `handlebars`, you'll need to
+You see that the `spec.templater` is set as `handlebars`, so you'll need to
 register this with the `TemplaterBuilder` like so:
 
 ```ts

docs/features/software-templates/extending/index.md

@@ -5,11 +5,11 @@ title: Extending the Scaffolder
 
 Welcome. Take a seat. You're at the Scaffolder Documentation.
 
-So - You wanna create stuff inside your company from some prebaked templates?
+So, you want to create stuff inside your company from some prebaked templates?
 You're at the right place.
 
-This guide is gonna take you through how the Scaffolder in Backstage works.
-We'll dive into some jargon and run through whats going on in the backend to be
+This guide is going to take you through how the Scaffolder in Backstage works.
+We'll dive into some jargon and run through what's going on in the backend to be
 able to create these templates. There's also more guides that you might find
 useful at the bottom of this document. At it's core, theres 3 simple stages.
 
@@ -25,9 +25,9 @@ scaffolder that you will need to know:
 3. Publish
 
 Each of these steps can be configured for your own use case, but we provide some
-sensible defaults too.
+sensible defaults, too.
 
-Lets dive a little deeper into these phases.
+Let's dive a little deeper into these phases.
 
 ### Glossary and Jargon
 
@@ -38,8 +38,8 @@ the router to pick the correct `Preparer` to run for the `Template` entity.
 
 **Templater** - The templater is responsible for actually running the chosen
 templater on top of the previously returned temporary directory from the
-**Preprarer**. We advise making these docker containers as it can keep all
-dependencies, for example Cookiecutter, self contained and not a dependency on
+**Preprarer**. We advise making these Docker containers as it can keep all
+dependencies--for example Cookiecutter--self contained and not a dependency on
 the host machine.
 
 **Publisher** - The publisher is responsible for taking the finished directory,
@@ -50,11 +50,11 @@ passed through to the scaffolder backend.
 
 ### How it works
 
-The main of the heavy lifting is done in the
+Most of the heavy lifting is done in the
 [router.ts](https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/src/service/router.ts#L93)
 file in the `scaffolder-backend` plugin.
 
-There are 2 routes defined in the router. `POST /v1/jobs` and
+There are two routes defined in the router: `POST /v1/jobs` and
 `GET /v1/job/:jobId`
 
 To create a scaffolding job, a JSON object containing the
@@ -78,7 +78,7 @@ additional templating values must be posted as the post body.
 The values should represent something that is valid with the `schema` part of
 the [Template Entity](../../software-catalog/descriptor-format.md#kind-template)
 
-Once that has been posted, a job will be setup with different stages. And the
+Once that has been posted, a job will be setup with different stages, and the
 job processor will complete each stage before moving onto the next stage, whilst
 collecting logs and mutating the running job.
 

docs/features/software-templates/index.md

@@ -4,8 +4,8 @@ title: Software Templates
 ---
 
 The Software Templates part of Backstage is a tool that can help you create
-Components inside Backstage. It by default has the ability to load skeletons of
-code, template in some variables and then publish the template to some location
+Components inside Backstage. By default, it  has the ability to load skeletons of
+code, template in some variables, and then publish the template to some location
 like GitHub.
 
 <video width="100%" height="100%" controls>
@@ -33,8 +33,8 @@ internally.
 ![Enter some variables](../../assets/software-templates/template-picked.png)
 
 After filling in these variables, you'll get some more fields to fill out which
-are required for backstage usage. The owner, which is a `user` in the backstage
-system, and the `storePath` which right now must be a GitHub Organisation and a
+are required for backstage usage: the owner, (which is a `user` in the backstage
+system), the `storePath` (which right now must be a GitHub Organisation), and a
 non-existing github repository name in the format `organisation/reponame`.
 
 ![Enter backstage vars](../../assets/software-templates/template-picked-2.png)
@@ -51,13 +51,13 @@ It shouldn't take too long, and you'll have a success screen!
 ![Templating Complete](../../assets/software-templates/complete.png)
 
 If it fails, you'll be able to click on each section to get the log from the
-step that failed which can be helpful to debug.
+step that failed which can be helpful in debugging.
 
 ![Templating failed](../../assets/software-templates/failed.png)
 
 ### View Component in Catalog
 
-When it's been created you'll see the `View in Catalog` button, which will take
+When it's been created, you'll see the `View in Catalog` button, which will take
 you to the registered component in the catalog:
 
 ![Catalog](../../assets/software-templates/go-to-catalog.png)

plugins/scaffolder-backend/src/scaffolder/stages/templater/types.ts

@@ -36,7 +36,7 @@ export type TemplaterRunResult = {
 };
 
 /**
- * The values that the templater will recieve. The directory of the
+ * The values that the templater will receive. The directory of the
  * skeleton, with the values from the frontend. A dedicated log stream and a docker
  * client to run any templater on top of your directory.
  */

plugins/techdocs-backend/src/techdocs/stages/generate/types.ts

@@ -26,7 +26,7 @@ export type GeneratorRunResult = {
 };
 
 /**
- * The values that the generator will recieve. The directory of the
+ * The values that the generator will receive. The directory of the
  * uncompiled documentation, with the values from the frontend. A dedicated log stream and a docker
  * client to run any generator on top of your directory.
  */