Documentation

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 TrueNAS project welcomes all documentation contributions!

We use 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 and two different tutorial article templates. 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 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.

• Content Styling: How to style your documentation contributions to TrueNAS.
  
  
• Updating Content: How to contribute changes to the TrueNAS documentation.
  
  
• Adding a New Article: How to contribute a new article bundle to the TrueNAS documentation.
  
  
• Article Template: Provides a sample article template for contributing TrueNAS documentation.