.. _contribute:

==========
Contribute
==========

The following guides provide detailed instructions on the contribution workflow
and conventions to be considered when contributing to the StarlingX documentation.

StarlingX utilizes tooling and CI/CD environments from the OpenStack
Foundation. The source is hosted on `OpenDev's Git server`_.

.. _`OpenDev's Git server`: https://opendev.org/starlingx

---------------------------
Contribute to documentation
---------------------------

.. toctree::
   :maxdepth: 1

   api_contribute_guide
   release_note_contribute_guide
   doc_contribute_guide

-------------------
Development process
-------------------

For information on the StarlingX development process, refer to the following guide:

.. toctree::
   :maxdepth: 1

   development_process

---------------
Build StarlingX
---------------

Refer to the StarlingX Build Guide for instructions on how to build a StarlingX
ISO image.

.. toctree::
   :maxdepth: 1

   build_guide

--------------------
Additional resources
--------------------

Additional information about contributing to OpenStack documentation can be found
in the following guides:

* `OpenStack API documentation guide`_
* `OpenStack Documentation Contributor Guide`_

.. _`OpenStack Documentation Contributor Guide`: https://docs.openstack.org/doc-contrib-guide/index.html

.. _`OpenStack API documentation guide`: https://docs.openstack.org/doc-contrib-guide/api-guides.html