Web Interface Translations

How to Contribute CORE and SCALE Text String Translations 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. To translate the TrueNAS web interface, sign into GitHub and go to the TrueNAS webui repository. Find the appropriate translation file, edit it, and send a Pull Request with your translations to the project.
Read full post gdoc_arrow_right_alt

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. Contents Issue Reporting in Jira: How to report issues using Jira bug reports.

Issue Reporting in Jira

We encourage all users to help us make TrueNAS the best NAS by reporting issues, requesting potentially helpful features, and relaying security vulnerabilities. Issue Reporting in Jira iXsystems 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 or suggest features. Submitting Bug Reports In Jira Go to the TrueNAS project on Jira and click Create in the top bar.
Read full post gdoc_arrow_right_alt

Updating Content

Changes wanted! Contributing changes to the TrueNAS documentation has never been easier. The Documentation Hub has been 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. The repository automatically builds a preview site for each open Pull Request (PR). The link to this preview site is added to the PR as a comment.
Read full post gdoc_arrow_right_alt

Adding a New Article

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.
Read full post gdoc_arrow_right_alt

Content Styling

This guide has many examples of how to style your documentation contributions. TrueNAS documentation uses standardized Markdown, HTML, and Hugo syntax to transform text, add images, 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/ Markdown Examples Headers Use hashes (#) to designate a section of content:
Read full post gdoc_arrow_right_alt

Article Template

Every article needs a “front matter” section that contains the article title and a numeric “weight” that orders the article in the table of contents. You can also include a shortened title for the table contents. The rest of this article contains an example article with front matter, styling, and syntax examples. Please feel free to copy this example and rework it when writing your own articles for this website. The template/ directory can also be copied to provide a starting point for contributing an article bundle that has additional images.
Read full post gdoc_arrow_right_alt