Skip to content

Commit

Permalink
docs: replace occurrences of "charmcraft.yaml" and "recipe"
Browse files Browse the repository at this point in the history
Replaced occurrences of "charmcraft.yaml" and "recipe" with "project" or "project file".
  • Loading branch information
jahn-junior authored Feb 7, 2025
1 parent 86e6402 commit a6ccb3d
Show file tree
Hide file tree
Showing 23 changed files with 155 additions and 159 deletions.
22 changes: 11 additions & 11 deletions docs/howto/build-guides/select-platforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ See the :doc:`Platforms reference </reference/platforms>` for more information.
Select an OS
------------

The :ref:`charmcraft-yaml-base` key in ``charmcraft.yaml`` defines the operating
The project's :ref:`charmcraft-yaml-base` key defines the operating
system and version on which a charm can build and run. Supported OSs
vary by both the version of Charmcraft and the version of `Juju`_.

Expand All @@ -27,8 +27,8 @@ The general syntax for defining a distribution and series is to use
Select one build and one target architecture
--------------------------------------------

The following ``charmcraft.yaml`` snippet will define a charm that both builds and
runs on Ubuntu 24.04 LTS, only on an AMD64 architecture:
The following snippet defines a charm that both builds and runs on Ubuntu 24.04 LTS,
only on an AMD64 architecture:

.. code-block:: yaml
Expand Down Expand Up @@ -61,7 +61,7 @@ Select one build architecture and target all architectures
----------------------------------------------------------

When crafting a charm that contains only architecture-independent code,
set ``build-for: [all]``. For example, the following ``charmcraft.yaml`` snippet
set ``build-for: [all]``. For example, the following project file snippet
packs a single charm on an AMD64 host while declaring support for any architecture:

.. code-block:: yaml
Expand Down Expand Up @@ -100,7 +100,7 @@ Select multiple build and target architectures
Charms may contain architecture-specific code and thus need separate artifacts
for each. You can declare multiple architectures in the ``platforms`` key,
which instructs Charmcraft to build a charm for each of them as a set. For
example, you could use the following snippet in ``charmcraft.yaml`` to build
example, you could use the following snippet in your project to build
for both AMD64 and 64-bit RISC-V:

.. code-block:: yaml
Expand Down Expand Up @@ -137,7 +137,7 @@ Select different architectures for building and running
-------------------------------------------------------

A charm may require cross-compilation to build. To create a charm for a
different architecture, use the following ``charmcraft.yaml`` snippet:
different architecture, use the following snippet:

.. code-block:: yaml
Expand All @@ -160,13 +160,13 @@ Select multiple OS releases
---------------------------

The resulting ``.charm`` file packed by charmcraft can only run on a single OS release
or ``base``, using ``charmcraft.yaml`` nomenclature. A ``charmcraft.yaml`` can use
multi-base syntax to create a set of charms, each for a different base. To do this, the
base is defined in each platform entry instead of being defined with the
top-level ``base`` and ``build-base`` keys.
or ``base``, using ``charmcraft.yaml`` nomenclature. A project file can use multi-base
syntax to create multiple ``.charm`` files, each for a different base. To do this, the
base is defined in each platform entry instead of being defined with the top-level
``base`` and ``build-base`` keys.

To build a charm for Ubuntu 22.04 LTS and a charm for Ubuntu 24.04 LTS, use the
following ``charmcraft.yaml`` snippet which uses :ref:`multi-base
following snippet which uses :ref:`multi-base
notation<reference-platforms-multi-base>`:

.. code-block:: yaml
Expand Down
17 changes: 8 additions & 9 deletions docs/howto/manage-12-factor-app-charms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,10 @@ Use ``charmcraft init`` and specify the relevant profile:
charmcraft init --profile <profile>
Charmcraft automatically creates ``charmcraft.yaml``,
``requirements.txt`` and source code for the charm in your
current directory. You will need to check ``charmcraft.yaml``
and ``README.md`` to verify that the charm's name and
description are correct.
Charmcraft automatically creates a ``charmcraft.yaml`` project file, a
``requirements.txt`` file and source code for the charm in your current directory. You
will need to check the project file and ``README.md`` to verify that the charm's name
and description are correct.

See also: :ref:`ref_commands_init`

Expand Down Expand Up @@ -154,7 +153,7 @@ Manage relations for a 12-factor app charm
------------------------------------------

A charm integration can be added to your charmed 12-factor app by providing
the integration and endpoint definition in ``charmcraft.yaml``:
the integration and endpoint definition in your project file:

.. code-block:: yaml
Expand All @@ -167,7 +166,7 @@ Here, ``<endpoint name>`` corresponds to the endpoint of the application with wh
you want the integration, and ``<endpoint interface name>`` is the endpoint schema
to which this relation conforms. Both the ``<endpoint name>`` and
``<endpoint interface name>`` must coincide with the structs defined in the
``charmcraft.yaml`` file of that particular application's charm. The key ``optional``
pfoject file of that particular application's charm. The key ``optional``
with value ``False`` means that the charm will get blocked and stop the services if
the integration is not provided.

Expand All @@ -184,7 +183,7 @@ use to configure your 12-factor application.
For example, if you wish to integrate your 12-factor application with PostgreSQL
(`machine <https://charmhub.io/postgresql>`_ or
`k8s <https://charmhub.io/postgresql-k8s>`_
charm), add the following endpoint definition to ``charmcraft.yaml``:
charm), add the following endpoint definition to your project file:

.. code-block:: yaml
Expand Down Expand Up @@ -223,7 +222,7 @@ Manage secrets for a 12-factor app charm

A user secret can be added to a charm and all the keys and values
in the secret will be exposed as environment variables. Add the secret
configuration option in ``charmcraft.yaml``:
configuration option in your project file:

.. code-block:: yaml
Expand Down
65 changes: 32 additions & 33 deletions docs/howto/manage-charms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ Add charm project metadata, an icon, docs
Specify that the project is a charm
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To specify that the project is a charm (as supposed to a bundle), in your
``charmcraft.yaml`` file set the ``type`` key to ``charm``:
To specify that the project is a charm (as supposed to a bundle), set the ``type`` key
to ``charm`` in your project file:

.. code-block:: yaml
Expand All @@ -97,9 +97,8 @@ Specify a name

.. Need to add more content based on https://discourse.charmhub.io/t/charm-naming-guidelines/5364 .
To specify a pack-and-deploy name for your charm, in your charm's
``charmcraft.yaml`` file specify the ``name`` key. E.g.,
To specify a pack-and-deploy name for your charm, in your charm's project file, specify
the ``name`` key. E.g.,

.. code-block:: yaml
Expand All @@ -113,8 +112,8 @@ To specify a pack-and-deploy name for your charm, in your charm's
Specify a title
~~~~~~~~~~~~~~~

To specify a title for your charm's page on Charmhub, in your charm's
``charmcraft.yaml`` file specify a value for the ``title`` key. E.g.,
To specify a title for your charm's page on Charmhub, in your charm's project file,
specify a value for the ``title`` key. E.g.,

.. code-block:: yaml
Expand All @@ -129,7 +128,7 @@ To specify a title for your charm's page on Charmhub, in your charm's
Add a summary
~~~~~~~~~~~~~

To add a summary line for your charm, in your charm's ``charmcraft.yaml`` file specify a
To add a summary line for your charm, in your charm's project file, specify a
value for the ``summary`` key. E.g.,

.. code-block:: yaml
Expand All @@ -145,8 +144,8 @@ value for the ``summary`` key. E.g.,
Add a description
~~~~~~~~~~~~~~~~~

To add a longer description for your charm, in your charm's ``charmcraft.yaml``
file specify a value for the ``description`` key. E.g.,
To add a longer description for your charm, in your charm's project
file, specify a value for the ``description`` key. E.g.,

.. code-block:: yaml
Expand All @@ -163,8 +162,8 @@ file specify a value for the ``description`` key. E.g.,
Add contact information
~~~~~~~~~~~~~~~~~~~~~~~

To add maintainer contact information for a charm, in your charm's ``charmcraft.yaml``
file specify a value for the :ref:`links.contact <recipe-key-links-contact>`
To add maintainer contact information for a charm, in your charm's project
file, specify a value for the :ref:`links.contact <recipe-key-links-contact>`
key. E.g.,

.. code-block:: yaml
Expand All @@ -180,8 +179,8 @@ key. E.g.,
Add a link to source code
~~~~~~~~~~~~~~~~~~~~~~~~~

To add a link to the source code for a charm, in your charm's ``charmcraft.yaml``
file specify an item under the :ref:`links.source <recipe-key-links-source>`
To add a link to the source code for a charm, in your charm's project
file, specify an item under the :ref:`links.source <recipe-key-links-source>`
key. E.g.,

.. code-block:: yaml
Expand All @@ -198,8 +197,8 @@ key. E.g.,
Add a link to the bug tracker
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To add a link to the bug tracker for a charm, in your charm's ``charmcraft.yaml``
file specify an item under the :ref:`links.issues <recipe-key-links-website>`
To add a link to the bug tracker for a charm, in your charm's project
file, specify an item under the :ref:`links.issues <recipe-key-links-website>`
key. E.g.,

.. code-block:: yaml
Expand All @@ -217,7 +216,7 @@ Add a link to the website
~~~~~~~~~~~~~~~~~~~~~~~~~

If your charm has a website outside of Charmhub, to add a link to this website, in your
charm's ``charmcraft.yaml`` file specify an item under the :ref:`links.website
charm's project file, specify an item under the :ref:`links.website
<recipe-key-links-website>` key. E.g.,

.. code-block:: yaml
Expand All @@ -238,7 +237,7 @@ Add docs
If you publish your charm on Charmhub, reference documentation about the charm's
resources, actions, configurations, relations, and libraries is extracted automatically.
However, you should also aim to add further docs, e.g., a tutorial, how-to guides, etc.
To provide a link to these docs, in your charm's ``charmcraft.yaml`` file specify a
To provide a link to these docs, in your charm's project file, specify a
value for the :ref:`links.documentation <recipe-key-documentation>` key. Note
that at present this must be a Discourse page. E.g.,

Expand All @@ -255,7 +254,7 @@ that at present this must be a Discourse page. E.g.,
Add terms of use
~~~~~~~~~~~~~~~~

To add terms of use for your charm, in your charm's ``charmcraft.yaml`` file specify a
To add terms of use for your charm, in your charm's project file, specify a
value for the ``terms`` key. E.g.,

.. code-block:: yaml
Expand All @@ -282,7 +281,7 @@ Add runtime details to a charm
Require a specific Juju version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To require a specific Juju version for your charm, in your charm's ``charmcraft.yaml``
To require a specific Juju version for your charm, in your charm's project file,
specify the ``assumes`` key. E.g.,

.. code-block:: yaml
Expand All @@ -299,7 +298,7 @@ Require a Kubernetes cloud
~~~~~~~~~~~~~~~~~~~~~~~~~~

To require a Kubernetes cloud for your charm, in your charm's
``charmcraft.yaml`` file specify the ``assumes`` key. E.g.,
project file, specify the ``assumes`` key. E.g.,

.. code-block:: yaml
Expand All @@ -315,7 +314,7 @@ Require a specific base and platforms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To require a specific base and platforms for your charm, in your charm's
``charmcraft.yaml`` file specify the ``base``, and ``platforms`` keys. E.g.,
project file, specify the ``base``, and ``platforms`` keys. E.g.,

.. note::
In Charmcraft < 3.0 this was done via a single key: ``bases``.
Expand Down Expand Up @@ -355,7 +354,7 @@ To require a specific base and platforms for your charm, in your charm's
Specify container requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To specify container requirements, in your charm's ``charmcraft.yaml`` file specify the
To specify container requirements, in your charm's project file, specify the
``containers`` key.

See more: :ref:`recipe-key-containers`
Expand All @@ -364,16 +363,16 @@ To specify container requirements, in your charm's ``charmcraft.yaml`` file spec
Specify associated resources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To specify the resources associated with the charm, in your charm's ``charmcraft.yaml``
file specify the ``resources`` key.
To specify the resources associated with the charm, in your charm's project
file, specify the ``resources`` key.

See :ref:`manage-resources`.


Specify device requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

To specify device requirements, in your charm's ``charmcraft.yaml`` file specify the
To specify device requirements, in your charm's project file, specify the
``devices`` key.

See more: :ref:`recipe-key-devices`
Expand All @@ -383,7 +382,7 @@ To specify device requirements, in your charm's ``charmcraft.yaml`` file specify
Manage storage
~~~~~~~~~~~~~~

To specify storage requirements, in your charm's ``charmcraft.yaml`` file specify
To specify storage requirements, in your charm's project file, specify
the ``storage`` key.

See more: :ref:`recipe-key-storage`
Expand All @@ -392,7 +391,7 @@ the ``storage`` key.
Specify extra binding requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To specify extra binding requirements, in your charm's ``charmcraft.yaml`` file
To specify extra binding requirements, in your charm's project file,
specify the ``extra-bindings`` key.

See more: :ref:`recipe-key-extra-bindings`
Expand All @@ -403,7 +402,7 @@ Require subordinate deployment

To require subordinate deployment for your charm (i.e., for it to be deployed to the
same machine as another charm, called its *principal*), in your charm's
``charmcraft.yaml`` file specify the ``subordinate`` key.
project file, specify the ``subordinate`` key.

See more: :ref:`recipe-key-subordinate`

Expand All @@ -415,7 +414,7 @@ Manage actions
See first: :external+juju:ref:`Juju | Action <action>`,
:external+juju:ref:`Juju | Manage actions <manage-actions>`

To declare an action in your charm, in your charm's ``charmcraft.yaml`` file
To declare an action in your charm, in your charm's project file,
specify the ``actions`` key.

See more: :ref:`recipe-key-actions`
Expand All @@ -432,7 +431,7 @@ Manage configurations
:external+juju:ref:`Juju | Manage applications > Configure
<configure-an-application>`

To declare a configuration option for your charm, in your charm's ``charmcraft.yaml``
To declare a configuration option for your charm, in your charm's project file,
specify the ``config`` key.


Expand All @@ -448,7 +447,7 @@ Manage relations
See first: :external+juju:ref:`Juju | Relation <relation>`,
:external+juju:ref:`Juju | Manage relations <manage-relations>`

To declare a relation endpoint in your charm, in your charm's ``charmcraft.yaml``
To declare a relation endpoint in your charm, in your charm's project file,
specify the ``peers``, ``provides``, or ``requires`` key.

See more: :ref:`recipe-key-peers`
Expand All @@ -470,7 +469,7 @@ Manage secrets
:external+juju:ref:`Juju | Secret <secret>`

To make your charm capable of accepting a user secret, in your charm's
``charmcraft.yaml`` specify the ``config`` key with the ``type`` subkey set to
project file, specify the ``config`` key with the ``type`` subkey set to
``secret``.

See more: :ref:`recipe-key-config`
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/manage-libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Another good way to search for libraries is to explore the charm collection on
Use a library
-------------

In your charm's ``charmcraft.yaml``, specify the ``charm-libs`` key with the desired
In your charm's project file, specify the ``charm-libs`` key with the desired
libraries.

See more: :ref:`recipe-key-charm-libs`
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/manage-resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Declare a resource
------------------

To declare a resource required by your charm, set the :ref:`recipe-key-resources` key in
its recipe.
its project file.

See more: :ref:`recipe-key-resources`

Expand Down
6 changes: 3 additions & 3 deletions docs/howto/migrate-plugins/charm-to-poetry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ charm to be migrated does not currently use poetry, refer to the
`Poetry documentation <https://python-poetry.org/docs/basic-usage/>`_ for instructions
on how to use poetry for a Python project.

Update ``charmcraft.yaml``
--------------------------
Update the project file
-----------------------

The first step is to update ``charmcraft.yaml`` to include the correct parts definition.
The first step is to update the project file to include the correct parts definition.
Depending on the history of a specific charm, it may not have an explicitly-included
``parts`` section determining how to build the charm. In this case, a ``parts`` section
can be created as follows:
Expand Down
6 changes: 3 additions & 3 deletions docs/howto/migrate-plugins/charm-to-python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ The Python plugin in Charmcraft offers a faster, stricter means of packing an op
charm with a virtual environment. This guide shows how to migrate from a charm using
the default Charm plugin to using the Python plugin.

Update ``charmcraft.yaml``
--------------------------
Update the project file
-----------------------

The first step is to update ``charmcraft.yaml`` to include the correct parts definition.
The first step is to update the project file to include the correct parts definition.
Depending on the history of a specific charm, it may not have an explicitly-included
``parts`` section determining how to build the charm. In this case, a ``parts`` section
can be created as follows:
Expand Down
Loading

0 comments on commit a6ccb3d

Please sign in to comment.