remove or flag out of date info

gilesknap · gilesknap · commit b202295bc28b · 2023-10-26T13:33:44.000+01:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,13 +5,9 @@
 
 Update for October 2023
 =======================
-The final round of improvements are done. The latest framework has
-become much simpler and has a good developer experience.
-
-**WARNING**
-
-The Tutorials are currently out of date and won't work. These are
-being updated now and will be available by end of November 2023.
+The tutorials are being updated to work with the improved framework.
+The first few are available now, take note of warnings about out of
+date tutorials.
 
 
 Communication
diff --git a/docs/user/explanations/kubernetes_cluster.rst b/docs/user/explanations/kubernetes_cluster.rst
@@ -37,7 +37,7 @@ Three cluster topologies were considered for this project.
 Current Approach
 ----------------
 
-DLS is currently investigating Cluster per Beamline as the preferred topology. We
+DLS is using Cluster per Beamline as the preferred topology. We
 will continue to have a central cluster for shared services but in addition will
 have a cluster per beamline and a cluster for the accelerator.
 
diff --git a/docs/user/explanations/repos.rst b/docs/user/explanations/repos.rst
diff --git a/docs/user/how-to/ibek-support.rst b/docs/user/how-to/ibek-support.rst
@@ -1,8 +1,9 @@
-Updating and Testing ibek-defs
-==============================
+Updating and Testing ibek-support
+=================================
 
-TODO: this is draft
-TODO: this uses a Diamond internal repo as an example
+.. Warning::
+
+    This is draft only and out of date. It will be updated soon.
 
 The ibek-defs repository contains ibek support yaml. Here is an example
 procedure for local testing of changes to support yaml in ibek-defs
diff --git a/docs/user/how-to/run_iocs.rst b/docs/user/how-to/run_iocs.rst
diff --git a/docs/user/how-to/update_templated.rst b/docs/user/how-to/update_templated.rst
diff --git a/docs/user/how-to/useful_k8s.rst b/docs/user/how-to/useful_k8s.rst
@@ -11,7 +11,8 @@ The dashboard gives you a nice GUI for exploring and controlling your cluster.
 It is very useful for new users to get an understanding of what Kubernetes
 has to offer.
 
-These commands should be run INSIDE the devcontainer.
+These commands should be run after you have set up your Kubernetes cluster and
+setup the environment variables as described in `../tutorials/setup_k8s`.
 
 Execute this on your workstation:
 
@@ -48,10 +49,6 @@ Then create the admin user and role by executing the following:
 
 Get a token for the user and copy the token into your clipboard.
 
-On k3s v1.23 and older::
-
-    kubectl -n kubernetes-dashboard describe secret admin-user-token | grep '^token'
-
 On k3s v1.24 and newer::
 
     kubectl -n kubernetes-dashboard create token admin-user
diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -36,13 +36,11 @@ side-bar.
             :caption: How-to Guides
             :maxdepth: 1
 
-            how-to/run_iocs
             how-to/debug
             how-to/contributing
             how-to/own_tools
             how-to/useful_k8s
-            how-to/update_templated
-            how-to/ibek-defs
+            how-to/ibek-support
 
         +++
 
@@ -59,7 +57,6 @@ side-bar.
             explanations/kubernetes_cluster
             explanations/docs-structure
             explanations/repositories
-            explanations/repos
 
         +++
 
diff --git a/docs/user/reference/ioc_helm_chart.rst b/docs/user/reference/ioc_helm_chart.rst
@@ -1,6 +1,10 @@
 IOC Helm Chart Details
 ======================
 
+.. Warning::
+
+    This page is out of date and will be updated soon.
+
 IOC instances are described using a helm chart which in turn generates
 a Kubernetes manifest to tell Kubernetes what resources to create in order
 to run the IOC instance.
diff --git a/docs/user/tutorials/generic_ioc.rst b/docs/user/tutorials/generic_ioc.rst
@@ -57,9 +57,6 @@ using an ``ec`` command.
         git remote add origin git@github.com:<YOUR USER NAME>/ioc-adurl.git
         git push --set-upstream origin main
 
-Note that creating your project in this way means it is possible to
-synchronize changes from the original ioc-template project.
-See `../how-to/update_templated`.
 
 Prepare the New Repo for Development
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -258,11 +255,6 @@ follows:
 ADCore and ADSupport already have ibek-defs files as they were previously created
 when making ``ioc-adsimdetector``.
 
-.. note::
-
-    The folder /repos is where all externally fetched source code is stored
-    inside our containers. For a detailed explanation see
-    `../explanations/repos`
 
 .. _CONFIG_SITE.local: https://areadetector.github.io/areaDetector/install_guide.html#edit-config-site-local-and-optionally-config-site-local-epics-host-arch
 
diff --git a/docs/user/tutorials/ibek.rst b/docs/user/tutorials/ibek.rst
@@ -66,7 +66,7 @@ TODO: this will become a concrete example for walking through as a tutorial with
 NOTE: these steps are for building and testing the example IOC that comes with
 the Generic ioc template. This will break the system test and that would need
 to be updated accordingly. To just work on ibek support files using an external
-ioc instance YAML file see `../how-to/ibek-defs` (I probably need to combine
+ioc instance YAML file see `../how-to/ibek-support` (I probably need to combine
 these two pages into something coherent).
 
 
diff --git a/docs/user/tutorials/setup_k8s.rst b/docs/user/tutorials/setup_k8s.rst
@@ -47,9 +47,6 @@ ready to test deployment of EPICS IOCs.
     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
-    take on Kubernetes then there are some hints as to how to achieve this
-    here: `../how-to/run_iocs`.
 
 Bring Your Own Cluster
 ----------------------
