Fri 31 Aug 2012 10:50PM

Documentation platform

T twain Public Seen by 34

twain Fri 31 Aug 2012 10:50PM

Which platform do you prefer? I think MediaWiki is a good choice. It's pupular and easy to use. It's easy for everybody to fix mistakes and translate the docu.


Poll Created Fri 31 Aug 2012 10:52PM

MediaWiki Closed Mon 3 Sep 2012 2:18PM

What do you think of MediaWiki?


Results Option % of points Voters
Agree 0.0% 0  
Abstain 100.0% 4 ST FS HF BO
Disagree 0.0% 0  
Block 0.0% 0  
Undecided 0% 17 MS S JH JR F M G T DY SH DU DS PP W A RF Y

4 of 21 people have voted (19%)


Sean Tilley
Fri 31 Aug 2012 11:20PM

Dunno how I feel about MediaWiki. It's robust, true, but we'll also need to think of where to host it if we switch to it. Regardless of platform, we need to ensure easy doc navigation to minimize clutter.


Hans Fase
Sat 1 Sep 2012 6:21PM

I am kinda neutral on this, while I think the Github wiki could be better there are still other options rather than going with MediaWiki.

One option I mentioned before was using a Octopress or Jekyll based site...


Florian Staudacher
Sun 2 Sep 2012 12:29AM

doesn't have to be mediawiki. I have some experience with it and I really like it, but there might be better choices out there for documentation of a software project...


Sean Tilley Fri 31 Aug 2012 11:15PM

Not sure how I feel about MediaWiki really. Although I will agree that GitHub's Wiki reaches a bit short of what we want it to do, we have to consider two things:

1.) The wiki, from a usability standpoint, should be pretty simple and easy to navigate.

2.) If we're doing MediaWiki, then we should find a place to host it from within the Diaspora community infrastructure.

Truth be told, one of the loom.io team members told me that they plan on bringing wiki functionality to loom.io itself. I'm a little curious to see as to whether that might be useful.


twain Sun 2 Sep 2012 1:10PM

Which platform do you prefer? suggestions?


twain Sun 2 Sep 2012 1:18PM

...because of hosting. when we gonna use loom we have to host it to right? So the hosting problem is a problem we have surely.


twain Sun 2 Sep 2012 1:54PM

What do you think of using LaTeX and converting this to html?
For working together we could use git, exchanging the LaTeX files. I have no experience with this, just an idea.
I think its not so easy for newcomers to join the docu team or just write a short tutorial with LaTeX.
In my opinion it's important that it is easy for everybody to improve or write articles.


altruism Tue 11 Sep 2012 10:11PM

Florian, "...but there might be better choices out there for documentation of a software project" such as? I'm interested to know about our options (concurrent proposals).


groovehunter Tue 11 Sep 2012 10:24PM

the one concurrent proposal I see is to put it all on the drupal site .

But a wiki is a wiki. And there are so many people who can work with mediawiki


Sean Tilley Wed 12 Sep 2012 1:34AM

Interestingly, it's actually quite possible to add it to Drupal itself. There's a great couple of modules that you can string together to add wiki functionality. This video here gives a simple demonstration: http://www.youtube.com/watch?v=KHsjjHzYOSg

What I like about a "CMS for a Project Site" approach is that a lot of infrastructure can be baked in, and we could have a solid user account system for actively contributing directly to the project itself, from its own website.


groovehunter Wed 12 Sep 2012 5:26AM

I will try today the drupal wiki. Last time I did was about a year ago. Freelinking had some issues. Maybe it improved.
To have it on one platform would be good.


Sean Tilley Wed 12 Sep 2012 6:14AM

Cool, let me know how it goes! :)


groovehunter Wed 12 Sep 2012 10:04AM

installed a test drupal site on http://diasporatest.openspirit.de
@Sean , yep will do.


altruism Wed 12 Sep 2012 10:16AM

"Your application for an account is currently pending approval" do Drupal have alternatives or is this the only way to manage registration of new users?


altruism Wed 12 Sep 2012 10:51AM

I also tested to create a wiki page, it is also waiting for approval. Just for evaluation, can we turn "off" approval?


groovehunter Wed 12 Sep 2012 12:07PM

I find it hard to setup this wiki. But havent watched the video yet, will do now.


altruism Wed 12 Sep 2012 12:10PM

I know you are testing it, be cool.


groovehunter Wed 12 Sep 2012 12:26PM

On test platform I set registration mode free.

@all who are interested in drupal tests or discussion apply for new subgroup!
So we can continue discussion there!?


Sean Tilley Wed 12 Sep 2012 4:14PM

No, we should keep discussion on here for the most part. I don't want to have to check three or four different sites just to have a conversation. ;)


altruism Wed 12 Sep 2012 4:17PM

Sean, I think he meant a sub-group here in Loomio.


Sean Tilley Wed 12 Sep 2012 4:18PM

Oh. :P


Jordan H Tue 18 Sep 2012 8:26PM

One suggestion I have: we could use the Wiki for macro-level documentation (what certain folders are used for, and so on) and use Doxygen for code-level documentation for easy look-up.
I am confused as to where documentation is being used. Stack Exchange or Wiki?


Sean Tilley Tue 18 Sep 2012 9:14PM

Currently, all documentation is located on our GitHub repo's wiki. However, as we're thinking about some changes in infrastructure, we're considering better options.

So far, two of the more practical options (if we go the self-hosted route) are as follows:

1.) Use MediaWiki. MW is tried-and-true, and is pretty easy to organize.

2.) Build into Drupal using a wikitools and FreeLinking module set. The upside of this is that we can integrate wiki functionality directly into the Drupal platform, which could serve several other functions as a central project site, and provide a useful set of reasons to register a single account.


goob Tue 18 Sep 2012 10:20PM

I think a self-hosted wiki would be the best way forward. I can't really comment on the technical benefits of different systems as I don't know anything about them, so will leave that up to those who do. It sounds promising.