both Wikis are backed by Git repo both allow local edit Gollum # See https://github.com/github/gollum#readme
Installation: http://alblue.bandlem.com/2011/05/git-tip-of-week-gollum.html
sudo gem install gollum
Running # git init TestWiki gollum --page-file-dir wiki TestWiki openurl http://localhost:4567 Parsers - separate install # gem install rdiscount gem install wikicloth Get Wiki for repo # git clone URL URL: - git@github.com:radegast/dotvim.wiki.git R+W - https://radegast@github.com/radegast/dotvim.wiki.git R+W - git://github.com/radegast/dotvim.wiki.git R Pros # multiple markups supports Markdown List of all pages Questions # How to link to page in subdir
Even with having Wiki as the main documentation repository, not all documentation ends up in a Wiki. Some documentation needs to be managed as part of the source tree - e.g. Readme's, compilation instructions and similar. This information is usually either plain text or in some form of text processor format, mostly Microsoft Word compatible. Both have their selection of problems. Word documents are large, bloated, harder to version controlled and not readable in shell environment (try to cat or tail Word document :-)). The plain text format lacks visual structure and without headlines, bold/italic, font sizes etc is harder read.
It has been half a year in March since we have started to use Wiki as main project management, collaboration and content creation tool. I think this is period long enough to look back and summarize what we have discovered, what worked and what not. This was not the first attempt to use Wiki in this context - however, it was first case when the result can be considered full success. I have tried (both in at-home and project environments) several Wiki implementations, notably JSPWiki,MoinMoin, FlexWiki, Wiki module for DotNetNuke and MediaWiki over period of about 5 years. During this process I have discovered by trial and error, which features are important in software development project environment and what are the conditions/consequences of using Wiki as main information hub.
Since the beginning of the biometric security project, we are using an excellent enterprise-level Wiki Confluence as knowledge repository and main team communication tool. I was not sure at the beginning, how will the Wiki approach work for all the people on the team, mostly because once before I already tried it and had not much success of introducing the idea. It was few years ago and the Wiki engine I used were nowhere in the same league as Confluence, but main problem at that time was probably the users' mindset. I am happy to report that this time it worked really really well. I am not sure whether it was because of the fantastic user friendly features and capabilities of Confluence, or because the general awareness shifted thanks to sites like Wikipedia and people got used to the idea of user created content ... The truth is that Wiki's are mainstream now - inside or outside of the enterprise space.