Skip to content

Add TrueNAS SCALE installation guide#1713

Merged
fgalz merged 8 commits intozaphosting:masterfrom
HeyYuvraj:master
Mar 12, 2026
Merged

Add TrueNAS SCALE installation guide#1713
fgalz merged 8 commits intozaphosting:masterfrom
HeyYuvraj:master

Conversation

@HeyYuvraj
Copy link
Contributor

Added dedicated-truenas-scale.md: a step-by-step guide for installing TrueNAS SCALE on dedicated servers.
@cursor
Copy link

cursor bot commented Mar 2, 2026

PR Summary

Low Risk
Low risk documentation-only change; main risk is broken navigation/linking if the new doc id or URLs are incorrect.

Overview
Adds a new guide, docs/server-truenas-scale.md, covering TrueNAS SCALE installation on a dedicated server (ISO mounting via iLO, install steps, initial configuration, pool/dataset/user creation, and SMB share access).

Updates docs navigation to surface the new guide by adding a card link in docs/software-overview-services.md and including server-truenas-scale in sidebars.js under software services.

Written by Cursor Bugbot for commit 8a020bf. This will update automatically on new commits. Configure here.

@fgalz
Copy link
Collaborator

fgalz commented Mar 6, 2026

Hey @HeyYuvraj,

I'll review the contribution submission in detail at the beginning of next week and follow up with feedback afterwards. 🙂

@fgalz
Copy link
Collaborator

fgalz commented Mar 10, 2026

Hey @HeyYuvraj

I took a first look at your submission and wanted to share some initial feedback.

One thing that stood out quite quickly is that the structure and overall presentation of the text does not fully align with our documentation guidelines. The formatting and phrasing also resemble a typical AI generated content, especially in the way the content is organized.

Using AI tools to help with ideas or to improve wording is generally not an issue, and we also make use of them in certain situations. However, the content should not primarily rely on AI-generated outputs or follow the typical bullet-point style and generic phrasing often produced by such tools.

Otherwise it makes the purpose of the Contribution Program superfluous, which is intended to reward individual effort and original work. This does not mean that you did not put work into the guide, but the text structure and writing style should be revised to better match our documentation standards. In particular, we aim to avoid bullet-style or checklist-like instructions and instead prefer a more natural guide structure.

If you could revise the text accordingly, we will then proceed with the final review afterwards. In case you have any questions regarding this, please let me know. 🙂

@fgalz fgalz added the Changes requested The content does not yet meet all requirements and therefore needs further adjustment label Mar 10, 2026
Revise the TrueNAS SCALE guide to better align with documentation
standards.
@HeyYuvraj
Copy link
Contributor Author

Hey @fgalz,
Thanks for the detailed feedback!
I've revised the guide to better match the documentation standards. I restructured it into 6 flat sections, replaced the subsection headings and checklist-style instructions with flowing paragraph and cleaned up the phrasing throughout. Let me know if there's anything else to adjust! 🙂

@fgalz fgalz added TRANSLATE DOCUSAURUS Docusaurus translate process and removed Changes requested The content does not yet meet all requirements and therefore needs further adjustment labels Mar 12, 2026
@github-actions
Copy link
Contributor

Translations have been generated and are available in #1731.
Please merge the translation PR after this PR is merged.

@github-actions github-actions bot removed the TRANSLATE DOCUSAURUS Docusaurus translate process label Mar 12, 2026
@fgalz fgalz merged commit 94545c2 into zaphosting:master Mar 12, 2026
3 checks passed
@fgalz
Copy link
Collaborator

fgalz commented Mar 12, 2026

Hi @HeyYuvraj ,

we accept your submission for this contribution and thank you for your interest and participation in the Contribution Program. However, even after the first revision, several adjustments were still necessary because the writing style in some sections was quite short and dry. In addition, a few minor content changes were required to ensure the documentation aligns with the current standards.

As a small note for the future regarding images, we generally try to display as many images as possible in a larger format. This makes it easier to follow the content without the reader having to constantly move their eyes between elements and helps keep the layout more consistent.

It is also worth taking a look at the GIF feature in ShareX. In some cases, multiple steps can be shown in a single animated image, which can help reduce the total number of separate images needed like we do in a quite a few guides already.

Would you prefer to receive your reward in ZAP Coins or via PayPal? We offer a 30 percent bonus for ZAP Coins. More details can be found in our Contribution Program Rewards document.

Please let us know your preferred option. You will then be contacted shortly via ticket, where all further details regarding the reward and next steps will be shared. 🙂

fgalz added a commit that referenced this pull request Mar 12, 2026
* Add TrueNAS SCALE installation guide

Added dedicated-truenas-scale.md: a step-by-step guide for installing TrueNAS SCALE on dedicated servers.

* Revise Dedicated TrueNAS SCALE guide

Revise the TrueNAS SCALE guide to better align with documentation
standards.

* Tweaks

* Replace Screenshot source with ZAP CDN

* Tweaks

* Sidebar/Linkage

* Auto-translate docs

---------

Co-authored-by: Yuvraj Verma <62199410+HeyYuvraj@users.noreply.github.com>
Co-authored-by: fgalz <florian.galz@outlook.com>
Co-authored-by: github-actions <github-actions@github.com>
@HeyYuvraj
Copy link
Contributor Author

Hi @fgalz,
Thanks for accepting the guide. I appreciate the feedback and will keep your suggestions in mind for future docs. I would prefer to receive the reward via PayPal. Please let me know if you need anything from my side.
Thanks! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants