Merge pull request #24 from epics-containers/remove-tutorial-numbers

gilesknap · web-flow · commit d70eb5710ed2 · 2023-04-19T07:46:14.000+01:00
Remove number prefixes from user guide tutorial file names
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,7 +7,7 @@ Quick Start
 ===========
 
 For a set of tutorials to introduce the concepts of epics-containers see
-`user/tutorials/00_intro`. For a description of the architecture see
+`user/tutorials/intro`. For a description of the architecture see
 `essential`.
 
 
diff --git a/docs/user/how-to/run_iocs.rst b/docs/user/how-to/run_iocs.rst
@@ -10,7 +10,7 @@ use a Kubernetes ConfigMap to pass the configuration to the IOC.
 
 However it is perfectly possible to do this without Kubernetes. To demonstrate
 this easily, first create the test beamline repo as described in
-`../tutorials/04_create_beamline`.
+`../tutorials/create_beamline`.
 
 Now if you cd into the test beamline repo and run the following command you
 will see the IOC running in a container:
diff --git a/docs/user/how-to/useful_k8s.rst b/docs/user/how-to/useful_k8s.rst
@@ -141,7 +141,7 @@ PVs. To do this perform the following steps to get the name of the
 example IOC pod and discover its IP address, then pass that to the
 edm container:
 
-cd to the root of the project you created in `../tutorials/05_deploy_example`, then::
+cd to the root of the project you created in `../tutorials/deploy_example`, then::
 
     kubectl get pods
         NAME                      READY   STATUS    RESTARTS   AGE
diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -13,17 +13,17 @@ side-bar.
             :caption: Tutorials
             :maxdepth: 1
 
-            tutorials/00_intro
-            tutorials/01_setup_workstation
-            tutorials/02_devcontainer
-            tutorials/03_setup_k8s
-            tutorials/04_create_beamline
-            tutorials/05_deploy_example
-            tutorials/06_ioc_changes
-            tutorials/07_generic_ioc
-            tutorials/08_debug_generic_ioc
-            tutorials/09_test_generic_ioc
-            tutorials/10_support_module
+            tutorials/intro
+            tutorials/setup_workstation
+            tutorials/devcontainer
+            tutorials/setup_k8s
+            tutorials/create_beamline
+            tutorials/deploy_example
+            tutorials/ioc_changes
+            tutorials/generic_ioc
+            tutorials/debug_generic_ioc
+            tutorials/test_generic_ioc
+            tutorials/support_module
 
         +++
 
diff --git a/docs/user/tutorials/create_beamline.rst b/docs/user/tutorials/create_beamline.rst
@@ -120,7 +120,7 @@ repo in the future.
 Make a Release of Example Beamline bl01t
 ----------------------------------------
 
-To make a release of the project we defined in `05_deploy_example`,
+To make a release of the project we defined in `deploy_example`,
 we will
 tag your repo with a calendar based version number see (https://calver.org/).
 
diff --git a/docs/user/tutorials/debug_generic_ioc.rst b/docs/user/tutorials/debug_generic_ioc.rst
@@ -1,7 +1,7 @@
 Debugging Generic IOC Builds
 ============================
 
-This tutorial is a continuation of `07_generic_ioc`. Here we will look into
+This tutorial is a continuation of `generic_ioc`. Here we will look into
 debugging failed builds and fix the issue we saw in the  previous tutorial.
 
 There are two ways to debug a failed build:
diff --git a/docs/user/tutorials/deploy_example.rst b/docs/user/tutorials/deploy_example.rst
diff --git a/docs/user/tutorials/devcontainer.rst b/docs/user/tutorials/devcontainer.rst
diff --git a/docs/user/tutorials/generic_ioc.rst b/docs/user/tutorials/generic_ioc.rst
@@ -70,7 +70,7 @@ There are a few things that all new ioc-XXX repos need to do:
     relevant to your IOC and change the script in ``tests`` to match.
 
 For now leave the tests alone as we will be working with them in
-`09_test_generic_ioc`.
+`test_generic_ioc`.
 
 Now we will go ahead and make the specific changes to the template
 needed for our ioc-adurl project.
diff --git a/docs/user/tutorials/intro.rst b/docs/user/tutorials/intro.rst
diff --git a/docs/user/tutorials/ioc_changes.rst b/docs/user/tutorials/ioc_changes.rst
@@ -83,7 +83,7 @@ The ``--tag`` option specifies the version of the Generic IOC container to use
 and this means it will be pulled from the container registry (or come from
 the cache if it has already been pulled).
 If you do not supply a tag then ``ec`` will look for a local copy of the
-container to use, we will cover this in `07_generic_ioc`.
+container to use, we will cover this in `generic_ioc`.
 
 If all is well you should see your iocShell prompt and you can test your change
 from another terminal (VSCode menus -> Terminal -> New Terminal) like so:
diff --git a/docs/user/tutorials/setup_k8s.rst b/docs/user/tutorials/setup_k8s.rst
@@ -12,7 +12,7 @@ Setup a Kubernetes Server
 
     The approach of creating generic IOC's in containers and then deploying
     IOC instances as generic IOC's + some configuration will also work
-    standalone, or with other orchestration tools. e.g. In `06_ioc_changes`
+    standalone, or with other orchestration tools. e.g. In `ioc_changes`
     we will demonstrate running an IOC locally using podman alone.
 
     If you want to take advantage of containers for IOCs but do not want to
@@ -29,7 +29,7 @@ Bring Your Own Cluster
 ----------------------
 
 If you already have a Kubernetes cluster then you can skip this section.
-and go straight to `./04_create_beamline`.
+and go straight to `./create_beamline`.
 
 IMPORTANT: you will require appropriate permissions on the cluster to work
 with epics-containers. In particular you will need to be able to create
diff --git a/docs/user/tutorials/setup_workstation.rst b/docs/user/tutorials/setup_workstation.rst
diff --git a/docs/user/tutorials/support_module.rst b/docs/user/tutorials/support_module.rst
@@ -11,7 +11,7 @@ like a traditional EPICS Support module and merge in the files from
 ioc-template.
 
 Once you have created the project(s), working on the support module will
-look very similar to the procedures set out here `08_debug_generic_ioc`
+look very similar to the procedures set out here `debug_generic_ioc`
 
 
 TODO: suggest that we will make a new Stream Device that will be a
diff --git a/docs/user/tutorials/test_generic_ioc.rst b/docs/user/tutorials/test_generic_ioc.rst
