Technical Documentation
-
@Dashrender I want to categorize my articles by topic: (printing, blackberry, etc.)
-
Interesting - there might be tags like there are here in ML. Otherwise the search function is your friend.
In my case I'll end up making Table of Contents pages that will link to other pages talking about the topic linked.
Think about an employee handbook. There will be a TOC, and it will have links to each section of the handbook.
You could do the same, create pages of links for Printing, Blackberry, etc - as you create a new article/page you'll create a link to those on the (we'll call them) main pages.
Then on the homepage to the wiki, you can have links to this main pages.
-
I'm the only person that ever references the documents, so I use an encrypted and password protected instance of TiddlyWiki. Super easy to update, maintain, and implement and no server required. It isn't ideal for all situations, but it works really well for me.
-
Also, it allows for association of articles using tags, and all entries are queriable.
-
@aaronstuder said:
Anyone know of a good CentOS 7 install guide for dokuwiki?
http://lmgtfy.com/?q=centos+7+install+dokuwiki
Sorry for just link dropping, I normally at least check one out, but I'm already in vacation mode.
-
Last place I was I used LaTeX. There wasn't much to document but it made formatting easy and nice.
-
@Dashrender said:
@aaronstuder said:
A wiki does seem much simpler
But formatting sucks!
Wikis don't lack formatting. Different ones have different amounts. They all have some. Some have a lot.
-
@coliver said:
@aaronstuder said:
@coliver said:
It is so easy to install doku or mediawiki that I don't think I would go turnkey.
Which one would you use? or What would you be leaning towards?
This is for public docs, and private docs so I need some control over who can see what.
I've only ever stood up a MediaWIki server. Dokuwiki looks to be easier to implement. Both can do authentication and authorization. So you wouldn't have any issues locking down certain areas.
We used to use DokuWiki, it is very easy to implement.
-
@aaronstuder said:
@Dashrender I want to categorize my articles by topic: (printing, blackberry, etc.)
As with all things like this.... categories are bad, tagging is good. There is a reason that the industry and taxonomic research moved to this decades ago. So much more power, so much more flexible. All the benefits, none of the negatives.
Just add a tag or keyword area to your pages and you get tag-like functionality.
-
We've used DokuWiki and MediaWiki but these days are using Sharepoint which is a wiki.
-
@scottalanmiller said:
We've used DokuWiki and MediaWiki but these days are using Sharepoint which is a wiki.
I'm thinking of using a Raspberry Pi as a Web Server for this purpose. It's just text documents.
-
@wirestyle22 said:
@scottalanmiller said:
We've used DokuWiki and MediaWiki but these days are using Sharepoint which is a wiki.
I'm thinking of using a Raspberry Pi as a Web Server for this purpose. It's just text documents.
Do you have a VM infrastructure?
-
@coliver said:
@wirestyle22 said:
@scottalanmiller said:
We've used DokuWiki and MediaWiki but these days are using Sharepoint which is a wiki.
I'm thinking of using a Raspberry Pi as a Web Server for this purpose. It's just text documents.
Do you have a VM infrastructure?
I have a VM host server (ESXi) but I also have a Raspi 2 just sitting here. I'd rather use those resources for other stuff like a proxy etc.
-
We did a wiki for awhile but I was the only one in my department who could be bothered to actually use it (come on guys, Markdown is not that hard). So we used Evernote Business for awhile and have now settled on a shared OneNote. It works pretty well, and the search works great, but still, I'm typically the only one entering new documentation into it. But that's a people problem, not a platform problem.
-
@wirestyle22 said:
@coliver said:
@wirestyle22 said:
@scottalanmiller said:
We've used DokuWiki and MediaWiki but these days are using Sharepoint which is a wiki.
I'm thinking of using a Raspberry Pi as a Web Server for this purpose. It's just text documents.
Do you have a VM infrastructure?
I have a VM host server (ESXi) but I also have a Raspi 2 just sitting here. I'd rather use those resources for other stuff like a proxy etc.
The VM for this should only require maybe 1 GB of RAM and 20-40 GB of disk, and nearly zero CPU. Even if I had 100 r-pie's I'd still run this on my VM platform assuming I have the RAM and storage available.
heck, you can probably do less storage too.
-
@Dashrender said:
@wirestyle22 said:
@coliver said:
@wirestyle22 said:
@scottalanmiller said:
We've used DokuWiki and MediaWiki but these days are using Sharepoint which is a wiki.
I'm thinking of using a Raspberry Pi as a Web Server for this purpose. It's just text documents.
Do you have a VM infrastructure?
I have a VM host server (ESXi) but I also have a Raspi 2 just sitting here. I'd rather use those resources for other stuff like a proxy etc.
The VM for this should only require maybe 1 GB of RAM and 20-40 GB of disk, and nearly zero CPU. Even if I had 100 r-pie's I'd still run this on my VM platform assuming I have the RAM and storage available.
heck, you can probably do less storage too.
Much less RAM as well. I think you could get away with 128 or 256MB.
-
Done and done
-
@crustachio said:
We did a wiki for awhile but I was the only one in my department who could be bothered to actually use it (come on guys, Markdown is not that hard).
I feel your pain.
-
This post is deleted! -
@aaron said:
@aaronstuder
@aaronstuder said:
@Dashrender I want to categorize my articles by topic: (printing, blackberry, etc.)
In DokuWiki that would be namespaces. The only problem I've seen with categorizing in DokuWiki are people accidentally making a page in the root namespace, otherwise it's pretty simple.
Yeah, the namespace system adds a lot of complication for end users.
