In your opinion, what is the best wiki engine to be associated with discourse?


(Matthieu) #1

it seems that the current discourse wiki will not be ready soon wiki topics. In parallel, it seems to have a Jekyll Wiki in progress Proposing Jekyll as community wiki platform. Yet, I’m still a bit lost in the ocean of wiki engines. There is a lot of them, few seem good, even few should be easily associable with Discourse.

My personal needs are a forum for supporting the community (this will be done by discourse) plus the wiki for hosting the documentation and member projects descriptions.

So what are the best alternatives for hosting a documentation editable by the community ?
I’m wondering how is it possible to associate wikimedia with discourse ? I mean sharing the same user administration rights for example.
What are the well designed engine ? I mean simple interface, great editing tools, customised template, (bootstrap compatible)…


"It's too complicated" complain the users. How did you find the user migration experience?
(versvs) #2

I dont have any news of a wiki being integrated with Discourse. I’m only familiar with old wiki engines (ie. MediaWiki, Doku, etc.).

I guess that using Jekyll for maintaining a Wiki is just good, it integrates well with the idea behind Discourse: bringing to the present time the tools for everyday debate and knowledge tools. Probably this is such an extension that fit into the purpose of a plugin: much people dont really need this functionality in core, but a lot of people would love to have a way of organize the product of the debates into wiki pages that keep the relevant info updated and easy to read/update/access for everyone.


(Matthieu) #3

Thanks for sharing your point of view.

I’m not specialy concern to have an integration between discourse and a wiki engine. It is more to know if there are as good tools for wiki as Stackoverflow is for Q&A or Discourse is for Forum.
I don’t really know Jekyll, as you mention it again and a plugin is in progress for Discourse, it is maybe a sign that Jekyll is relevant as wiki engine.


(versvs) #4

Discourse is an extensible forum software. Thus it is initially designed to build forums, but it may evolve :slight_smile:


(Erlend Sogge Heggen) #5

Please don’t use MediaWiki :stuck_out_tongue: It’s WAY more than any average project needs, and I’ve never found it to be user friendly at all, though maybe that’s changed.

If you want login & privileges integration it’s really anyone’s bet at the moment, since that’ll come down to some awesome person making a plugin for it. And this is why Jekyll is an ideal candidate, because the tricky “who gets to edit what?” stuff is left up to GitHub and the lovely concept of pull requests acting as an edit approval queue.

And, why would you want to tie your Discourse privs closely together with your wiki anyhow? In my experience, this sort of sync always turns into a bloody mess. The most trusted users of your forum aren’t necessarily your most avid doc-writers.

If you ask me (I could swear you did, didn’t you?), the most important “bridge” between your Discourse forum and your Wiki is Markdown. Writing docs should come as natural to your users as writing forum posts, which they’re all very used to. And, as often happens, a user writes up a great manual and just slaps it in a new thread, there’s minimal work involved to transfer it to the wiki.

Aaaanywho, I’m always on the lookout for good wikis myself, so here are some other options worth considering:

http://sphinx-doc.org/

Used to great effect by many GitHub projects. Much like Jekyll’s Prose, it can be hooked up with [ReadTheDocs][1] for greater accessibility. Unfortunately it doesn’t support Markdown out of the box afaik, but the syntax is closely related.

Neat JavaScript/Ruby wiki, so it’ll run on the same stack as Discourse. Supports Markdown.

node.js wiki. Supports Markdown.


The gist of my personal plan for Discourse + Wiki is this:

  • Run the wiki with Jekyll and host its contents on GitHub (but publish through our own site so we can use plugins and possibly web templates we don’t have CC licenses for)
  • Create a “Docs Team” on GitHub, and frequently add active docs contributors to this team.
  • Hook the [Team API][2] up with Discourse, so that whoever’s signed up with their GitHub account can get an achievement for being on the Docs Team, and possibly other activities on the docs repository.

(jon r) #6

If the least common denominator is to have MarkDown within a Wiki, then django-wiki does the trick very well.


(Erlend Sogge Heggen) #7

I’ve run into a couple other interesting (static site generator-) wiki projects since my last post. I’m even more excited about Git / GitHub-powered wikis now that we can even do simple tie-ins with badges. So besides Jekyll, which is still a favorite of mine…

Some newcomers:

GitHub - gilbitron/Raneto: Markdown powered Knowledgebase for Nodejs (node.js)
GitHub - claudioc/jingo: Node.js based Wiki (node.js)
GitHub - mkdocs/mkdocs: Project documentation with Markdown. (Python)


(Matthieu) #8

It looks really interesting. Do you have an exemple of actual wiki using django-wiki ? Did you setup one for yourself ?


(jon r) #9

It’s just a start and alpha I’d say because it uses the old version from PyPI, as I used only the django-wiki-project-template and they didn’t release anything out of master in the last months, but I intend to release it quite soon to the MMM community

I like the idea of multiuser wikis. Also Raneto, which seems to be something I have been looking for for a while. If we had hooks on the repository, with some kind of continuous integration, we’d hack multiuser back in.

Doxx also seems to be an interesting proponent of static site generators.


Edit: Does it seem very likely that we’ll be commiting to some kind of (multilingual) Community Documentation for Discourse after we found a proper consensus here?


Update: Well, it turns out Node-based Jingo performs quite well, with automatic updates to origin master or whatever of your source *.md repository. Interestingly enough, Gollom of course is also a Ruby wiki engine, that runs on top of Markdown git repositories.