updating templated projects

Author: gilesknap

docs/user/how-to/update_templated.rst

@@ -0,0 +1,44 @@
+Updating Template Based Projects
+================================
+
+The tutorials use two template projects as follows:
+
+.. list-table:: Template Projects
+    :widths: 30 70
+    :header-rows: 1
+
+    * - Template Project
+      - Purpose
+    * - ioc-template
+      - create a new generic IOC container project
+    * - blxxi-template
+      - create a new IOC Instance Domain project
+
+The instructions for for making these project used a clone of
+the template. The reason for this is that the template projects
+may be updated in future to add new features or fix bugs.
+
+Occasionally it may be useful to update your project to use the
+latest version of the template. Because your project contains
+commits from the original template this can easily be done using
+git.
+
+For an ioc-template based project:
+
+.. code-block:: bash
+
+    cd ioc-my-ioc-template-based-project
+    git pull [email protected]:epics-containers/ioc-template.git
+
+For an blxxi-template based project:
+
+.. code-block:: bash
+
+    cd ioc-my-ioc-template-based-project
+    git pull [email protected]:epics-containers/ioc-template.git.git
+
+The pull command will merge any changes from the template into your
+project. You may need to resolve any conflicts.
+
+
+

docs/user/index.rst

@@ -41,6 +41,7 @@ side-bar.
             how-to/contributing
             how-to/own_tools
             how-to/useful_k8s
+            how-to/update_templated
 
         +++
 

docs/user/tutorials/create_beamline.rst

@@ -119,6 +119,10 @@ repo in the future.
 
 .. figure:: ../images/create_repo.png
 
+Note that creating your project in this way means it is possible to
+synchronize changes from the original blxxi-template project.
+See `../how-to/update_templated`.
+
 
 Make a Release of Example Beamline bl01t
 ----------------------------------------

docs/user/tutorials/generic_ioc.rst

@@ -53,6 +53,10 @@ using an ``ec`` command.
         git remote add origin [email protected]:<YOUR USER NAME>/ioc-adurl.git
         git push --set-upstream origin main
 
+Note that creating your project in this way means it is possible to
+synchronize changes from the original ioc-template project.
+See `../how-to/update_templated`.
+
 Prepare the New Repo for Development
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~