diff --git a/docs/how-to/build-a-12-factor-app-rock.rst b/docs/how-to/build-a-12-factor-app-rock.rst index 6d7445b52..51336fb86 100644 --- a/docs/how-to/build-a-12-factor-app-rock.rst +++ b/docs/how-to/build-a-12-factor-app-rock.rst @@ -18,8 +18,8 @@ the root of the project: - ``static`` - ``templates`` -To change this, the following snippet needs to be added to -the ``rockcraft.yaml``: +To change this list, add the following snippet to the +``rockcraft.yaml``: .. tabs:: @@ -134,8 +134,20 @@ Update and deploy the OCI image 1. Make sure that any new files will be included in the new OCI image. 2. Run ``rockcraft pack`` to create the new OCI image. - 3. Run ``rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false oci-archive: docker://localhost:32000/:`` to upload the OCI image to the local Docker registry. - 4. Run ``juju refresh --path= --resource flask-app-image=:>`` to deploy the new OCI image. + 3. To upload the OCI image to the local Docker registry, run: + + .. code-block:: bash + + rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false \ + oci-archive: \ + docker://localhost:32000/: + + 4. To deploy the new OCI image, run: + + .. code-block:: bash + + juju refresh --path= \ + --resource flask-app-image=:> .. group-tab:: Django @@ -143,8 +155,20 @@ Update and deploy the OCI image 1. Make sure that any new files will be included in the new OCI image. 2. Run ``rockcraft pack`` to create the new OCI image. - 3. Run ``rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false oci-archive: docker://localhost:32000/:`` to upload the OCI image to the registry. - 4. Run ``juju refresh --path= --resource django-app-image=:>`` to deploy the new OCI image. + 3. To upload the OCI image to the local Docker registry, run: + + .. code-block:: bash + + rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false \ + oci-archive: \ + docker://localhost:32000/: + + 4. To deploy the new OCI image, run: + + .. code-block:: bash + + juju refresh --path= \ + --resource django-app-image=:> .. group-tab:: FastAPI @@ -152,8 +176,20 @@ Update and deploy the OCI image 1. Make sure that any new files will be included in the new OCI image. 2. Run ``rockcraft pack`` to create the new OCI image. - 3. Run ``rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false oci-archive: docker://localhost:32000/:`` to upload the OCI image to the registry. - 4. Run ``juju refresh --path= --resource app-image=:>`` to deploy the new OCI image. + 3. To upload the OCI image to the local Docker registry, run: + + .. code-block:: bash + + rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false \ + oci-archive: \ + docker://localhost:32000/: + + 4. To deploy the new OCI image, run: + + .. code-block:: bash + + juju refresh --path= \ + --resource app-image=:> .. group-tab:: Go @@ -161,5 +197,17 @@ Update and deploy the OCI image 1. Make sure that any new files will be included in the new OCI image. 2. Run ``rockcraft pack`` to create the new OCI image. - 3. Run ``rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false oci-archive: docker://localhost:32000/:`` to upload the OCI image to the registry. - 4. Run ``juju refresh --path= --resource app-image=:>`` to deploy the new OCI image. + 3. To upload the OCI image to the local Docker registry, run: + + .. code-block:: bash + + rockcraft.skopeo --insecure-policy copy --dest-tls-verify=false \ + oci-archive: \ + docker://localhost:32000/: + + 4. To deploy the new OCI image, run: + + .. code-block:: bash + + juju refresh --path= \ + --resource app-image=:> diff --git a/docs/tutorial/django.rst b/docs/tutorial/django.rst index 320a58034..1adaad0ff 100644 --- a/docs/tutorial/django.rst +++ b/docs/tutorial/django.rst @@ -51,7 +51,7 @@ Change into the ``django_hello_world`` directory and run the Django application using ``python manage.py runserver`` to verify that it works. Test the Django application by using ``curl`` to send a request to the root -endpoint. We may need a new terminal for this -- if we're using Multipass, run +endpoint. We'll need a new terminal for this -- if we're using Multipass, run ``multipass shell rock-dev`` to get another terminal: .. literalinclude:: code/django/task.yaml diff --git a/docs/tutorial/fastapi.rst b/docs/tutorial/fastapi.rst index e454085bc..14484fd12 100644 --- a/docs/tutorial/fastapi.rst +++ b/docs/tutorial/fastapi.rst @@ -54,7 +54,7 @@ Run the FastAPI application using ``fastapi dev app.py --port 8000`` to verify that it works. Test the FastAPI application by using ``curl`` to send a request to the root -endpoint. We may need a new terminal for this -- if we're using Multipass, run +endpoint. We'll need a new terminal for this -- if we're using Multipass, run ``multipass shell rock-dev`` to get another terminal: .. literalinclude:: code/fastapi/task.yaml