Jump to content
thestewman

UnRAID Manual 6 (Downloadable/Printable PDF)

39 posts in this topic Last Reply

Recommended Posts

In fact, I see that you are using mediawiki. A quick search for "mediawiki + pdf" yielded the top result: https://www.mediawiki.org/wiki/Extension:Pdf_Export

 

EDIT: I also see from the 4.7 link above that there is a "printable version" link http://lime-technology.com/wiki/index.php?title=UnRAID_Manual&printable=yes ... this won't give a ToC with clickable links, but if you're actually physically printing, I don't think that works with paper ;-)  It is limited however, in practical functionality, for pages that are "complete" otherwise you'd have to select each page you're interested, open the printable version, and then print it.

 

Yup. That's what I meant,  just to spend tiny amount of time finding proper tools to automate things.

 

Oh come on, you've got to be kidding me.  I know you guys are smarter than this.  Sure, it may take 10 seconds to google search "Media Wiki Automated PDF Conversion" or something like that, but do either of you really think it's just "click install and done"?  There are countless things to consider:

 

1 - Is this add-on official or 3rd party?

2 - Is it compatible with our version of Media Wiki?

3 - Will it break our integration with SMF?

4 - How cleanly does it output the content?

5 - If we use this add-on, will this limit our upgradeability in the future?

6 - How much downtime will it take to apply and test this add-on?

7 - Why are we even doing this when the wiki is fine for 99% of people?

 

And do you want us spending gobs of time figuring something like this out or adding features / fixing bugs in unRAID?  We have plans to reinvest in our website, wiki, and forums at some point in the not-too-distant future, but for now, these types of distractions are just not important enough for us to worry about.  10 years of selling the product without maintaining documentation in downloadable/printable form says so.  I appreciate what Frank did here, but beyond stickying the thread (which I will do), don't expect us to do anything else with this.  It's just a distraction from getting you guys better features and more frequent releases.

Share this post


Link to post

In fact, I see that you are using mediawiki. A quick search for "mediawiki + pdf" yielded the top result: https://www.mediawiki.org/wiki/Extension:Pdf_Export

 

EDIT: I also see from the 4.7 link above that there is a "printable version" link http://lime-technology.com/wiki/index.php?title=UnRAID_Manual&printable=yes ... this won't give a ToC with clickable links, but if you're actually physically printing, I don't think that works with paper ;-)  It is limited however, in practical functionality, for pages that are "complete" otherwise you'd have to select each page you're interested, open the printable version, and then print it.

 

Yup. That's what I meant,  just to spend tiny amount of time finding proper tools to automate things.

 

Oh come on, you've got to be kidding me.  I know you guys are smarter than this.  Sure, it may take 10 seconds to google search "Media Wiki Automated PDF Conversion" or something like that, but do either of you really think it's just "click install and done"?  There are countless things to consider:

 

1 - Is this add-on official or 3rd party?

2 - Is it compatible with our version of Media Wiki?

3 - Will it break our integration with SMF?

4 - How cleanly does it output the content?

5 - If we use this add-on, will this limit our upgradeability in the future?

6 - How much downtime will it take to apply and test this add-on?

7 - Why are we even doing this when the wiki is fine for 99% of people?

 

And do you want us spending gobs of time figuring something like this out or adding features / fixing bugs in unRAID?  We have plans to reinvest in our website, wiki, and forums at some point in the not-too-distant future, but for now, these types of distractions are just not important enough for us to worry about.  10 years of selling the product without maintaining documentation in downloadable/printable form says so.  I appreciate what Frank did here, but beyond stickying the thread (which I will do), don't expect us to do anything else with this.  It's just a distraction from getting you guys better features and more frequent releases.

 

Sorry man i wasn't trying to be that guy.

 

But yeah, its official and compatible. No answers on the rest of your question

 

I did point out the "printable version" link that people can use ;)

 

For the record, my preference is for development with well written inline help even above the wiki. But I know there are procedures best handled in a wiki.

Share this post


Link to post

In fact, I see that you are using mediawiki. A quick search for "mediawiki + pdf" yielded the top result: https://www.mediawiki.org/wiki/Extension:Pdf_Export

 

EDIT: I also see from the 4.7 link above that there is a "printable version" link http://lime-technology.com/wiki/index.php?title=UnRAID_Manual&printable=yes ... this won't give a ToC with clickable links, but if you're actually physically printing, I don't think that works with paper ;-)  It is limited however, in practical functionality, for pages that are "complete" otherwise you'd have to select each page you're interested, open the printable version, and then print it.

 

Yup. That's what I meant,  just to spend tiny amount of time finding proper tools to automate things.

 

Oh come on, you've got to be kidding me.  I know you guys are smarter than this.  Sure, it may take 10 seconds to google search "Media Wiki Automated PDF Conversion" or something like that, but do either of you really think it's just "click install and done"?  There are countless things to consider:

 

1 - Is this add-on official or 3rd party?

2 - Is it compatible with our version of Media Wiki?

3 - Will it break our integration with SMF?

4 - How cleanly does it output the content?

5 - If we use this add-on, will this limit our upgradeability in the future?

6 - How much downtime will it take to apply and test this add-on?

7 - Why are we even doing this when the wiki is fine for 99% of people?

 

And do you want us spending gobs of time figuring something like this out or adding features / fixing bugs in unRAID?  We have plans to reinvest in our website, wiki, and forums at some point in the not-too-distant future, but for now, these types of distractions are just not important enough for us to worry about.  10 years of selling the product without maintaining documentation in downloadable/printable form says so.  I appreciate what Frank did here, but beyond stickying the thread (which I will do), don't expect us to do anything else with this.  It's just a distraction from getting you guys better features and more frequent releases.

 

Sorry man i wasn't trying to be that guy.

 

But yeah, its official and compatible. No answers on the rest of your question

 

I did point out the "printable version" link that people can use ;)

 

For the record, my preference is for development with well written inline help even above the wiki. But I know there are procedures best handled in a wiki.

 

No need to apologize, I just read yours and Brit's post and had one of these moments:

 

Facepalm-Meme-04.png

Share this post


Link to post

I'm not sure how to take that ...

 

Did you "DOH" so hard you can't even?

 

or

 

Did you "WTF" so hard you can't even?

Share this post


Link to post

... Yet if we host it on the website, it implies its officially supported.  There will be an expectation that it will be maintained and when we update the wiki, users who stumble across the outdated PDF will probably be even more confused.

 

"... when we update the wiki ..."  ==>  :) :)    Does this imply that you intend to start keeping the wiki current !!??  If you go to the Wiki today you'll find the "Official Manual" along with a note that it is "... version 4.7 only "  :) :)

 

 

... Most users will probably be just fine using the wiki as opposed to a PDF ...

 

I agree ... but I also think that given a choice many would prefer a PDF manual that they can peruse at their leisure, whether or not they actually print it (most would NOT do that).

 

Share this post


Link to post

... Yet if we host it on the website, it implies its officially supported.  There will be an expectation that it will be maintained and when we update the wiki, users who stumble across the outdated PDF will probably be even more confused.

 

"... when we update the wiki ..."  ==>  :) :)    Does this imply that you intend to start keeping the wiki current !!??  If you go to the Wiki today you'll find the "Official Manual" along with a note that it is "... version 4.7 only "  :) :)

 

 

... Most users will probably be just fine using the wiki as opposed to a PDF ...

 

I agree ... but I also think that given a choice many would prefer a PDF manual that they can peruse at their leisure, whether or not they actually print it (most would NOT do that).

 

I think this is one of those situations where everyone is right.  If you look at the WIKI page, you will see that it is entitled "UnRAID Manual 6".  As you read through it, you will quickly discover that 99% of the material covers only the installation, configuration, and configuration settings of unRAID.  So changes will not (really) be necessary until until the promised dual parity option comes out. 

 

And, even then, how many people will remain with the single parity option?  I certainly hope that the interface and configuration will not be changed dramatically for those folks who decide that dual parity does not really offer that that many advantages over the single parity option when the added cost and complexity are factored in.  (I am thinking primarily of those folks with less than eight to ten drives in their protected array.) 

 

In any case, the changes to the WIKI will probably be to only add another section/chapter or two to cover the setup and configuration.  Will the WIKI be updated instantly or after the dust settles?  Only time will tell.  If, and when, a major update occurs, it will only take a few hours of one of us to get a PDF version of that manual.  Then everyone can have and use what ever they want---  the on-line WIKI, the local PDF file for reference or a printed version that can be read and filed in a notebook.  I know that I will annotated my printed copy with notes that clarify and point to other sections and outside resources.  My current unRAID notebook is an 1-1/2" 'D' ring type and I may have to get a 2" before long!

 

Share this post


Link to post

Whatever happens ... as an 'insignificant' here can I thank Frank for his efforts and say that I for one will find this extremely useful irrespective of where it eventually ends up (but, hey .. it should really be maintained alongside/ahead of the wiki as 'new' users expect at least this level of hand-holding these days and they are the future customer base). I still find things extremely difficult to cross reference even with the wiki so this comes in way ahead of that as, like others have said, it can be held alongside the installation.

Share this post


Link to post

We are not going to maintain our docs in both wiki and PDF form at this time.  Franks efforts here are much appreciated, but PDF versions of our docs will need to be community maintained for now.

 

IS the wiki up-to-date?

Share this post


Link to post

We will do that when the need is clearly demonstrated that folks can't survive without a PDF copy of the manual.  I don't really think this is an issue for the majority of folks, so until someone proves that it is, we won't sweat bullets on it.

What started all of this was an off the cuff remark by myself in another thread about how I was amazed that there wasn't a locally stored copy of the manual included with unraid nor even a link anywhere within unRaid to take you directly to the unRaid manual.

 

Personally, I really don't see the need for a PDF version of the manual when the wiki is available.  But I cannot fathom how you went to all the trouble of creating a decent manual for unRaid, and yet its buried within the wiki, and you make the users jump through hoops (or at least have to go to LT's web page, select support then documentation) when all you need is a simple modification to the help system to bring up a link (or include something in the tools tab that takes you directly to the link)

 

Direct links to documentation is the norm nowadays, not the exception

Share this post


Link to post

This ^^^

 

and I know I said months ago, or longer, that there should be a link on the app and in the header of every page of this forum pointing directly at the WIKI

Share this post


Link to post

Many Thanks to thestewman for agreeing to share this link for the PDF file which I generated using the Text material which LimeTech posted up in their online manual...

 

Thank you!

Share this post


Link to post

Hi, I'm Brazilian and I already apologize for my English.

I'm interested in unraid just for games, currently I use three workstations using the aster program and for compatible games it works great, but has about 30% of games I tested do not work with this program.

my system

processor: ryzen 5 1600x

gpu: gtx 970 windforce

Motherboard: Asus rog strix b 350f

Memory: 20gb ddr4

In aster I do not have to split my hardware so the workstations when required didvidem my hardware.

How does it work in the unraid case?

I could put the 12 cores of my processor, the 20 gb of memory and my gtx 970 for the three workstations? and if I had to split how would it be with the video card I only have one?

Share this post


Link to post

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now