Documentation
=============

FreeIPA team welcome help in all documentation related areas, especially
with adding articles, HOWTOs or just updating information on this
community wiki.



Updating wiki
-------------

This site is built from the
`freeipa.github.io <https://github.com/freeipa/freeipa.github.io>`__
repository. Documentation is written in reStructuredText (or MyST
Markdown) and rendered with Sphinx. See the repository README for how to
build the site locally and open a pull request with your changes.



What to do
----------------------------------------------------------------------------------------------

You can update or extend current articles referenced from
`Documentation <Documentation>`__ or add new content you would like to
share with the FreeIPA world. You can also check
`Codeberg <https://codeberg.org/freeipa/freeipa>`__
for the list of known bugs or missing enhancements to this wiki and help
us!



Contributing downstream guides
------------------------------

FreeIPA project is documented in several downstream :ref:`User Guides <local-documentation-user-guides>` which contain enterprise level
documentation. Downstream guide maintainers are happy for any
contribution, from proposed content to even just a bug report.

-  Direct links for bug reporting can be found next to links to
   :ref:`downstream guides <local-documentation-user-guides>`.
