Skip to content

Commit

Permalink
docs: apply conventions to k8s charm tutorials
Browse files Browse the repository at this point in the history
- Fix indentation
- Remove parentheses
- Fix two lines before headings
- Correct use of "architecture"
- amd64 → AMD64
- arm64 → ARM64
- application → app
- Use common contractions
- Remove unnecessary colons
- ’ → '
  • Loading branch information
medubelko committed Feb 24, 2025
1 parent e0ce288 commit 9d8efe0
Show file tree
Hide file tree
Showing 5 changed files with 641 additions and 637 deletions.
8 changes: 5 additions & 3 deletions docs/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Our tutorial comes in multiple flavours -- pick your flavour of choice!

.. note::

Currently all our tutorial flavours demonstrate ``charmcraft`` in combination
with an 12-factor app extension -- a journey that does not require any
`ops <Operator framework>`_ and which does not currently include publishing the charm. To get a sense of the workflow for other types of applications and including the publication step, see :ref:`manage-charms`.
Currently all our tutorial flavours demonstrate ``charmcraft`` in combination with
an 12-factor app extension -- a journey that doesn't require any `ops <Operator
framework>`_ and which don't currently include publishing the charm. To get a
sense of the workflow for other types of apps and including the publication step,
see :ref:`manage-charms`.

.. toctree::
:maxdepth: 2
Expand Down
Loading

0 comments on commit 9d8efe0

Please sign in to comment.