@@ -12,24 +12,24 @@ Charmcraft
12
12
reference/index
13
13
release-notes/index
14
14
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 >`.
17
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 `_.
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 `_.
28
24
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.
31
29
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.
33
33
34
34
35
35
In this documentation
@@ -41,8 +41,7 @@ In this documentation
41
41
:link: tutorial/index
42
42
:link-type: doc
43
43
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
46
45
47
46
.. grid-item-card :: How-to guides
48
47
:link: howto/index
@@ -57,7 +56,7 @@ In this documentation
57
56
:link: reference/index
58
57
:link-type: doc
59
58
60
- **Technical information ** - specifications, APIs, architecture
59
+ **Technical information **, including commands, extensions, and project files
61
60
62
61
.. grid-item-card: Explanation
63
62
:link: explanation/index
@@ -70,11 +69,11 @@ Project and community
70
69
---------------------
71
70
72
71
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,
74
73
and constructive feedback.
75
74
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 >`_
78
77
79
78
80
79
Indices and tables
0 commit comments