Merge pull request #54 from marcelldls/marcell-patch

Documentation suggestions

Author: gilesknap

docs/user/tutorials/create_beamline.rst

@@ -79,7 +79,7 @@ Steps
     If you are using an alternative to GitHub for your repositories then
     see `these instructions`_ for an alternative approach.
 
-.. _these instructions: https://github.com/epics-containers/blxxi-template#how-to-copy-this-template-project
+    .. _these instructions: https://github.com/epics-containers/blxxi-template#how-to-copy-this-template-project
 
 #.  Clone the template repo locally (substituting in your own GitHub Account).
 

docs/user/tutorials/create_ioc.rst

@@ -30,13 +30,16 @@ This folder needs to contain these two items:
     can take a number of forms
     `listed here <https://github.com/epics-containers/ibek/blob/ea9da7e1cfe88f2a300ad236f820221837dd9dcf/src/ibek/templates/ioc/config/start.sh>`_.
 
+values.yaml 
+~~~~~~~~~~~~~~~~~~~~~~~
+
 We will start by creating the values.yaml file:
 
 .. code-block:: bash
 
     cd bl01t
     mkdir iocs/bl01t-ea-ioc-02
-    code values.yaml
+    code iocs/bl01t-ea-ioc-02/values.yaml
 
 This should launch vscode and open the values.yaml file. Add the following:
 
@@ -80,8 +83,8 @@ To recap, we have two python CLI tools for supporting ``epics-containers``:
 above. So now we will provide some *IOC yaml* files to ``ibek`` so that it
 will generate startup assets for our IOC Instance.
 
-Make an *IOC yaml* File
--------------------------
+config
+~~~~~~~~~~~~~~~~~~~~~~~
 
 *IOC yaml* files are a sequence of ``entities``. Each entity is an instance of
 a ``definition`` declared in the *Support yaml* that one of the support
@@ -170,14 +173,21 @@ baked into the container:
             # simDetectorConfig(portName, maxSizeX, maxSizeY, dataType, maxBuffers, maxMemory)
             simDetectorConfig("{{PORT}}", {{WIDTH}}, {{HEIGHT}}, {{DATATYPE}}, {{BUFFERS}}, {{MEMORY}})
 
-You can see that this lists a a number of arguments that it expects. It then
+You can see that this lists a number of arguments that it expects. It then
 declares how these will be used to substitute values into the simDetector
 database template. Finally it declares some lines to go into the startup script
 (before iocInit).
 
 Therefore, we can create an *IOC yaml* file that instantiates a simulation
 detector as follows:
 
+.. code-block:: bash
+
+    mkdir iocs/bl01t-ea-ioc-02/config
+    code iocs/bl01t-ea-ioc-02/config/ioc.yaml
+
+This should launch vscode and open the ioc.yaml file. Add the following:
+
 .. code:: yaml
 
     # yaml-language-server: $schema=https://github.com/epics-containers/ioc-adsimdetector/releases/download/2023.10.7/ibek.ioc.schema.json
@@ -227,7 +237,7 @@ detector over a PVAccess channel called ``BL01T-EA-TST-02:PVA:OUTPUT``. The
 a dependency of ADSimDetector and so is included in the Generic IOC container.
 
 Try putting the two snippets of *IOC yaml* together and saving it as
-``ioc.yaml`` in the ``iocs/bl01t-ea-ioc-02`` folder.
+``ioc.yaml`` in the ``iocs/bl01t-ea-ioc-02/config`` folder.
 
 You have now defined your first IOC instance.
 
@@ -388,4 +398,4 @@ changes in the  startup script and substitution file and re-deploy the IOC.
 
     For example try this command:
 
-    - ec -v ioc deploy-local iocs/bl01t-ea-ioc-02
+    - ec -v ioc deploy-local iocs/bl01t-ea-ioc-02

docs/user/tutorials/dev_container.rst

@@ -177,7 +177,7 @@ is mounted into the container as a volume. It is mounted under
 from your local machine and the changes will be visible inside the container and
 outside the container. This is a good thing as you should consider the container
 filesystem to be a temporary filesystem that will be destroyed when the container
-deleted.
+is deleted.
 
 Now that you are *inside* the container you have access to the tools built into
 it, this includes ``ibek``. The first command you should run is:
@@ -303,4 +303,4 @@ we are able to test changes without having to go through a container build
 cycle.
 
 In the following tutorials we will look at how to make changes at each of the
-3 levels listed in `ioc_change_types`.
+3 levels listed in `ioc_change_types`.