Skip to content

Commit e7c28c5

Browse files
committed
fix readme links
1 parent d62daec commit e7c28c5

File tree

3 files changed

+17
-47
lines changed

3 files changed

+17
-47
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ See `Essential Concepts`_ and the `Getting Started Guide`_ .
1010

1111
Please contribute with comments and suggestions in the wiki or issues pages:
1212

13-
.. _Essential Concepts: https://epics-containers.github.io/user/explanations/introduction.html
14-
.. _Getting Started Guide: https://epics-containers.github.io/user/tutorials/intro.html
13+
.. _Essential Concepts: https://epics-containers.github.io/main/user/explanations/introduction.html
14+
.. _Getting Started Guide: https://epics-containers.github.io/main/user/tutorials/intro.html
1515

1616
============== ==============================================================
1717
Documentation https://epics-containers.github.io

docs/index.rst

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,23 @@
33
.. include:: ../README.rst
44
:end-before: when included in index.rst
55

6-
Quick Start
7-
===========
8-
9-
For a set of tutorials to introduce the concepts of epics-containers see
10-
`user/tutorials/intro`. For a description of the architecture see
11-
`essential`.
12-
13-
146
Update for October 2023
157
=======================
16-
The final round of improvements are under way. The latest framework has
8+
The final round of improvements done. The latest framework has
179
become much simpler and has a good developer experience.
1810

19-
The Tutorials are currently out of date and won't work. These should be
20-
updated to the new Epics Containers Framework by end of Nov 2023.
21-
22-
Update for March 2023
23-
=====================
11+
**WARNING**
2412

25-
Since the documentation for epics-containers was first published in Oct 2021,
26-
there have been significant updates to the projects in this organization.
13+
The Tutorials are currently out of date and won't work. These are
14+
being updated now and will be available by end of November 2023.
2715

28-
The documentation is now being updated to reflect these changes.
29-
30-
Notable improvements are:
31-
32-
- The developer experience has now been improved.
33-
34-
- Addition of a developer container with all the necessary tools included
35-
- Addition of a CLI tool to assist building deploying and managing
36-
containerize EPICS IOCs.
16+
Quick Start
17+
===========
3718

38-
- simplified container build approach which minimizes cache busting and
39-
improves build times.
19+
For a set of tutorials to introduce the concepts of epics-containers see
20+
`user/tutorials/intro`. For a description of the architecture see
21+
`essential`.
4022

41-
- Addition of support for IOCS running on MVME5500 with RTEMS 5. (this
42-
could be extended to any cross-compiled architectures that use a
43-
telnet shell and get their binaries from share file-systems (such as TFTP
44-
or NFS))
4523

4624

4725
Communication

docs/user/reference/faq.rst

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,8 @@ Frequently Asked Questions
55

66
Why no mention of Operator Interfaces?
77
--------------------------------------
8-
OPI was out of scope for the proof of concept. That is because we
9-
expect there to be a web based EPICS OPI available by the time we go
10-
live with K8s IOCs. Kubernetes is very well suited to running web
11-
servers so this is a natural fit.
12-
13-
There are a number of ways to support the current OPI solutions without
14-
breaking the repositories-only model. The simplest approach is to extract
15-
the OPI files from the container running in Kubernetes with **kubectl cp**.
16-
Then keep a local cache and run the OPI code locally.
8+
UPDATE: with the introduction of PVI we are providing auto generated
9+
engineering screens. TODO: more details will be added to a new section.
1710

1811

1912
Why have ioc-XXX repositories?
@@ -51,10 +44,9 @@ It is also necessary for Kubernetes to be able to pull the Generic IOC image. If
5144
the beamline has only one Kubernetes worker node then the previous image will
5245
be in the node's local cache. If you have more than one then you will need
5346
a global image cache which is useful anyway for reducing traffic to the
54-
registries (JetStack have performed a POC for DLS that demonstrates such a
55-
global cache)
47+
registries. At DLS we have a global cache for all container registry
48+
interactions, it uses Harbour. See https://goharbor.io/ for more details.
5649

5750
Note that making changes to an IOC and spinning them up would not be possible
58-
if all registries were in the cloud. However it is recommended that the 'work'
59-
registries are on prem. The production helm registry is also likely to be on
60-
prem since there is little benefit in sharing a facility's IOC instances.
51+
if all registries were in the cloud and the internet connection had failed.
52+
However it is recommended that the 'work' registries are on premises.

0 commit comments

Comments
 (0)