Skip to content

Commit

Permalink
docs: documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
yanksyoon committed Jan 14, 2025
1 parent 2a46cab commit 63b914d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions docs/reference/extensions/expressjs-framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ Node and NPM, inside the rock. Additionally, it transfers your project files to
Project requirements
====================

There is 1 requirement to be able to use the ``expressjs-framework`` extension:
There are 3 requirements to be able to use the ``expressjs-framework``
extension:

1. There must be a ``package.json`` file in the ``app`` directory of the project
with ``start`` script defined.
1. The application should reside in the ``app`` directory.
2. The application should have a ``package.json`` file.
3. The ``package.json`` file should defined the ``start`` script.

``parts`` > ``expressjs-framework/dependencies:`` > ``stage-packages``
======================================================================
Expand Down Expand Up @@ -57,7 +59,7 @@ example:
Some files/directories, if they exist, are included by default. These include:
``<rock name>``, ``app.js``, ``migrate``, ``migrate.sh``, ``migrate.py``,
``bin``, ``public``, ``routes``, ``views``, ``package.json``,
``package-lock.json``.
``package-lock.json``, ``.npmrc``.

Useful links
============
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/expressjs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ the ``.rock`` extension:
:end-before: [docs:ls-rock-end]
:dedent: 2

The created rock is about 75MB in size. We will reduce its size later in this
The created rock is about 92MB in size. We will reduce its size later in this
tutorial.

.. note::
Expand Down Expand Up @@ -240,8 +240,8 @@ In ``rockcraft.yaml``, change the ``base`` to ``bare`` and add

.. 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.
the ``bare`` base. Note that ``build-base`` is also required when using the
``bare`` base.

So that we can compare the size after chiselling, open the ``rockcraft.yaml``
file and change the ``version`` (e.g. to ``0.1-chiselled``). Pack the rock with
Expand Down
2 changes: 1 addition & 1 deletion rockcraft/templates/expressjs-framework/rockcraft.yaml.j2
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ extensions:
# expressjs-framework/install-app:
# prime:
# # by default, only the files in bin/, public/, routes/, views/, app.js,
# # package.json package-lock.json are copied into the image.
# # package.json package-lock.json are copied into the image.
# # You can modify the list below to override the default list and
# # include or exclude specific files/directories in your project.
# # note: prefix each entry with "app/" followed by the local path.
Expand Down

0 comments on commit 63b914d

Please sign in to comment.