rename to stable_flwr_version

Signed-off-by: Robert Steiner <robert@flower.ai>

doc/source/conf.py

@@ -93,7 +93,7 @@
 # The current released version
 rst_prolog = """
 .. |stable_flwr_version| replace:: 1.10.0
-.. |latest_flwr_superlink_docker_digest| replace:: 4b317d5b6030710b476f4dbfab2c3a33021ad40a0fcfa54d7edd45e0c51d889c
+.. |stable_flwr_superlink_docker_digest| replace:: 4b317d5b6030710b476f4dbfab2c3a33021ad40a0fcfa54d7edd45e0c51d889c
 .. |ubuntu_version| replace:: 22.04
 .. |setuptools_version| replace:: 70.3.0
 .. |pip_version| replace:: 24.1.2

doc/source/contributor-how-to-build-docker-images.rst

@@ -111,7 +111,7 @@ For example, to build a SuperLink image with the latest Flower version, Python 3
 
    $ cd src/docker/superlink
    $ docker build \
-     --build-arg BASE_IMAGE=|current_flwr_version|-py3.10-ubuntu22.04 \
+     --build-arg BASE_IMAGE=|stable_flwr_version|-py3.10-ubuntu22.04 \
      -t flwr_superlink:0.1.0 .
 
 If you want to use your own base image instead of the official Flower base image, all you need to do

doc/source/docker/persist-superlink-state.rst

@@ -28,7 +28,7 @@ database file.
    $ mkdir state
    $ sudo chown -R 49999:49999 state
    $ docker run --rm \
-        --volume ./state/:/app/state flwr/superlink:|current_flwr_version| \
+        --volume ./state/:/app/state flwr/superlink:|stable_flwr_version| \
         --database state.db \
         ...
 

doc/source/docker/pinning-version.rst

@@ -11,20 +11,20 @@ Example
 -------
 
 The following command returns the current image digest referenced by the
-:substitution-code:`superlink:|current_flwr_version|` tag:
+:substitution-code:`superlink:|stable_flwr_version|` tag:
 
 .. code-block:: bash
    :substitutions:
 
-   $ docker pull flwr/superlink:|current_flwr_version|
-   $ docker inspect --format='{{index .RepoDigests 0}}' flwr/superlink:|current_flwr_version|
+   $ docker pull flwr/superlink:|stable_flwr_version|
+   $ docker inspect --format='{{index .RepoDigests 0}}' flwr/superlink:|stable_flwr_version|
 
 This will output
 
 .. code-block:: bash
    :substitutions:
 
-   flwr/superlink@sha256:|latest_flwr_superlink_docker_digest|
+   flwr/superlink@sha256:|stable__flwr_superlink_docker_digest|
 
 Next, we can pin the digest when running a new SuperLink container:
 

doc/source/docker/root-user.rst

@@ -16,7 +16,7 @@ Run the Docker image with the ``-u`` flag and specify ``root`` as the username:
 .. code-block:: bash
    :substitutions:
 
-   $ docker run --rm -u root flwr/superlink:|current_flwr_version|
+   $ docker run --rm -u root flwr/superlink:|stable_flwr_version|
 
 This command will run the Docker container with root user privileges.
 
@@ -30,7 +30,7 @@ missing system dependencies, you can use the ``USER root`` directive within your
    :caption: SuperNode Dockerfile
    :substitutions:
 
-   FROM flwr/supernode:|current_flwr_version|
+   FROM flwr/supernode:|stable_flwr_version|
 
    # Switch to root user
    USER root

doc/source/docker/set-environment-variables.rst

@@ -11,4 +11,4 @@ Example
    :substitutions:
 
    $ docker run -e FLWR_TELEMETRY_ENABLED=0 -e FLWR_TELEMETRY_LOGGING=0 \
-        --rm flwr/superlink:|current_flwr_version|
+        --rm flwr/superlink:|stable_flwr_version|

doc/source/docker/tls.rst

@@ -93,7 +93,7 @@ certificate into the container's ``/app/`` directory.
    * | ``--volume ./ca.crt:/app/ca.crt/:ro``: Mount the ``ca.crt`` file from the
      | current working directory of the host machine as a read-only volume at the ``/app/ca.crt``
      | directory inside the container.
-   * | :substitution-code:`flwr/supernode:|current_flwr_version|`: The name of the image to be run and the specific
+   * | :substitution-code:`flwr/supernode:|stable_flwr_version|`: The name of the image to be run and the specific
      | tag of the image. The tag :substitution-code:`|stable_flwr_version|` represents a specific version of the image.
    * | ``--root-certificates ca.crt``: This specifies the location of the CA certificate file
      | inside the container.
@@ -130,7 +130,7 @@ Assuming all files we need are in the local ``certificates`` directory where the
      |
      | This allows the container to access the TLS certificates that are stored in the certificates
      | directory.
-   * | :substitution-code:`flwr/superexec:|current_flwr_version|`: The name of the image to be run and the specific
+   * | :substitution-code:`flwr/superexec:|stable_flwr_version|`: The name of the image to be run and the specific
      | tag of the image. The tag :substitution-code:`|stable_flwr_version|` represents a specific version of the image.
    * | ``--ssl-ca-certfile certificates/ca.crt``: Specify the location of the CA certificate file
      | inside the container.

doc/source/docker/tutorial-quickstart-docker.rst

@@ -59,7 +59,7 @@ Open your terminal and run:
          --network flwr-network \
          --name superlink \
          --detach \
-         flwr/superlink:|current_flwr_version| --insecure
+         flwr/superlink:|stable_flwr_version| --insecure
 
 .. dropdown:: Understand the command
 
@@ -71,8 +71,8 @@ Open your terminal and run:
    * ``--network flwr-network``: Make the container join the network named ``flwr-network``.
    * ``--name superlink``: Assign the name ``superlink`` to the container.
    * ``--detach``: Run the container in the background, freeing up the terminal.
-   * | :substitution-code:`flwr/superlink:|current_flwr_version|`: The name of the image to be run and the specific
-     | tag of the image. The tag :substitution-code:`|current_flwr_version|` represents a :doc:`specific version <pinning-version>` of the image.
+   * | :substitution-code:`flwr/superlink:|stable_flwr_version|`: The name of the image to be run and the specific
+     | tag of the image. The tag :substitution-code:`|stable_flwr_version|` represents a :doc:`specific version <pinning-version>` of the image.
    * | ``--insecure``: This flag tells the container to operate in an insecure mode, allowing
      | unencrypted communication.
 
@@ -89,7 +89,7 @@ building your own SuperNode image.
       :linenos:
       :substitutions:
 
-      FROM flwr/supernode:|current_flwr_version|
+      FROM flwr/supernode:|stable_flwr_version|
 
       WORKDIR /app
       COPY pyproject.toml .
@@ -103,8 +103,8 @@ building your own SuperNode image.
 
    .. dropdown:: Understand the Dockerfile
 
-      * | :substitution-code:`FROM flwr/supernode:|current_flwr_version|`: This line specifies that the Docker image
-        | to be built from is the ``flwr/supernode image``, version :substitution-code:`|current_flwr_version|`.
+      * | :substitution-code:`FROM flwr/supernode:|stable_flwr_version|`: This line specifies that the Docker image
+        | to be built from is the ``flwr/supernode image``, version :substitution-code:`|stable_flwr_version|`.
       * | ``WORKDIR /app``: Set the working directory for the container to ``/app``.
         | Any subsequent commands that reference a directory will be relative to this directory.
       * | ``COPY docker_pyproject.toml pyproject.toml``: Copy the ``pyproject.toml`` file
@@ -204,7 +204,7 @@ Flower and serves as a base for building your own SuperExec image.
       :caption: Dockerfile.superexec
       :substitutions:
 
-      FROM flwr/superexec:|current_flwr_version|
+      FROM flwr/superexec:|stable_flwr_version|
 
       WORKDIR /app
       COPY docker_pyproject.toml pyproject.toml
@@ -214,8 +214,8 @@ Flower and serves as a base for building your own SuperExec image.
 
    .. dropdown:: Understand the Dockerfile
 
-      * | :substitution-code:`FROM flwr/superexec:|current_flwr_version|`: This line specifies that the Docker image
-        | to be built from is the ``flwr/superexec image``, version :substitution-code:`|current_flwr_version|`.
+      * | :substitution-code:`FROM flwr/superexec:|stable_flwr_version|`: This line specifies that the Docker image
+        | to be built from is the ``flwr/superexec image``, version :substitution-code:`|stable_flwr_version|`.
       * | ``WORKDIR /app``: Set the working directory for the container to ``/app``.
         | Any subsequent commands that reference a directory will be relative to this directory.
       * | ``COPY docker_pyproject.toml pyproject.toml``: Copy the ``docker_pyproject.toml`` file