Skip to content

Commit 1b2ef78

Browse files
committed
docs: rewrite home page
1 parent 462296b commit 1b2ef78

File tree

3 files changed

+27
-26
lines changed

3 files changed

+27
-26
lines changed

docs/index.rst

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,25 @@ Charmcraft
1212
reference/index
1313
release-notes/index
1414

15-
Charmcraft is a tool designed to simplify the creation, building, and sharing of a
16-
:external+juju:ref:`Juju charm <charm>`.
17-
18-
When you initialise a charm with Charmcraft, you automatically get all the crucial
19-
project files, pre-populated with helpful template content. These files are such that
20-
they can be packed right away; however, to make them meaningul for the application you
21-
are charming, you'll want to customise the YAML and
22-
:external+ops:doc:`ops <index>`-powered Python in these files. For certain types of
23-
applications (Django, FastAPI, Flask, Go), if you initialise with a suitable
24-
Charmcraft extension, things are even easier -- just tweak a few values in the
25-
YAML and you get a fully functioning charm. Either way, once you're pleased with
26-
what you've got, you can again use Charmcraft to publish your charm
27-
on `Charmhub`_.
28-
29-
You can create, build, and share a charm any way you want, but with Charmcraft you get
30-
state-of-the-art results in record time.
31-
32-
If you're a charm author, you *must* use Charmcraft!
15+
Charmcraft is the official command-line tool for initializing, packaging, and publishing
16+
:external+juju:ref:`Juju charms <charm>`.
17+
18+
When initializing a project, Charmcraft generates all the necessary files, pre-populated
19+
with template content, which can be further catered to an application using Charmcraft's
20+
array of extensions. Packing a charm is similarly streamlined, as Charmcraft will
21+
automatically fetch project dependencies and compile any modules before producing the
22+
final charm artifact. When it comes time to publish a charm on `Charmhub`_, Charmcraft
23+
provides tools for charm authors to register a charm's name, upload its associated
24+
resources, and release revisions to channels.
25+
26+
Charmcraft simplifies every step of the charming process, enabling charm authors to
27+
bypass boilerplate steps and focus on the contents of their charms. Additionally,
28+
Charmcraft's seamless integration with tools such as :external+ops:doc:`Ops <index>` and
29+
Charmhub provides charm authors with a truly comprehensive toolkit for charm
30+
development.
31+
32+
For those looking to add your applications to a Juju deployment, Charmcraft will prove
33+
to be an invaluable tool.
3334

3435

3536
In this documentation

docs/reference/files/charmcraft-yaml-file.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -362,10 +362,10 @@ and the lib version (in ``"<api version>[.<patch version>]"`` string format).
362362
**Status:** Optional. Recommended for Kubernetes charms.
363363

364364
**Purpose:** The ``charm-user`` key allows charm authors to specify that their charm
365-
hook code does not need to be run as root. This key, in combination with ``uid`` + ``gid``
366-
fields in ``containers``, allows the charm to be run rootless. If set to ``root``,
367-
the charm runs as root. If set to ``sudoer`` or ``non-root``, the charm runs as a user
368-
other than root. If the value is ``sudoer``, the charm will be run as a user
365+
hook code does not need to be run as root. This key, in combination with ``uid`` +
366+
``gid`` fields in ``containers``, allows the charm to be run rootless. If set to
367+
``root``, the charm runs as root. If set to ``sudoer`` or ``non-root``, the charm runs
368+
as a user other than root. If the value is ``sudoer``, the charm will be run as a user
369369
with access to sudo to elevate its privileges.
370370

371371
**Structure:** The key consists of a single value. One of ``root``, ``sudoer`` or

docs/reference/files/metadata-yaml-file.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -437,10 +437,10 @@ Examples:
437437
**Status:** Optional. Recommended for Kubernetes charms.
438438

439439
**Purpose:** The ``charm-user`` key allows charm authors to specify that their charm
440-
hook code does not need to be run as root. This key, in combination with ``uid`` + ``gid``
441-
fields in ``containers``, allows the charm to be run rootless. If set to ``root``,
442-
the charm runs as root. If set to ``sudoer`` or ``non-root``, the charm runs as a user
443-
other than root. If the value is ``sudoer``, the charm will be run as a user
440+
hook code does not need to be run as root. This key, in combination with ``uid`` +
441+
``gid`` fields in ``containers``, allows the charm to be run rootless. If set to
442+
``root``, the charm runs as root. If set to ``sudoer`` or ``non-root``, the charm runs
443+
as a user other than root. If the value is ``sudoer``, the charm will be run as a user
444444
with access to sudo to elevate its privileges.
445445

446446
**Structure:** The key consists of a single value. One of ``root``, ``sudoer`` or

0 commit comments

Comments
 (0)