Slide 1: GSI Wiki - a collaborative documentation tool

• Why?
• Wiki, what's that?
• Twiki
• GSI specific installation
• Enhanced features
• Roadmap

Slide 2: Wiki? - Why?

• Different tools for read and write; no ubiquitous write access.
• Lousy link maintenance.
• Collaborative? Read access for the whole team, write access only for me.

• Too static!
  • Most of the content is always outdated.

• Central GSI CMS did not meet the requirements ...

Slide 3: Wiki? - What's that?

• Wiki wiki: Hawaian word for quick
• WikiWikiWeb initially developed by Ward Cunningham:
  • Set of HTML pages (Topics)
  • Quick'n'dirty editing capabilities: [Edit this topic]
  • Automatic linking using WikiWords (CamelCase):
    • TopicThatDoesNotExist, ExistingTopic
  • Trivial markup

| 1 |  2  |  2 |
| 4 |  5  |  6 |

• easy
• open
• incremental
• organic

• chaotic?

Slide 4: Wiki - Is it working?

• Wikipedia: the free encyclopedia
  • founded in 2001
  • available in more than 100 languages
    • more than 50 with 1000 topics and more
  • 1,3 million topics overall
    • 400000+ in Englisch
    • 200000+ in German
  • Associated projects:
    • Wiktionary: dictionary
    • WikiNews: news portal
    • WikiTravel: travel guide

Slide 5: Wiki! - Which?

MediaWiki

The Wikipedia engine, PHP + MySql, focussed on the features needed for Wikipedia.

TikiWiki

Emerged to an all inclusive CMS (Photo galleries, WebMail etc.)

MoinMoin

A popular Python Wiki

KWiki

Simple Perl implementation with limited features

UseModWiki

Another Perl Wiki

EclipseWiki

Personal Wiki as a Plugin for Eclipse IDE

jotspot

Polished commercial Wiki (beta) with WYSIWYG and Email-Gateway

Slide 6: TWiki - Why?

• Revision control and Changelog
• Integrated access control on a per web and per topic basis
  • Set ALLOWTOPICCHANGE = Christo
• Attachment management
• Tracing of most recent changes
  • Syndication with RSS
  • Email notifications
• Hundreds of plugins and add-ons
• Implementation in Perl based on the UNIX toolbox:
  • Filesystem based
  • RCS for revision control
  • Search using grep

• twiki.org: No. 15 on the list of largest wikis by article count
• Successfully used by BT, Disney, Motorola, SAP, Wind River, Yahoo, ...

Slide 7: Advanced features

• Macros for dynamic content: %SEARCH{"text"}%, %TOC%, ...
• Templates define topic patterns
• Meta data may be added to topics using forms

InterwikiPlugin

Shortcuts for external URLs
GSI Oracle device database, manpages, Debian packages, Debian Bugs, Wikipedia, ...

BeautifierPlugin

for pretty printing of source code

TWikiDrawPlugin

draw diagrams using a java applet

MathModePlugin

renders embedded LaTeX formulas

Slide 8: Advanced features

SpreadSheetPlugin

add calculations to TWiki tables

ChartPlugin

Render charts from data in TWiki tables

CommentPlugin

Add content skipping Edit Preview Save cycle

DiscussionForumAddOn

run TWiki as a bulletin board

SlideShowPlugin

turns a topic into a HTML presentation

GenPDFAddOn

turns topics into PDF

Slide 9: TWiki weaknesses

Usability

It's a geek tool

Performance

File system backend and complex rendering engine (variable expansion, ...)

Scalabilty

Webs should not grow to large?

Design

No clear cut between data and code complicates upgrade

Slide 10: GSI Wiki

Slide 11: Current GSI Wiki status

• Unique position as documentation tool for the GSI Linux team
  • Knowledge base
  • Installation log
  • Hardware Database
  • Meeting minutes
  • Trouble ticket system
  • Group calendar

• Used all over the IT department:
  All OS's, Oracle, Operating, Security, Grid, Controls

• Adopted by the experiments: Hades, CBM, ...

Slide 12: TWiki management practices at GSI

• Open registration from inside GSI: Users register themselves

• Read access == write access

• Many small groups
  • Normally a one-to-one mapping of groups to webs
  • Every member of a group can add new members

• Email notification: Per web digest 2 times a day

• Daily backup on filesystem level (TSM)

• In the long-term an editor-in-chief has to keep the stuff together?!

• Evolution from free form content to TWiki applications representing workflows

Slide 13: Roadmap

• Migration to new server, upgrade to the current release
  • Mainly usability + bugfixes

• Virtual Wikis
  • Provide collaborations with their own distinct wiki space
  • Share same codebase, but distinct data

• Wikify the GSI Linux team's webserver

• Enhance usability
  • Smarter update notifications (Email, Instant Messaging?, RSS)
  • Data import/export (HTML, PDF, MS Office)
  • WYSIWYG editor
  • Search index in addition to built-in grep

Slide 14: Roadmap

• Increase performance
  • Develop a benchmark procedure
  • Evaluation of CGI accelerators, esp. mod_perl
  • Evaluation of cache addons

• Availabilty, Clustering, Content export

• Advanced TWiki applications:
  • Better utilization of meta data and forms
  • IT department announcements (walls)
  • Portal

• Perform GSI internal wiki training

• Set ALLOWTOPICCHANGE = Christo
• Set ALLOWTOPICVIEW = *

More information

• FoswikTodo: GSI Wiki todo list

• twiki.org:
  • TWiki:Codev/TWikiAdvocacy01Sep2004
  • TWiki:Main/TWikiSuccessStories
  • TWiki:Plugin/PluginPackage
  • TWiki:Plugin/AddOnPackage
  • TWiki:Codev/TWikiVsOtherProducts
  • TWiki:Codev/MsOfficeIntegration
  • TWiki:Plugins/DatabaseAddOn
  • TWiki:Codev/TWikiNewsPortal

• Wikipedia:Wiki
• Wiki:WikiWikiWeb
• Wiki:WikiEngines
• http://www.onlamp.com/pub/a/onlamp/2004/11/04/which_wiki.html
• InfoWorld: Year of the enterprise Wiki