diff --git a/docs/explanation/#index.rst# b/docs/explanation/#index.rst# deleted file mode 100644 index d590cad37..000000000 --- a/docs/explanation/#index.rst# +++ /dev/null @@ -1,18 +0,0 @@ -.. _explanation: - -Explanation -*********** - -As Charmcraft is a part of the `Juju Charm SDK `_, most -explanation is hosted on the `Charm SDK docs `_. - -.. toctree:: - :maxdepth: 1 - - /common/craft-parts/explanation/dump_plugin - /common/craft-parts/explanation/filesets - lifecycle - - -`Charm SDK docs `_ -======================================================== diff --git a/docs/explanation/index.rst b/docs/explanation/index.rst index 66f1ee64f..d590cad37 100644 --- a/docs/explanation/index.rst +++ b/docs/explanation/index.rst @@ -3,4 +3,16 @@ Explanation *********** -TBA +As Charmcraft is a part of the `Juju Charm SDK `_, most +explanation is hosted on the `Charm SDK docs `_. + +.. toctree:: + :maxdepth: 1 + + /common/craft-parts/explanation/dump_plugin + /common/craft-parts/explanation/filesets + lifecycle + + +`Charm SDK docs `_ +======================================================== diff --git a/docs/howto/index.md b/docs/howto/index.md deleted file mode 100644 index f4e977f3c..000000000 --- a/docs/howto/index.md +++ /dev/null @@ -1,23 +0,0 @@ -(how-to-guides)= -# How-to guides - - -```{toctree} -:maxdepth: 2 - -Manage the `charmcraft` CLI -Manage charms -Manage charms (12-factor apps) -Manage extensions -Manage resources -Manage libraries -Manage parts -Manage the current Charmhub user -Manage names -Manage revisions -Manage channels -Manage tracks -Manage icons -Misc -Manage bundles -``` diff --git a/docs/howto/index.rst b/docs/howto/index.rst new file mode 100644 index 000000000..81a3a2180 --- /dev/null +++ b/docs/howto/index.rst @@ -0,0 +1,26 @@ +.. _howto: + +How-To +****** + +.. toctree:: + :maxdepth: 2 + + charm-to-poetry + charm-to-python + shared-cache + Manage the `charmcraft` CLI + Manage charms + Manage charms (12-factor apps) + Manage extensions + Manage resources + Manage libraries + Manage parts + Manage the current Charmhub user + Manage names + Manage revisions + Manage channels + Manage tracks + Manage icons + Misc + Manage bundles diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 5d41194ce..000000000 --- a/docs/index.md +++ /dev/null @@ -1,81 +0,0 @@ -# Charmcraft (`charmcraft`) - -```{toctree} -:maxdepth: 2 -:hidden: true - -tutorial/index -howto/index -reference/index -explanation/index -``` - -Charmcraft (`charmcraft`) is a tool designed to simplify the creation, building, and sharing of a [`juju` charm](https://juju.is/docs/juju/charmed-operator). - -When you initialise a charm with the `charmcraft` CLI, you automatically get all the crucial project files, pre-populated with helpful template content. These files are such that they can be `charmcraft`-packed right away; however, to make them meaningul for the application you are charming, you'll want to customise the YAML and [`ops`](https://juju.is/docs/sdk/ops)-powered Python in these files. For certain types of applications (Django, FastAPI, Flask, Go), if you initialise with a suitable `charmcraft` extension, things are even easier -- just tweak a few values in the YAML and you get a fully functioning charm. Either way, once you're pleased with what you've got, you can again use `chamcraft` to publish your charm on [Charmhub](https://charmhub.io/). - -You can create, build, and share a charm any way you want, but with `charmcraft` you get state-of-the-art results in record time. - -If you're a charm author, you *must* use `charmcraft`! - - ---------- - -## In this documentation - -````{grid} 1 1 2 2 - -```{grid-item-card} [Tutorial](/index) -:link: tutorial/index -:link-type: doc - -**Start here**: a hands-on introduction to Example Product for new users -``` - -```{grid-item-card} [How-to guides](/index) -:link: howto/index -:link-type: doc - -**Step-by-step guides** covering key operations and common tasks -``` - -```` - -````{grid} 1 1 2 2 -:reverse: - -```{grid-item-card} [Reference](/index) -:link: reference/index -:link-type: doc - -**Technical information** - specifications, APIs, architecture -``` - -```{grid-item-card} [Explanation](/index) -:link: explanation/index -:link-type: doc - -**Discussion and clarification** of key topics -``` - -```` - ---------- - - -## Project and community - -Charmcraft is a member of the Canonical family. It's an open source project -that warmly welcomes community projects, contributions, suggestions, fixes -and constructive feedback. - -* [Ubuntu Code of Conduct](https://ubuntu.com/community/code-of-conduct). -* [Canonical contributor licenses agreement](https://ubuntu.com/legal/contributors). - - diff --git a/docs/index.rst b/docs/index.rst index 46bf6025c..15a034981 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,11 +3,16 @@ Charmcraft ========== -Charmcraft is part of the `Juju Charm SDK `_. -Most of Charmcraft's documentation is available there. +Charmcraft (``charmcraft``) is a tool designed to simplify the creation, building, and sharing of a `Juju charm `_. + +When you initialise a charm with the `charmcraft` CLI, you automatically get all the crucial project files, pre-populated with helpful template content. These files are such that they can be `charmcraft`-packed right away; however, to make them meaningul for the application you are charming, you'll want to customise the YAML and [`ops`](https://juju.is/docs/sdk/ops)-powered Python in these files. For certain types of applications (Django, FastAPI, Flask, Go), if you initialise with a suitable ``charmcraft`` extension, things are even easier -- just tweak a few values in the YAML and you get a fully functioning charm. Either way, once you're pleased with what you've got, you can again use ``chamcraft`` to publish your charm on [Charmhub](https://charmhub.io/). + +You can create, build, and share a charm any way you want, but with ``charmcraft`` you get state-of-the-art results in record time. + +If you're a charm author, you *must* use ``charmcraft``! .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :hidden: tutorial/index