docs: add a note explaining the sed command (#623)

* add a note explaining the sed command * add note about the version of Rockcraft that is required * Update docs/tutorials/getting-started-with-flask.rst Co-authored-by: Tiago Nobrega <[email protected]> * Update docs/tutorials/getting-started-with-flask.rst Co-authored-by: Tiago Nobrega <[email protected]> * improve wording * improve wording * improve wording --------- Co-authored-by: Tiago Nobrega <[email protected]>
canonical · Aug 27, 2024 · 93c3666 · 93c3666
1 parent 75be831
commit 93c3666
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/tutorial/flask.rst b/docs/tutorial/flask.rst
@@ -12,6 +12,13 @@ Setup
 
 .. include:: /reuse/tutorial/setup.rst
 
+.. note::
+    This tutorial requires version ``1.5.2`` or later for Rockcraft. Check
+    your version using ``rockcraft --version``. If you have an older version
+    of Rockcraft installed, use
+    ``sudo snap refresh rockcraft --channel latest/stable`` to get the latest
+    stable version.
+
 Finally, create a new directory for this tutorial and go inside it:
 
 .. code-block:: bash
@@ -249,6 +256,11 @@ In ``rockcraft.yaml``, change the ``base`` to ``bare`` and add
     :end-before: [docs:change-base-end]
     :dedent: 2
 
+.. note::
+    The ``sed`` command replaces the current ``base`` in ``rockcraft.yaml`` with
+    the ``bare`` base. The command also adds a ``build-base`` which is required
+    when using the ``bare`` base.
+
 Pack the rock with the new ``bare`` :ref:`base <bases_explanation>`:
 
 .. literalinclude:: code/flask/task.yaml