Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Michael DuBelko <[email protected]>
  • Loading branch information
erinecon and medubelko authored Nov 6, 2024
1 parent 4ce98dc commit 718db3f
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions docs/how-to/build-a-12-factor-app-rock.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
How to build a 12-Factor app rock
*********************************

The following how-to guides provide instructions on managing
The following how-to guide provides instructions on managing
and configuring rocks for 12-factor applications.

Include extra files in the OCI image
Expand Down Expand Up @@ -77,7 +77,7 @@ Include additional debs in the OCI image
----------------------------------------

If your app requires debs -- for example, to connect to a database -- add the
following snippet to the ``rockcraft.yaml``:
following snippet to ``rockcraft.yaml``:

.. tabs::

Expand Down Expand Up @@ -121,7 +121,7 @@ following snippet to the ``rockcraft.yaml``:
stage-packages:
- postgresql-client
For the ``go-framework``, a deb could be needed for example to use an external command in the migration process.
For the ``go-framework`` extension, a deb could be needed for example to use an external command in the migration process.

Update and deploy the OCI image
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/extensions/django-framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There are 2 requirements to be able to use the ``django-framework`` extension:
===================================================================

You can use this key to specify any dependencies required for your Django
application. For example, below we use it to specify ``libpq-dev``:
application. In the following example we use it to specify ``libpq-dev``:

.. code-block:: yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/extensions/fastapi-framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are 2 requirements to be able to use the ``fastapi-framework`` extension:
====================================================================

You can use this key to specify any dependencies required for your FastAPI
application. For example, below we use it to specify ``libpq-dev``:
application. In the following example we use it to specify ``libpq-dev``:

.. code-block:: yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/extensions/flask-framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ There are 2 requirements to be able to use the ``flask-framework`` extension:
=================================================================

You can use this key to specify any dependencies required for your Flask
application. For example, below we use it to specify ``libpq-dev``:
application. In the following example we use it to specify ``libpq-dev``:

.. code-block:: yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/django.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 are using Multipass use
endpoint. We may 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
Expand Down Expand Up @@ -92,7 +92,7 @@ include ``arm64`` in ``platforms``.

.. note::
For this tutorial, we'll use the ``name`` ``django-hello-world`` and assume
we are running on an ``amd64`` platform. Check the architecture of the
we're running on the ``amd64`` platform. Check the architecture of the
system using ``dpkg --print-architecture``.

The ``name``, ``version`` and ``platform`` all influence the name of the
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/fastapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 are using Multipass use
endpoint. We may 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
Expand Down Expand Up @@ -89,7 +89,7 @@ architecture, include ``arm64`` in ``platforms``.

.. note::
For this tutorial, we'll use the ``name`` ``fastapi-hello-world`` and assume
we are running on an ``amd64`` platform. Check the architecture of the
we're running on the ``amd64`` platform. Check the architecture of the
system using ``dpkg --print-architecture``.

The ``name``, ``version`` and ``platform`` all influence the name of the
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/flask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ In the same directory, copy and save the following into a text file called
Run the Flask application using ``flask run -p 8000`` to verify that it works.

Test the Flask application by using ``curl`` to send a request to the root
endpoint. We will need a new terminal for this; if we are using Multipass use
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/flask/task.yaml
Expand Down Expand Up @@ -90,7 +90,7 @@ architecture, include ``arm64`` in ``platforms``.

.. note::
For this tutorial, we'll use the ``name`` ``flask-hello-world`` and assume
we are running on an ``amd64`` platform. Check the architecture of the
we're running on the ``amd64`` platform. Check the architecture of the
system using ``dpkg --print-architecture``.

The ``name``, ``version`` and ``platform`` all influence the name of the
Expand Down Expand Up @@ -126,7 +126,7 @@ tutorial.
on an ``amd64`` platform, the name of the ``.rock`` file will be different.

The size of the rock may vary depending on factors like the architecture
we are building on and the packages installed at the time of packing.
we're building on and the packages installed at the time of packing.

Run the Flask rock with Docker
==============================
Expand Down

0 comments on commit 718db3f

Please sign in to comment.