Skip to content

Commit 9f3d6eb

Browse files
authored
docs: rewrite home page (canonical#2217)
- Rewrite home page to comply with the standard homepage model. - Fix outstanding lint errors in reference docs
1 parent be3c611 commit 9f3d6eb

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

docs/index.rst

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ 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>`.
15+
Charmcraft is the command-line tool for initializing, packaging, and publishing
16+
:external+juju:ref:`Juju charms <charm>`.
1717

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`_.
18+
When initializing a project, Charmcraft generates all the necessary files, which can be
19+
further catered to an application by modifying the YAML and :external+ops:doc:`Ops
20+
<index>`-powered Python in the pre-populated template content. For Django, FastAPI,
21+
Flask, and Go applications, Charmcraft's extensions simplify this process further by
22+
only requiring minor YAML changes after initialization. With just a few simple commands,
23+
charm authors can then use Charmcraft to package a charm and publish it to `Charmhub`_.
2824

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.
25+
Charmcraft simplifies every step of the charming process, enabling charm authors to
26+
bypass boilerplate steps and focus on the contents of their charms. Additionally,
27+
Charmcraft's integration with tools and platforms such as Ops and Charmhub provides
28+
charm authors with a complete charm development experience.
3129

32-
If you're a charm author, you *must* use Charmcraft!
30+
Charmcraft offers an efficient and straightforward way for anyone to charm an
31+
application for their Juju deployment, regardless of that application's complexity or
32+
scope.
3333

3434

3535
In this documentation
@@ -41,8 +41,7 @@ In this documentation
4141
:link: tutorial/index
4242
:link-type: doc
4343

44-
**Start here**: a hands-on introduction to Example Product for new users
45-
44+
**Get started** - a hands-on introduction to Charmcraft for new users
4645

4746
.. grid-item-card:: How-to guides
4847
:link: howto/index
@@ -57,7 +56,7 @@ In this documentation
5756
:link: reference/index
5857
:link-type: doc
5958

60-
**Technical information** - specifications, APIs, architecture
59+
**Technical information**, including commands, extensions, and project files
6160

6261
.. grid-item-card: Explanation
6362
:link: explanation/index
@@ -70,11 +69,11 @@ Project and community
7069
---------------------
7170

7271
Charmcraft is a member of the Canonical family. It's an open source project
73-
that warmly welcomes community projects, contributions, suggestions, fixes
72+
that warmly welcomes community projects, contributions, suggestions, fixes,
7473
and constructive feedback.
7574

76-
- `Ubuntu Code of Conduct <https://ubuntu.com/community/code-of-conduct>`_.
77-
- `Canonical contributor licenses agreement <https://ubuntu.com/legal/contributors>`_.
75+
- `Ubuntu Code of Conduct <https://ubuntu.com/community/code-of-conduct>`_
76+
- `Canonical contributor licence agreement <https://ubuntu.com/legal/contributors>`_
7877

7978

8079
Indices and tables

0 commit comments

Comments
 (0)