23 lines
937 B
ReStructuredText
23 lines
937 B
ReStructuredText
=============
|
|
Documentation
|
|
=============
|
|
|
|
We (like almost all open source software providers) have a
|
|
documentation dilemma… We tend to focus on the code features and
|
|
functionality before working on documentation. And there is very good
|
|
reason for this: we want to share the love so nobody feels left out!
|
|
|
|
You can contribute to the documentation by `raising an issue to
|
|
suggest an improvement
|
|
<https://github.com/warewulf/warewulf/issues/new>`_ or by sending a
|
|
`pull request <https://github.com/warewulf/warewulf/compare>`_ on
|
|
`our repository <https://github.com/warewulf/warewulf>`_.
|
|
|
|
The current documentation is generated with `Sphinx
|
|
<https://www.sphinx-doc.org/>`_.
|
|
|
|
For more information on using Git and GitHub to create a pull request
|
|
suggesting additions and edits to the docs, see the `section on
|
|
contributing to the code <contributing>`_. The procedure is identical
|
|
for contributions to the documentation and the code base.
|