Skip to content

Commit 755cd6c

Browse files
authored
Merge pull request #162 from epics-containers/minor-fixes
remove redundant pages
2 parents 791bfcc + 2c7cfa8 commit 755cd6c

File tree

11 files changed

+5
-281
lines changed

11 files changed

+5
-281
lines changed

docs/explanations/introduction.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,6 @@ line entry point is **ec**.
230230

231231
The project is a python package featuring simple command line functions for deploying and monitoring IOC instances. It is a thin wrapper around the ArgoCD, kubectl, helm and git commands. This tool can be used by developers and beamline staff to get a quick CLI based view of IOCs running in the cluster, as well as stop/start and obtain logs from them.
232232

233-
See {any}`CLI` for more details.
234233

235234
### **ibek**
236235

docs/genindex.md

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

docs/how-to/copier_update.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ NOTE: generic IOCs with a given major version number template should work with b
2323
Updating a Beamline Repository
2424
------------------------------
2525

26-
A beamline (or other grouping) repository is a collection of IOC instances and services that are deployed together. The beamline repository is created using the `ec-services-template` copier template. See [](../tutorials/create_beamline.md) for the tutorial on how to create a new beamline repository.
26+
A beamline (or other grouping) repository is a collection of IOC instances and services that are deployed together. The beamline repository is created using the `services-template-helm` copier template. See [](../tutorials/create_beamline.md) for the tutorial on how to create a new beamline repository.
2727

2828
To update your beamline repository to the latest version of the templates you should run the following command in the root of your repository:
2929

3030
```bash
31-
copier update -r VERSION_NUMBER --trust .
31+
copier update -r VERSION_NUMBER .
3232
```
3333

3434
You can supply the VERSION_NUMBER of the template you want or omit the `-r` option to get the latest released version.
@@ -37,7 +37,7 @@ This will update your project in place. You should then inspect the changes usin
3737

3838
The template comes with an example IOC called xxxx-ea-test-01. You are free to delete this if you don't want it. However, we recommend keeping that IOC as it is a good reference for what changes might be needed in your own IOC instances.
3939

40-
For example, in version 3.4.0 the `ec-services-template` changed the way that the configmap is created for each IOC instance. This added a soft-link **templates** folder that points at **../../include/ioc/templates**. Looking at what changes happened in the example IOC will help you to understand what changes you might need to make in your own IOC instances. Copier migrations will attempt to make these changes for you but it is recommended to check that they have been done correctly.
40+
For example, in version 3.4.0 the `services-template-helm` changed the way that the configmap is created for each IOC instance. This added a soft-link **templates** folder that points at **../../include/ioc/templates**. Looking at what changes happened in the example IOC will help you to understand what changes you might need to make in your own IOC instances. Copier migrations will attempt to make these changes for you but it is recommended to check that they have been done correctly.
4141

4242

4343
Updating a Generic IOC Repository
@@ -72,7 +72,7 @@ copier copy gh:epics-containers/ioc-template --trust .
7272
For the beamline case:
7373

7474
```bash
75-
copier copy gh:epics-containers/ec-services-template --trust .
75+
copier copy gh:epics-containers/services-template-helm .
7676
```
7777

7878
In both cases you should select Y for each notice of a conflict, then resolve those conflicts in your editor.

docs/how-to/phoebus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ epics-containers supports auto generation of engineering screens for Phoebus usi
66

77
Auto-generation of engineering screens is now supported in generic IOCs.
88

9-
See here for an example https://github.com/epics-containers/example-services.
9+
See here for an example [example-services](https://github.com/epics-containers/example-services).

docs/how-to/update_generic_ioc.md

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

docs/how-to/useful_k8s.md

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

docs/reference.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,5 @@ Technical reference material including APIs and release notes.
77
:glob:
88
99
reference/*
10-
genindex
1110
Release Notes <https://github.com/epics-containers/epics-containers.github.io/releases>
1211
```

docs/reference/cli.md

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

docs/reference/faq.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@
22

33
(no-opi)=
44

5-
## Why no mention of Operator Interfaces?
6-
7-
UPDATE: with the introduction of PVI we are providing auto generated
8-
engineering screens. TODO: more details will be added to a new section.
9-
105
## Why have ioc-XXX repositories?
116

127
Why not put the Dockerfile and image generating in the support module itself

docs/reference/glossary.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ epics-containers supports two kinds of services repositories:
1616

1717
A Python command line tool for the developer that runs *outside* of containers. It provides simple features for and monitoring and managing and IOC instances within a [](services-repo).
1818

19-
So named 'edge' containers because these services all run close to the hardware. Uses the command line entry point `ec`. See {std:ref}`cli` for more details.
2019

2120
(ibek)=
2221
## ibek

0 commit comments

Comments
 (0)