Skip to content

Commit d188d17

Browse files
committed
Run user tutorials through Grammarly extension
1 parent 9c34311 commit d188d17

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

docs/user/tutorials/create_beamline.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ You will also need to setup ssh keys to authenticate to github from git. See
6060
Create a New Repository
6161
-----------------------
6262

63-
Here we will copy the beamline template repository and change it's name to bl01t.
63+
Here we will copy the beamline template repository and change its name to bl01t.
6464
We will then step through the changes that are required to make it your own.
6565

6666
NOTE: for these tutorials we will use your personal GitHub Account to
@@ -118,7 +118,7 @@ Environment.sh
118118
~~~~~~~~~~~~~~
119119

120120
Environment.sh is a bash script that is sourced by a beamline user or developer
121-
in order to setup their environment to work with the beamline.
121+
in order to set up their environment to work with the beamline.
122122

123123
The command line tool ``ec`` uses the environment configured by this script
124124
to determine where to deploy IOCS and where to find container images etc.

docs/user/tutorials/create_ioc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Viewing IOC output
277277
~~~~~~~~~~~~~~~~~~
278278

279279
Our detector output is available over PVAccess since we added the PVA plugin.
280-
We can view it using the ``c2dv`` tool. Theses commands will install ``c2dv``
280+
We can view it using the ``c2dv`` tool. These commands will install ``c2dv``
281281
and launch it to view the IOC output:
282282

283283
.. code-block:: bash
@@ -392,7 +392,7 @@ docker if that is what you are using):
392392
393393
Your IOC Instance will now be using the raw startup script and database. But
394394
should behave exactly the same as before. You are free to experiment with
395-
changes in the startup script and substitution file and re-deploy the IOC.
395+
changes in the startup script and substitution file and re-deploy the IOC.
396396

397397
.. note::
398398

docs/user/tutorials/debug_generic_ioc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Debugging Generic IOC Builds
66
This tutorial is out of date and will be updated soon.
77

88
This tutorial is a continuation of `generic_ioc`. Here we will look into
9-
debugging failed builds and fix the issue we saw in the previous tutorial.
9+
debugging failed builds and fix the issue we saw in the previous tutorial.
1010

1111
This also comes under the category of type 2. change from the list
1212
at `ioc_change_types`.

docs/user/tutorials/deploy_example.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ where indicated):
6969
source bl01t
7070
7171
Once you have done this and logged out and back in again to pick up your new
72-
profile you should be able enable the ``bl01t`` environment as follows:
72+
profile you should be able to enable the ``bl01t`` environment as follows:
7373

7474
.. code-block:: bash
7575
@@ -97,7 +97,7 @@ IOC Instance.
9797

9898
The following command will deploy the example IOC instance to your local
9999
machine (unless you have skipped ahead and set up your Kubernetes config
100-
in which case the same command will deploy to your Kubernetes cluster).
100+
in which case the same command will deploy to your Kubernetes cluster).
101101

102102
.. code-block:: bash
103103
@@ -158,7 +158,7 @@ Managing the Example IOC Instance
158158
Starting and Stopping IOCs
159159
~~~~~~~~~~~~~~~~~~~~~~~~~~
160160

161-
To stop / start the example IOC try the following commands. Note that
161+
To stop / start the example IOC try the following commands. Note that
162162
``ec ps -a`` shows you all IOCs including stopped ones.
163163

164164
.. code-block:: bash

docs/user/tutorials/dev_container.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ multiple peer projects.
217217

218218
In VSCode click the ``File`` menu and select ``Add Folder to Workspace``.
219219
Navigate to ``/repos`` and you will see all the peers of your ``ioc-adsimdetector``
220-
folder (see `container-layout` below) . Choose the ``bl01t`` folder and add it to the
220+
folder (see `container-layout` below). Choose the ``bl01t`` folder and add it to the
221221
workspace - you may see an error but if so clicking "reload window" will
222222
clear it.
223223

@@ -230,8 +230,8 @@ Also take this opportunity to add the folder ``/epics`` to the workspace.
230230
and git will complain about ownership. You can cancel out of these errors
231231
as you should not edit project folders inside of ``/epics`` - they were
232232
built by the container and should be considered immutable. We will learn
233-
how to work on support modules in later tuorials. This error should only
234-
be seen on first launch. podman users will have no such problem becuase they
233+
how to work on support modules in later tutorials. This error should only
234+
be seen on first launch. podman users will have no such problem because they
235235
will be root inside the container and root build the container.
236236

237237
You can now easily browse around the ``/epics`` folder and see all the

docs/user/tutorials/generic_ioc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ test our changes locally before deploying it.
1111
This is a type 2. change from the list at `ioc_change_types`.
1212

1313
The example IOC used ADSimDetector, we will make a similar IOC that uses
14-
ADUrl to get images from a web cam.
14+
ADUrl to get images from a webcam.
1515

1616
Create a New Generic IOC project
1717
--------------------------------
@@ -49,7 +49,7 @@ using an ``ec`` command.
4949
From the VSCode menus: File->Add Folder to Workspace
5050
then select the folder ioc-adurl
5151

52-
#. Push the repo back to a the new repo on github
52+
#. Push the repo back to a new repo on github
5353

5454
.. code-block:: bash
5555

docs/user/tutorials/ioc_changes1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ into the Generic IOC (ioc-adsimdetector). Each support module has an
128128
``ibek`` *support YAML* file that contributes to the schema.
129129

130130
The *Support yaml* files are in the folder ``/epics/ibek`` inside of the
131-
container. They were placed their during the compilation of the support
131+
container. They were placed there during the compilation of the support
132132
modules at Generic IOC build time.
133133

134134
It can be instructive to look at these files to see what entities are available

docs/user/tutorials/setup_workstation.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Setup a Developer Workstation
1+
Set up a Developer Workstation
22
=============================
33

4-
This page will guide you through the steps to setup a developer workstation
4+
This page will guide you through the steps to set up a developer workstation
55
in readiness for the remaining tutorials.
66
The tools you need to install are:
77

@@ -45,14 +45,14 @@ Setup VSCode
4545

4646
.. Note::
4747

48-
**DLS Users**: You can access VSCode with ``module load vscode``.
48+
**DLS Users**: You can access VSCode with ``module load vscode``.
4949

5050
First download and install Visual Studio Code.
5151

5252
- `Download Visual Studio Code`_
5353
- `Setup Visual Studio Code`_
5454

55-
VSCode has an huge library of extensions. The following list of extensions are
55+
VSCode has a huge library of extensions. The following list of extensions are
5656
useful for working with epics-containers. You will need to install the *Required*
5757
extensions before proceeding to the next tutorial. See the links for instructions
5858
on how to do this.
@@ -82,7 +82,7 @@ Setup Docker or Podman
8282
**DLS Users**: RHEL 8 Workstations at DLS have podman 4.4.1 installed by default.
8383
RHEL 7 Workstations are not supported.
8484

85-
Next install docker or podman as the your container platform. epics-containers
85+
Next install docker or podman as your container platform. epics-containers
8686
has been tested with podman 4.4.1 on RedHat 8, and Docker 24.0.5 on
8787
for Ubuntu 22.04.
8888

@@ -135,7 +135,7 @@ but you can choose any folder.
135135
python -m pip install --upgrade pip
136136
137137
Note that each time you open a new shell you will need to activate the virtual
138-
environment again. (Or place it's bin folder in your path permanently).
138+
environment again. (Or place its bin folder in your path permanently).
139139

140140

141141
.. _ec:

0 commit comments

Comments
 (0)