Merge pull request #129 from epics-containers/tidyup

tidy some formatting

Author: gilesknap

docs/conf.py

@@ -105,7 +105,11 @@
 inheritance_graph_attrs = {"rankdir": "TB"}
 
 # Ignore localhost links for periodic check that links in docs are valid
-linkcheck_ignore = [r"http://localhost:\d+/"]
+linkcheck_ignore = [
+    r"http://localhost:\d+/",
+    "https://gitlab.diamond.ac.uk/.*",
+    "https://dev-portal.diamond.ac.uk/.*",
+]
 
 # Set copy-button to ignore python and bash prompts
 # https://sphinx-copybutton.readthedocs.io/en/latest/use.html#using-regexp-prompt-identifiers

docs/overview.md

@@ -5,6 +5,9 @@ There are 5 themes to this strategy:
 
 ```{eval-rst}
 
+:Containers:
+  Package IOC software and execute it in a lightweight virtual environment​
+
 :Kubernetes:
   Centrally orchestrates all IOCs at a facility.
 

docs/tutorials/generic_ioc.md

@@ -674,7 +674,7 @@ you can:
 - stop the IOC with `ctrl-d` in the ioc shell
 - start the IOC with `./start.sh`
 
-# Wrapping Up
+## Wrapping Up
 
 For the final step we will get the Generic IOC container image published to GHCR. This means committing all our changes and pushing them up to GitHub so that the Continuous Integration system can build the container image and publish it.
 

docs/tutorials/setup_k8s_new_beamline.md

@@ -81,7 +81,7 @@ Answer the copier template questions as follows:
 DLS Users: These instructions are for the BL46P beamline. This beamline is a training rig and it is OK to install some test Simulation IOCs on it. However you will need to get access before you can deploy to it. Ask giles to request access to the `p46-iocs` namespace on the `pollux` cluster. In future the ec-services-template will be updated to allow you to deploy IOCs to your own namespace on the `pollux` cluster.
 :::
 
-# Review the New Beamline Repository
+## Review the New Beamline Repository
 
 The following sections are just a review of what the template project created. Those of you who are outside of DLS can use this as a guide to what you need to set up in your own beamline repository to talk you your own cluster. DLS users will already have these things set up by the copier template to talk to the p46-iocs namespace on pollux cluster. If you believe your repo is already configured to talk to your cluster then you could jump ahead to [](create-test-ioc-k8s).
 
@@ -277,7 +277,7 @@ dataVolume:
   hostPath: /dls/p46/data
 ```
 (create-test-ioc-k8s)=
-# Create a Test IOC to Deploy
+## Create a Test IOC to Deploy
 
 TODO: This is work in progress (but essentially just repeat what we did in [](deploy-example-instance)).
 

docs/tutorials/setup_workstation.md

@@ -108,7 +108,7 @@ work. In the examples we will use `$HOME/ec-venv` as the virtual environment
 but you can choose any folder.
 
 :::{Note}
-**DLS Users**: As `$HOME` is a network drive it has an 8GB limit, consider other locations such as `/dls/science/` or `/scratch/`. Read more [here]([url](https://gitlab.diamond.ac.uk/sscc-docs/developer-guide/-/issues/13))
+**DLS Users**: As `$HOME` is a network drive it has an 8GB limit, consider other locations such as `/dls/science/` or `/scratch/`. Read more [here](https://dev-portal.diamond.ac.uk/guide/developer-environment/how-tos/disk-quota-troubleshooting/)
 :::
 
 ```bash