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

tidy python version instructions, fix profile references

Author: gilesknap

docs/reference/docker.md

@@ -13,7 +13,7 @@ We do fully support `docker`, please report any issues you find.
 
 There are a few things to know if you are using `docker` in your developer containers:
 
-1. add `export EC_REMOTE_USER=$USER` into your `~/.profile`. The epics-containers devcontainer.json files will use this to set the account that your user will use inside devcontainers.
+1. add `export EC_REMOTE_USER=$USER` into your `$HOME/.profile`. The epics-containers devcontainer.json files will use this to set the account that your user will use inside devcontainers.
 1. you may need to tell git that you are ok with the repository permissions. `vscode` may ask you about this or you may need to do the command:
     ```bash
     git config --global --add safe.directory <Git folder>

docs/reference/environment.md

@@ -1,5 +1,14 @@
 # The Environment Configuration File
 
+:::{warning}
+This page is out of date - the environment.sh varies depending on the type of project:
+- services using compose
+- services using helm
+- deployment
+
+This page needs to be updated to reflect the different types of environment.sh files.
+:::
+
 `environment.sh` is a configuration file that is provided in each domain
 (beamline or accelerator) repository. It is used to set up the environment
 such that the `epics-containers-cli` will interact with the correct
@@ -77,17 +86,16 @@ The second section of the `environment.sh` file is used to install the
 it would probably be best to have `ec` installed globally on your
 workstation and then omit this section from your `environment.sh` files.
 
-Perhaps the simplest way to achieve this is to install `ec` into your user
-space using the following command:
+Perhaps the simplest way to achieve this is to install `ec` into your user space using the following command:
 
 ```bash
-pip install --user epics-containers-cli
+pip install --user ec-cli
 ```
 
-Then add the following to your `.bashrc` file:
+Then add the following to your `$HOME/.profile` file:
 
 ```bash
-export PATH=$PATH:$HOME/.local/bin
+PATH=$PATH:$HOME/.local/bin
 ```
 
 ## Connecting to a Namespace on your Kubernetes Cluster

docs/tutorials/dev_container.md

@@ -154,7 +154,7 @@ Users of docker need to instruct the devcontainer to use their own user id insid
 export EC_REMOTE_USER=$USER
 ```
 
-It is recommended that you place this command in **.profile** to make it permanent.
+It is recommended that you place this command in `$HOME/.profile` to make it permanent.
 
 If you do not do this, your devcontainer will run as root. Although it will still work, it is not recommended. Also, forgetting to set EC_REMOTE_USER before launching a pre-existing devcontainer will cause errors. (my apologies to docker users - I wanted to make the devcontainer compatible with both docker and podman and this is the least invasive method I could come up with).
 :::

docs/tutorials/setup_workstation.md

@@ -144,7 +144,7 @@ From here on when we refer to `docker` in a command line, you can replace it wit
 ```bash
 alias docker=podman
 ```
-in your `.bashrc` file.
+in your `$HOME/.profile` file.
 
 `docker` users should also take a look at this page: [](../reference/docker.md) which describes a couple of extra steps that are required to make docker work in developer containers.
 
@@ -176,7 +176,7 @@ podman completion zsh > ~/.oh-my-zsh/completions/_podman
 **DLS Users**: for this step just use `module load python/3.11`
 :::
 
-Go ahead and install Python 3.11 or later.
+Go ahead and install Python if it is not already installed, the minimum version you should use is 3.10. Virtualbox Appliance users will already have Python 3.10 installed.
 
 There are instructions for installing Python on all platforms here:
 <https://docs.python-guide.org/starting/installation/>
@@ -198,7 +198,7 @@ source $HOME/ec-venv/bin/activate
 python3 -m pip install --upgrade pip
 ```
 
-Note that each time you open a new shell you will need to activate the virtual environment again. (Or place its bin folder in your path by adding `PATH=$HOME/ec-venv/bin:$PATH` in your .bashrc).
+Note that each time you open a new shell you will need to activate the virtual environment again. (Or place its bin folder in your path by adding `PATH=$HOME/ec-venv/bin:$PATH` in your `$HOME/.profile`).
 
 (copier)=