Additional options:
- mediawiki
- docuwiki
Unfortunately, both of these are written in PHP, which means security may be a problem…
Just a thought, what if you created a section here in theCrucible to house the content?
hosting it on the crucible:
pros:
- all the relevant users already have accounts
- no need to learn a new way to write content
- easy image uploads
cons:
- no version control
- no “reviews”
- linking becomes weird
- exporting the documentation is not easy
1 Like
Came across this.
I might have found a reasonable solution in github pages.
The key seems to be to create a new repository for the documentation.
This gives me the ability to invite “collaborators” who can edit the documentation, and non-collaborators can make changes to the documentation using standard pull requests.
Github pages uses “markup”, which is basically the same as what we use here and on the wiki for formatting, so it should be relatively easy to edit. Collaborators can edit pages directly on github, and there is a “preview” tab that lets you see what it looks like before you submit it.
Once submitted, github uses a tool called “jekyll” (which is open source) to convert the pages into HTML and copy those HTML pages into their hosting site. The hosting site can be given an alias so that the site name makes sense.
So let’s see how we’re doing on the requirements…
- indexable by search engines - check
- editing by multiple people - check
- exportable data - check
- printable - no (but maybe there is some support for that in jekyll that I haven’t found yet.)
- wysiwyg - no, but markup + preview is not too bad
- open source: check
- version control: check
- image hosting: check
Assuming I can make it work well and look decent, I think this might be a reasonable solution.
2 Likes
So…basically it got hacked? Lame.
That looks cool! A work in progress, yes?
Documentation is always a work in progress - so yes…
Ok, all dead links fixed, headers, and titles added.
Time for an announcement I think. 