This guide has many examples of how to style your documentation contributions. TrueNAS documentation uses standardized Commonmark Markdown, HTML, and Hugo syntax to transform text, add images, stylize tables, and link to other locations. The guide is not exhaustive but contains examples of the elements that are most commonly used when writing TrueNAS documentation. To learn more about each markup language, see these resources:

• Markdown: https://daringfireball.net/projects/markdown
• Commonmark: https://spec.commonmark.org/
• HTML: https://www.w3schools.com/html/default.asp
• Hugo: https://gohugo.io/documentation/

TrueNAS Documentation Hub articles make use of the following formatting options:

By default, TrueNAS is available in English. However, users can contribute text string translations for the TrueNAS web interface to help make TrueNAS available in many other languages! Contributing requires a GitHub account and the ability to translate English text into other languages.

TrueNAS is an open-source project, and we welcome contributions from the community. We license our code under the GPLv3 license.

This guide explains how to contribute code updates to the TrueNAS web interface.

Follow these steps to pick up a task, make your changes, and submit a PR.

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.

We encourage all users to help us make the open source TrueNAS project the best NAS by reporting issues with TrueNAS releases, requesting potentially helpful features, and relaying security vulnerabilities.

The articles listed below provide information on reporting issues or to request changes or new content.

We encourage all users to help us make TrueNAS the best NAS by reporting issues, requesting potentially helpful features, and relaying security vulnerabilities.

TrueNAS uses Jira to track bugs and develop features. You can view public issues without logging in, but you must create an Atlassian account to report bugs.

Changes wanted! Contributing changes to the TrueNAS documentation has never been easier. The Documentation Hub is specifically built to allow users to quickly propose changes to the content without having to install any special applications. All that is required is to have a GitHub account and a basic understanding of Markdown.

You need to log in to your GitHub account to propose any changes. The repository automatically builds a preview site for each open pull request (PR) created in GitHub. The link to this preview site is added to the PR as a comment. The preview updates with the changes you make to the pull request, so you can always see an accurate preview of the changes you make to the website.

Thanks for your interest in submitting documentation articles! This article shows you how to add a new article to the TrueNAS Documentation Hub. All that is required is a GitHub account and your favorite text editor. Taking screenshots for your article is also recommended.

To add an article, construct a bundle that contains your text file and any images, then open a pull request on the repository. There is an Article Template available that can simplify creating your article.

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.

This template provides general information on constructing and writing TrueNAS tutorial articles. It contains a template example article with front matter, styling, and syntax examples.

Refer to the Style Guide for specific text syntax and formatting examples, Markdown and Hugo website enhancements, and content guidelines to follow.

Application tutorials follow a specific format that covers the installation screens and deployment process. If submitting a tutorial for a community-maintained application article, please see Contributing to Apps and the Community App Tutorial Template at the TrueNAS Apps Market.