Contributing

The TrueNAS project welcomes all documentation contributions! We are using Hugo to create this documentation website and the Geekdoc theme for general website styling. Articles are written in a combination of Markdown and HTML syntax.

The tutorials in this section are designed to guide you with different kinds of documentation contributions. There is also an article template that you can copy and use to submit new articles. Please feel free to propose changes and add new content in 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.

• Web Interface Translations

How to contribute TrueNAS interface text string translations.

• Issue Reporting

We encourage all users to help us make TrueNAS the best NAS by reporting issues, requesting potentially helpful features, and relaying security vulnerabilities. Article Summaries Issue Reporting in Jira This article provides information on how to report issues to TrueNAS.

• Issue Reporting in Jira

This article provides information on how to report issues to TrueNAS.

• Documentation

This section has articles describing how to contribute documentation to the TrueNAS projects.

• Updating Content

This article describes how to contribute changes to the TrueNAS documentation.

• Adding a New Article

This article describes how to contribute a new article bundle to the TrueNAS documentation.

• Content Styling

This article describes how to syle your documentation contributions to TrueNAS.

• Article Template

This article provides a sample article template for contributing TrueNAS documentation.