Welcome to Yaook's documentation!
=================================
Welcome to the documentation of Yaook.
We are happy that you are here. :octicon:`heart-fill;1em;sd-text-danger`

Yaook is providing a fully automated `OpenStack <https://www.openstack.org/>`_ lifecycle management.
It thereby not only focuses on OpenStack itself, but also on all other relevant aspects (e.g. hardware inventory, monitoring).
Generic day 2 operation tasks are also included in Yaook's scope.

A general overview about the Yaook project is given in :doc:`user/explanations/concepts/overview`.

The source code is made available under Apache License and is located at: https://gitlab.com/yaook

If you want to start developing for Yaook you can start with a look at the :doc:`developer/explanations/resources_state-graph_operator`.

Communication
-------------

We are most active on Yaook IRC: use `#yaook` on `oftc.net <https://www.oftc.net/>`_ e.g. via `OFTC Webchat <https://webchat.oftc.net/?channels=yaook>`_.
Or join the IRC via `Matrix <https://matrix.to/#/#_oftc_#yaook:matrix.org>`_.

We also have a `mailing list for Yaook <https://lists.alasca.cloud/postorius/lists/yaook.lists.alasca.cloud/>`_ for discussion.
Release and security updates are shared via `ALASCA announce list <https://lists.alasca.cloud/postorius/lists/announce.lists.alasca.cloud/>`_.

.. grid:: 1

    .. grid-item-card:: Quickstart
        :link: user/guides/quickstart-guide/index
        :link-type: doc

        Get Yaook up and running on your cluster in no time.

.. grid:: 1

    .. grid-item-card:: Releasenotes
        :link: releasenotes
        :link-type: doc

        The releasenotes give you all essential information about recent changes.

.. grid:: 2

    .. grid-item-card:: User Explanations
        :link: user/explanations/index
        :link-type: doc

        Technical reference documentation of Yaook from the *user* perspective.

    .. grid-item-card:: Developer Explanations
        :link: developer/explanations/index
        :link-type: doc

        Things you need to know before *developing* for Yaook.

.. grid:: 2

    .. grid-item-card:: User Guides
        :link: user/guides/index
        :link-type: doc

        Keep this under your pillow when *running* Yaook clusters.

    .. grid-item-card:: Developer Guides
        :link: developer/guides/index
        :link-type: doc

        Getting started and from a *developers* perspective.

.. grid:: 2

    .. grid-item-card:: User Reference
        :link: user/references/index
        :link-type: doc

        References to everything important for *running* Yaook clusters.

    .. grid-item-card:: Developer Reference
        :link: developer/references/index
        :link-type: doc

        Extensive API and internals reference documentation for developers.

.. toctree::
    :hidden:

    releasenotes

.. toctree::
   :hidden:
   :caption: User Documentation

   user/explanations/index
   user/guides/index
   user/references/index
.. user/tutorials/index

.. toctree::
   :hidden:
   :caption: Developer Documentation

   developer/explanations/index
   developer/guides/index
   developer/references/index
.. developer/tutorials/index