New Format for Publishing Docs

[MMacD]

[QUOTE="gpsguy, post: 169879, member: 21567"
After I created the HTML file, I created a .tar.gz of the _build directory and uploaded it to a FTP server, for easier retrieval.[/QUOTE]

Many thanks! It will save me beaucoup de work.

 

[erch]

This is a long post. If you are TLDR;, please at least skim through this before complaining about the current doc transition :)

The FreeNAS project has published a User Guide for each major software version since version 8.0.1. The platform for making the documentation has been mediawiki, which allows for collaborative editing of the upcoming version. This makes it easy for anyone to contribute to the documentation as they only need to make a wiki account and mediawiki formatting is fairly quick to learn and well documented. However, this method has several disadvantages:

.
.
.

For users who are interested in assisting with doc edits, instructions for getting started are at https://github.com/freenas/freenas/blob/master/docs/userguide/README. Feel free to ping me if you need help getting started. If you have a simple change you would like to see committed you can also ping me through the forums, IRC channel, or doc mailing list and I can commit the edit for you.

The hyperlink needs to be fixed (missing .md), the correct URL is:

https://github.com/freenas/freenas/blob/master/docs/userguide/README.md

 

[dlavigne]

Fixed!

 

[dlavigne]

Note that the repo has moved and the README has been updated to note the new location: https://github.com/freenas/freenas-docs/blob/master/README.md.

 

[gpsguy]

Thanks for the heads up!

Now that building from the new repo yields version 9.10.1, do you know when this version is scheduled for release?

 

[dlavigne]

It was supposed to be today but there was a last minute Samba security fix that still needs to be tested so it looks like it will be next Monday instead. The only bits which are different from 9.10 are listed in the What's New section of https://github.com/freenas/freenas-docs/blob/master/userguide/freenas_intro.rst (though the Samba version will be bumped up to 4.3.11).

 

[OmegaMan1977]

thanks it's appreciated