Skip to content

Commit

Permalink
docs: fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
yanksyoon committed Jan 23, 2025
1 parent da5b5fe commit 4128d2d
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 15 deletions.
26 changes: 15 additions & 11 deletions docs/explanation/extensions/expressjs-framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ Bare base and Node from Ubuntu packages
stage-packages:
- npm
In this case, the ``npm`` package is installed in a separate ``expressjs-framework/runtime`` part.
This is due to ``expressjs-framework/install-app > stage-packages`` part only being able to install
slices rather than packages as a design choice of Rockcraft. See the comment
https://github.com/canonical/rockcraft/issues/785#issuecomment-2572990545 for more explanation.
In this case, the ``npm`` package is installed in a separate
``expressjs-framework/runtime`` part. This is due to
``expressjs-framework/install-app > stage-packages`` part only being able to
install slices rather than packages as a design choice of Rockcraft. See the
[issue comment](https://github.com/canonical/rockcraft/issues/785#issuecomment\
-2572990545) for more explanation.

Bare base and Node from NPM plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -57,9 +59,9 @@ Bare base and Node from NPM plugin
- coreutils_bins
- nodejs_bins
In this case, the ``expressjs-framework/install-app > build-packages`` part is empty. The
application is is installed using Node and NPM installed by the NPM plugin. The application is run
using the NPM installed by the NPM plugin.
In this case, the ``expressjs-framework/install-app > build-packages`` part is
empty. The application is is installed using Node and NPM installed by the NPM
plugin. The application is run using the NPM installed by the NPM plugin.

24.04 base and Node from Ubuntu packages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -81,9 +83,10 @@ using the NPM installed by the NPM plugin.
stage-packages:
- npm
In this case, the ``expressjs-framework/install-app > stage-packages`` part does not include the
``bash_bins`` and ``coreutils_bins`` slices as they are already included in the Ubuntu 24.04 base.
The application is built and installed using Node and NPM from the Ubuntu packages.
In this case, the ``expressjs-framework/install-app > stage-packages`` part does
not include the ``bash_bins`` and ``coreutils_bins`` slices as they are already
included in the Ubuntu 24.04 base. The application is built and installed using
Node and NPM from the Ubuntu packages.

24.04 base and Node from NPM plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -97,4 +100,5 @@ The application is built and installed using Node and NPM from the Ubuntu packag
npm-include-node: true
npm-node-version: 20.12
In this case, the application is installed and run via Node and NPM installed by the NPM plugin.
In this case, the application is installed and run via Node and NPM installed by
the NPM plugin.
4 changes: 3 additions & 1 deletion docs/reference/extensions/expressjs-framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ example:
npm-include-node: true
npm-node-version: 20.12.2
For more examples of npm-node-version options, see: https://documentation.ubuntu.com/rockcraft/en/1.5.3/common/craft-parts/reference/plugins/npm_plugin/#examples
For more examples of npm-node-version options, see: https://documentation.\
ubuntu.com/rockcraft/en/1.5.3/common/craft-parts/reference/plugins/npm_plugin/\
#examples

If you don't customise the version of node, it will be installed from the Ubuntu
package repository.
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/expressjs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Setup

.. important::

Before we go any further, for this tutorial we'll need the most recent version
of Rockcraft on the edge channel. Run ``sudo snap refresh rockcraft --channel
latest/edge`` to switch to it.
Before we go any further, for this tutorial we'll need the most recent
version of Rockcraft on the edge channel. Run ``sudo snap refresh rockcraft
--channel latest/edge`` to switch to it.

Finally, create a new directory for this tutorial and go inside it:

Expand Down

0 comments on commit 4128d2d

Please sign in to comment.