Files
warewulf/docs/docs/contributing/documentation.md
2021-03-03 07:55:23 +09:00

1.4 KiB

id, title
id title
documentation 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 or by sending a pull request on our repository for documentation.

The current documentation is generated with:

Other dependencies include:

More information about contributing to the documentation, instructions on how to install the dependencies, and how to generate the files can be obtained here.

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. The procedure is identical for contributions to the documentation and the code base.