diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 7c82cdfe..b4863eea 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -9,14 +9,6 @@ your time coding something that might not fit the scope of the project. .. _GitHub: https://github.com/PandABlocks/PandABlocks-ioc/issues -Issue or Discussion? --------------------- - -Github also offers discussions_ as a place to ask questions and share ideas. If -your issue is open ended and it is not obvious when it can be "closed", please -raise it as a discussion instead. - -.. _discussions: https://github.com/PandABlocks/PandABlocks-ioc/discussions Code coverage ------------- @@ -32,4 +24,4 @@ The `Developer Guide`_ contains information on setting up a development environment, running the tests and what standards the code and documentation should follow. -.. _Developer Guide: https://diamondlightsource.github.io/PandABlocks-ioc/main/developer/how-to/contribute.html +.. _Developer Guide: https://pandablocks.github.io/PandABlocks-ioc/main/developer/how-to/contribute.html diff --git a/docs/user/how-to/run-container.rst b/docs/user/how-to/run-container.rst index 00cbe2af..11865bf7 100644 --- a/docs/user/how-to/run-container.rst +++ b/docs/user/how-to/run-container.rst @@ -3,13 +3,16 @@ Run in a container Pre-built containers with PandABlocks-ioc and its dependencies already installed are available on `Github Container Registry -`_. +`_. Starting the container ---------------------- -To pull the container from github container registry and run:: +To pull the container from github container registry run:: - $ docker run ghcr.io/PandABlocks/PandABlocks-ioc:main --version + $ docker run ghcr.io/pandablocks/pandablocks-ioc --version -To get a released version, use a numbered release instead of ``main``. +This will pull the latest release. To get a different release, append the +version number to the end:: + + $ docker run ghcr.io/pandablocks/pandablocks-ioc:0.2.1 --version \ No newline at end of file