Contributing

We welcome community contributions to keep this documentation current! Click Edit Page in the top right corner to propose changes to this article. See Updating Content for more information.

The open-source TrueNAS project welcomes contributions to the project. We also welcome changes to articles found in the TrueNAS Documentation Hub.

Contributions to the TrueNAS open-source projects are made through GitHub and Jira.

The Documentation hub uses Hugo to create the documentation website and the Geekdoc theme for general website styling. Articles are written in a combination of Markdown and HTML syntax.

There are a number of ways members of the TrueNAS community can give back by contributing to TrueNAS and its documentation.

Articles in this section include instructions for contributing code improvements to the TrueNAS Web UI, providing i18n UI translations, reporting issues and making Feature Requests, and contributing to TrueNAS documentation.

For information on contributing applications to the catalog or app documentation and resources to the TrueNAS Apps Market, see Contributing to Apps.

Refer to the tutorials in the Documentation section for articles designed to guide you through requesting changes, making different kinds of documentation contributions, and contributing to TrueNAS itself.

Article templates for general tutorial articles and new application tutorials are provided that you can copy and use to submit new articles.

Please feel free to propose changes and add new content to these articles to help others learn how to contribute to project documentation!

Want to discuss your in-progress changes or other TrueNAS contributions? The TrueNAS contributors #truenas-docs Slack workspace is available for contributors to discuss their changes and help each other improve the software. You can request to join this workspace at truenas.slack.com.