From 7cd8df0e15d2c8c5d0a356d392b7e62a22c74118 Mon Sep 17 00:00:00 2001 From: Andrey Yantsen Date: Sun, 4 Sep 2022 09:23:58 +0100 Subject: [PATCH] Document available docker tags (#2260) --- guides/getting_started_command_line.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/guides/getting_started_command_line.rst b/guides/getting_started_command_line.rst index 708d6b180..4f59111e3 100644 --- a/guides/getting_started_command_line.rst +++ b/guides/getting_started_command_line.rst @@ -40,6 +40,21 @@ If you want to use `docker-compose` instead, here's a sample file: privileged: true network_mode: host +The project provides multiple docker tags; please pick the one that suits you +better: + +- ``latest`` and ``stable`` point to the latest stable release available. It's + not recommended to automatically update the container based on those tags + because of the possible breaking changes between releases. +- Release-tracking tag ``YEAR.MONTH`` (e.g. ``2022.8``) points to the latest + stable patch release available within the required version. There should + never be a breaking change when upgrading the containers based on tags like + that. +- ``beta`` points to the latest released beta version, and to the latest stable + release when there is no fresh beta release. +- ``dev`` is the bleeding edge release; built daily based on the latest changes + in the ``dev`` branch. + Connecting the ESP Device -------------------------