diff options
Diffstat (limited to 'doc/rtd/index.rst')
| -rw-r--r-- | doc/rtd/index.rst | 145 |
1 files changed, 70 insertions, 75 deletions
diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst index 159113f4..81045051 100644 --- a/doc/rtd/index.rst +++ b/doc/rtd/index.rst @@ -1,101 +1,96 @@ .. _index: -cloud-init Documentation +Cloud-init documentation ######################## -Cloud-init is the *industry standard* multi-distribution method for -cross-platform cloud instance initialization. +``Cloud-init`` is the *industry standard* multi-distribution method for +cross-platform cloud instance initialisation. It is supported across all major +public cloud providers, provisioning systems for private cloud infrastructure, +and bare-metal installations. -During boot, cloud-init identifies the cloud it is running on and initializes -the system accordingly. Cloud instances will automatically be provisioned -during first boot with networking, storage, ssh keys, packages and various -other system aspects already configured. +During boot, ``cloud-init`` identifies the cloud it is running on and +initialises the system accordingly. Cloud instances will automatically be +provisioned during first boot with networking, storage, SSH keys, packages +and various other system aspects already configured. -Cloud-init provides the necessary glue between launching a cloud instance and -connecting to it so that it works as expected. +``Cloud-init`` provides the necessary glue between launching a cloud instance +and connecting to it so that it works as expected. -For cloud users, cloud-init provides no-install first-boot configuration +For cloud users, ``cloud-init`` provides no-install first-boot configuration management of a cloud instance. For cloud providers, it provides instance setup that can be integrated with your cloud. -Project and community -********************* -Cloud-init is an open source project that warmly welcomes community -projects, contributions, suggestions, fixes and constructive feedback. +----- -* `Code of conduct <https://ubuntu.com/community/code-of-conduct>`_ -* Ask questions in IRC on ``#cloud-init`` on Libera -* `Mailing list <https://launchpad.net/~cloud-init>`_ -* `Contribute on Github <https://github.com/canonical/cloud-init/blob/main/CONTRIBUTING.rst>`_ -* `Release schedule <https://discourse.ubuntu.com/search?q=cloud-init%20release%20schedule%20order%3Alatest>`_ +.. grid:: 1 1 2 2 + :gutter: 3 -Having trouble? We would like to help! -************************************** + .. grid-item-card:: **Tutorials** + :link: tutorial/index + :link-type: doc -- Check out the :ref:`lxd_tutorial` if you're new to cloud-init -- Try the :ref:`FAQ` for answers to some common questions -- Find a bug? `Report bugs on Launchpad <https://bugs.launchpad.net/cloud-init/+filebug>`_ + Get started - a hands-on introduction to ``cloud-init`` for new users -.. toctree:: - :hidden: - :titlesonly: - :caption: Getting Started + .. grid-item-card:: **How-to guides** + :link: howto/index + :link-type: doc - topics/tutorial.rst - topics/availability.rst - topics/boot.rst - topics/cli.rst - topics/faq.rst - topics/bugs.rst + Step-by-step guides covering key operations and common tasks -.. toctree:: - :hidden: - :titlesonly: - :caption: Explanation +.. grid:: 1 1 2 2 + :gutter: 3 + :reverse: - topics/configuration.rst + .. grid-item-card:: **Reference** + :link: reference/index + :link-type: doc -.. toctree:: - :hidden: - :titlesonly: - :caption: User Data + Technical information - specifications, APIs, architecture - topics/format.rst - topics/examples.rst - topics/events.rst - topics/merging.rst + .. grid-item-card:: **Explanation** + :link: explanation/index + :link-type: doc -.. toctree:: - :hidden: - :titlesonly: - :caption: Instance Data + Discussion and clarification of key topics - topics/instancedata.rst - topics/datasources.rst - topics/vendordata.rst - topics/network-config.rst +----- -.. toctree:: - :hidden: - :titlesonly: - :caption: Reference +Having trouble? We would like to help! +====================================== + +- :ref:`Check out our tutorials<tutorial_index>` if you're new to + ``cloud-init`` +- :ref:`Try the FAQ<faq>` for answers to some common questions +- You can also search the ``cloud-init`` `mailing list archive`_ +- Find a bug? `Report bugs on Launchpad`_ + +Project and community +===================== + +``Cloud-init`` is an open source project that warmly welcomes community +projects, contributions, suggestions, fixes and constructive feedback. - topics/base_config_reference.rst - topics/modules.rst +* Read our `Code of Conduct`_ +* Ask questions in the ``#cloud-init`` `IRC channel on Libera`_ +* Join the `cloud-init mailing list`_ +* :ref:`Contribute on GitHub<contributing>` +* `Release schedule`_ .. toctree:: :hidden: - :titlesonly: - :caption: Development - - topics/contributing.rst - topics/module_creation.rst - topics/code_review.rst - topics/security.rst - topics/debugging.rst - topics/logging.rst - topics/dir_layout.rst - topics/analyze.rst - topics/docs.rst - topics/testing.rst - topics/integration_tests.rst + :maxdepth: 2 + + tutorial/index + howto/index + explanation/index + reference/index + development/index + + +.. LINKS +.. _Code of Conduct: https://ubuntu.com/community/code-of-conduct +.. _IRC channel on Libera: https://kiwiirc.com/nextclient/irc.libera.chat/cloud-init +.. _cloud-init mailing list: https://launchpad.net/~cloud-init +.. _mailing list archive: https://lists.launchpad.net/cloud-init/ +.. _Release schedule: https://discourse.ubuntu.com/t/cloud-init-release-schedule/32244 +.. _Report bugs on Launchpad: https://bugs.launchpad.net/cloud-init/+filebug |