Merge pull request #162 from epics-containers/minor-fixes

remove redundant pages
epics-containers · Sep 4, 2024 · 755cd6c · 755cd6c
2 parents 791bfcc + 2c7cfa8
commit 755cd6c
Show file tree

Hide file tree

Showing 11 changed files with 5 additions and 281 deletions.
diff --git a/docs/explanations/introduction.md b/docs/explanations/introduction.md
@@ -230,7 +230,6 @@ line entry point is **ec**.
 
 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.
 
-See {any}`CLI` for more details.
 
 ### **ibek**
 

diff --git a/docs/genindex.md b/docs/genindex.md
diff --git a/docs/how-to/copier_update.md b/docs/how-to/copier_update.md
@@ -23,12 +23,12 @@ NOTE: generic IOCs with a given major version number template should work with b
 Updating a Beamline Repository
 ------------------------------
 
-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.
+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.
 
 To update your beamline repository to the latest version of the templates you should run the following command in the root of your repository:
 
 ```bash
-copier update -r VERSION_NUMBER --trust .
+copier update -r VERSION_NUMBER .
 ```
 
 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
 
 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.
 
-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.
+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.
 
 
 Updating a Generic IOC Repository
@@ -72,7 +72,7 @@ copier copy gh:epics-containers/ioc-template --trust .
 For the beamline case:
 
 ```bash
-copier copy gh:epics-containers/ec-services-template --trust .
+copier copy gh:epics-containers/services-template-helm .
 ```
 
 In both cases you should select Y for each notice of a conflict, then resolve those conflicts in your editor.

diff --git a/docs/how-to/phoebus.md b/docs/how-to/phoebus.md
@@ -6,4 +6,4 @@ epics-containers supports auto generation of engineering screens for Phoebus usi
 
 Auto-generation of engineering screens is now supported in generic IOCs.
 
-See here for an example https://github.com/epics-containers/example-services.
+See here for an example [example-services](https://github.com/epics-containers/example-services).
diff --git a/docs/how-to/update_generic_ioc.md b/docs/how-to/update_generic_ioc.md
diff --git a/docs/how-to/useful_k8s.md b/docs/how-to/useful_k8s.md
diff --git a/docs/reference.md b/docs/reference.md
@@ -7,6 +7,5 @@ Technical reference material including APIs and release notes.
 :glob:
 
 reference/*
-genindex
 Release Notes <https://github.com/epics-containers/epics-containers.github.io/releases>
 ```
diff --git a/docs/reference/cli.md b/docs/reference/cli.md
diff --git a/docs/reference/faq.md b/docs/reference/faq.md
@@ -2,11 +2,6 @@
 
 (no-opi)=
 
-## Why no mention of Operator Interfaces?
-
-UPDATE: with the introduction of PVI we are providing auto generated
-engineering screens. TODO: more details will be added to a new section.
-
 ## Why have ioc-XXX repositories?
 
 Why not put the Dockerfile and image generating in the support module itself

diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md
@@ -16,7 +16,6 @@ epics-containers supports two kinds of services repositories:
 
 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).
 
-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.
 
 (ibek)=
 ## ibek

diff --git a/docs/reference/vscode_settings.md b/docs/reference/vscode_settings.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -230,7 +230,6 @@ line entry point is ec.

		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.

		See {any}`CLI` for more details.

		### ibek

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ epics-containers supports auto generation of engineering screens for Phoebus usi

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

		See here for an example https://github.com/epics-containers/example-services.
		See here for an example [example-services](https://github.com/epics-containers/example-services).
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,7 +16,6 @@ epics-containers supports two kinds of services repositories: @@
     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).
-    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.
     (ibek)=
     ## ibek
@@ Expand Down @@