Skip to content

Commit 76322d5

Browse files
committed
add rtems into restructured docs
2 parents 7833ed0 + 3449bcf commit 76322d5

22 files changed

+228
-84
lines changed

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Quick Start
77
===========
88

99
For a set of tutorials to introduce the concepts of epics-containers see
10-
`user/tutorials/00_intro`. For a description of the architecture see
10+
`user/tutorials/intro`. For a description of the architecture see
1111
`essential`.
1212

1313

docs/user/how-to/run_iocs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use a Kubernetes ConfigMap to pass the configuration to the IOC.
1010

1111
However it is perfectly possible to do this without Kubernetes. To demonstrate
1212
this easily, first create the test beamline repo as described in
13-
`../tutorials/04_create_beamline`.
13+
`../tutorials/create_beamline`.
1414

1515
Now if you cd into the test beamline repo and run the following command you
1616
will see the IOC running in a container:

docs/user/how-to/useful_k8s.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ PVs. To do this perform the following steps to get the name of the
141141
example IOC pod and discover its IP address, then pass that to the
142142
edm container:
143143
144-
cd to the root of the project you created in `../tutorials/05_deploy_example`, then::
144+
cd to the root of the project you created in `../tutorials/deploy_example`, then::
145145
146146
kubectl get pods
147147
NAME READY STATUS RESTARTS AGE
77.4 KB
Loading
119 KB
Loading

docs/user/images/dev-container.png

79.4 KB
Loading

docs/user/index.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,20 @@ side-bar.
1313
:caption: Tutorials
1414
:maxdepth: 1
1515

16-
tutorials/00_intro
17-
tutorials/01_setup_workstation
18-
tutorials/02_devcontainer
19-
tutorials/03_setup_k8s
20-
tutorials/04_create_beamline
21-
tutorials/05_deploy_example
22-
tutorials/06_ioc_changes
23-
tutorials/07_generic_ioc
24-
tutorials/08_debug_generic_ioc
25-
tutorials/09_test_generic_ioc
26-
tutorials/10_support_module
27-
tutorials/11_rtems_setup
28-
tutorials/12_rtems_ioc
29-
30-
+++
16+
tutorials/intro
17+
tutorials/setup_workstation
18+
tutorials/devcontainer
19+
tutorials/epics_devcontainer
20+
tutorials/setup_k8s
21+
tutorials/create_beamline
22+
tutorials/deploy_example
23+
tutorials/ioc_changes
24+
tutorials/generic_ioc
25+
tutorials/debug_generic_ioc
26+
tutorials/test_generic_ioc
27+
tutorials/support_module
28+
tutorials/rtems_setup
29+
tutorials/rtems_ioc
3130

3231
Tutorials for installation and typical usage. New users start here.
3332

docs/user/tutorials/12_rtems_ioc.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

docs/user/tutorials/04_create_beamline.rst renamed to docs/user/tutorials/create_beamline.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ repo in the future.
120120
Make a Release of Example Beamline bl01t
121121
----------------------------------------
122122

123-
To make a release of the project we defined in `05_deploy_example`,
123+
To make a release of the project we defined in `deploy_example`,
124124
we will
125125
tag your repo with a calendar based version number see (https://calver.org/).
126126

docs/user/tutorials/08_debug_generic_ioc.rst renamed to docs/user/tutorials/debug_generic_ioc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Debugging Generic IOC Builds
22
============================
33

4-
This tutorial is a continuation of `07_generic_ioc`. Here we will look into
4+
This tutorial is a continuation of `generic_ioc`. Here we will look into
55
debugging failed builds and fix the issue we saw in the previous tutorial.
66

77
There are two ways to debug a failed build:

0 commit comments

Comments
 (0)