diff --git a/online-docs/pages/Developer guide/Developer build/docker-developer.rst b/online-docs/pages/Developer guide/Developer build/docker-developer.rst index 1f8d496f1..ab7e3ba09 100644 --- a/online-docs/pages/Developer guide/Developer build/docker-developer.rst +++ b/online-docs/pages/Developer guide/Developer build/docker-developer.rst @@ -2,16 +2,29 @@ Creating a Docker image ======================= +Overview +-------- + +Docker simplifies COMPAS deployment by containerizing all dependencies and build tools, +eliminating manual environment configuration across different operating systems and platforms. +This enables reliable deployment on cloud platforms and consistent development environments. + +For information on how to use Docker to run COMPAS, see the :doc:`../../User guide/docker` page. + + GitHub CI/CD ------------ -``Docker`` images of all versions of COMPAS (``dev`` branch) are available at the -`TeamCOMPAS dockerHub page `__. Building of these images is performed automatically by the -``GitHub`` CI/CD process. +``Docker`` images of all versions of COMPAS (``dev`` branch) are available at: + + - `TeamCOMPAS dockerHub page `__ + - `GitHub Container Registry `__ + +Building of these images is performed automatically by the ``GitHub`` CI/CD process. Whenever a push to `TeamCOMPAS/dev `__ occurs, a continuous deployment process automatically -builds\ [#f1]_ a new image and deploys it to ``dockerHub`` with a `tag`\ [#f2]_ that corresponds to the value of ``VERSION_STRING`` +builds\ [#f1]_ a new image and deploys it to both ``dockerHub`` and the ``GitHub Container Registry`` with a `tag`\ [#f2]_ that corresponds to the value of ``VERSION_STRING`` in ``changelog.h`` (see :doc:`../changelog` for detailed information regarding ``changelog.h``). At time of writing, `GitHub Actions`\ [#f3]_ facilitates the above process. While this is convenient (because it's free and well @@ -24,6 +37,25 @@ See the `Atlassian CI/CD `__. + + Dockerfile ----------