From 68c3a9fb855f7c19b26d435fb356f0fc5654fc48 Mon Sep 17 00:00:00 2001 From: behnazh-w Date: Fri, 1 Sep 2023 15:01:22 +1000 Subject: [PATCH 1/2] docs: fix the title overline in cli_usage/index.rst Signed-off-by: behnazh-w --- docs/source/pages/cli_usage/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/pages/cli_usage/index.rst b/docs/source/pages/cli_usage/index.rst index 041537a2b..267e5485d 100644 --- a/docs/source/pages/cli_usage/index.rst +++ b/docs/source/pages/cli_usage/index.rst @@ -49,9 +49,9 @@ Common Options The directory where Macaron looks for already cloned repositories. ------------ +------------------ Common Environment ------------ +------------------ ``MACARON_IMAGE_TAG`` – The tag to use for the Macaron docker image ``DOCKER_PULL`` – Whether to pull docker image from registry, must be one of: always, missing, never (default: always) From 89b8154d4157c30c00d206816a86e039daac109c Mon Sep 17 00:00:00 2001 From: behnazh-w Date: Fri, 1 Sep 2023 15:16:38 +1000 Subject: [PATCH 2/2] docs: fix bullet points and add a link to the registry Signed-off-by: behnazh-w --- docs/source/pages/cli_usage/index.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/pages/cli_usage/index.rst b/docs/source/pages/cli_usage/index.rst index 267e5485d..9fba40d65 100644 --- a/docs/source/pages/cli_usage/index.rst +++ b/docs/source/pages/cli_usage/index.rst @@ -49,12 +49,13 @@ Common Options The directory where Macaron looks for already cloned repositories. ------------------- -Common Environment ------------------- +--------------------- +Environment Variables +--------------------- -``MACARON_IMAGE_TAG`` – The tag to use for the Macaron docker image -``DOCKER_PULL`` – Whether to pull docker image from registry, must be one of: always, missing, never (default: always) +* ``MACARON_IMAGE_TAG``: The Docker image tag for a specific version of Macaron. + +* ``DOCKER_PULL``: Whether to pull the Docker image from the `GitHub Container registry `_; must be one of: ``always``, ``missing``, ``never`` (default: ``always``). --------------- Action Commands