diff options
| author | Alberto Contreras <alberto.contreras@canonical.com> | 2022-11-18 15:55:44 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-18 08:55:44 -0600 |
| commit | e2fb079a72402b59c5476d64d23331f7f1c5e945 (patch) | |
| tree | 138fd3782b2c64bd3d6d1f867039ce143c9e05f4 /doc | |
| parent | 3776a8812dc649d13cfc915d81fb4b9219dcaca8 (diff) | |
| download | cloud-init-git-e2fb079a72402b59c5476d64d23331f7f1c5e945.tar.gz | |
doc: add how to render new module doc (#1855)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rtd/topics/module_creation.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/rtd/topics/module_creation.rst b/doc/rtd/topics/module_creation.rst index 4a248a21..69a6a8ae 100644 --- a/doc/rtd/topics/module_creation.rst +++ b/doc/rtd/topics/module_creation.rst @@ -74,6 +74,8 @@ Guidelines under ``$defs.all_modules``, in order to be accepted as a module key in the :ref:`base config<base_config_reference>`. +* Add the new module to `Module Reference`_. + * If your module introduces any new cloud-config keys, you must provide a schema definition in `schema-cloud-config.json`_. * The ``meta`` variable must exist and be of type `MetaSchema`_. @@ -130,3 +132,4 @@ in the ``cloud_final_modules`` section before the ``final-message`` module. .. _cloud_init_modules: https://github.com/canonical/cloud-init/blob/b4746b6aed7660510071395e70b2d6233fbdc3ab/config/cloud.cfg.tmpl#L70 .. _cloud_config_modules: https://github.com/canonical/cloud-init/blob/b4746b6aed7660510071395e70b2d6233fbdc3ab/config/cloud.cfg.tmpl#L101 .. _cloud_final_modules: https://github.com/canonical/cloud-init/blob/b4746b6aed7660510071395e70b2d6233fbdc3ab/config/cloud.cfg.tmpl#L144 +.. _Module Reference: https://github.com/canonical/cloud-init/blob/main/doc/rtd/topics/modules.rst |