Merge pull request #46 from epics-containers/dev

Added Tutorial 'Deploying and Managing IOC Instances'
epics-containers · Oct 27, 2023 · 85fd2c7 · 85fd2c7
2 parents 566a51e + 0a503c8
commit 85fd2c7
Show file tree

Hide file tree

Showing 7 changed files with 388 additions and 11 deletions.
diff --git a/docs/user/how-to/phoebus.rst b/docs/user/how-to/phoebus.rst
@@ -0,0 +1,12 @@
+Viewing Operator Interfaces with Phoebus
+========================================
+
+Phoebus is a Java application that can be used to view operator interfaces.
+
+epics-containers will support auto generation of engineering screens for
+Phoebus using `PVI <https://github.com/epics-containers/pvi>`_.
+This is the initial target for epics-containers GUIs, other OPI
+formats may be supported in the future.
+
+OPI file generation is work in progress and this page will be updated when
+it is ready (est Nov 2023).
diff --git a/docs/user/images/c2dv.png b/docs/user/images/c2dv.png
diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -36,6 +36,7 @@ side-bar.
             :caption: How-to Guides
             :maxdepth: 1
 
+            how-to/phoebus
             how-to/debug
             how-to/contributing
             how-to/own_tools

diff --git a/docs/user/tutorials/create_beamline.rst b/docs/user/tutorials/create_beamline.rst
@@ -27,8 +27,8 @@ with basic configuration.
 
 The tests on beamline repositories are basic at present. However the intention
 is that eventually each device on a beamline will be simulated using
-`Tickit <https://github.com/dls-controls/tickit>`_ and that the CI so system
-tests of each IOC against simulated hardware.
+`Tickit <https://github.com/dls-controls/tickit>`_ . Then Continuous
+Integration will perform system tests for each IOC against simulated hardware.
 
 Also note that each of these IOC instances will be launched using a
 Generic IOC image. Ideally the CI for each Generic IOC should have already run
@@ -81,7 +81,7 @@ Steps
 
 .. _these instructions: https://github.com/epics-containers/blxxi-template#how-to-copy-this-template-project
 
-#.  Clone the template repo locally.
+#.  Clone the template repo locally (substituting in your own GitHub Account).
 
     .. code-block:: bash
 
@@ -174,8 +174,8 @@ Wrapping Up
 -----------
 
 You should now have a working beamline repository. It contains a single
-IOC Instance which is a non-functional example. In the following
-tutorial we will investigate the example and then create a real IOC Instance.
+IOC Instance which is a non-functional example. In the following two
+tutorials we will investigate the example and then create a real IOC Instance.
 
 You can now push the repository up to GitHub and give it a version tag like this: