Skip to main content

Sharing the knowledge

This post is going to a bit about what I've been doing lately. Well, like any other developer I've been mostly busy with getting the projects released before the big July. But I've also been past-timing a bit on setting up a new wiki.

Yay, I don't have to be the wiki techie any more!

It's been well over a year since I started managing Objectware's Confluence installation. As expected, it was very little work. Confluence basically runs itself once it's set up. Mostly it was upgrading, administering content (deleting and cleaning), doing the odd restart or log-watching. Eventually, after a year or so, the hosting of the wiki was outsourced to a nearby hosting company, cause our instance's database was starting to run a bit slow, and my billing rates were a bit high (hey, I'm a consultant, after all) :)

So good riddance, finally no more booring IT-support work.

Or do I...

Well, not until two months later, anyway. I was asked by a colleague, who's a core driver of our internal Solaris-group (I'll let him remain nameless right now, but he desevers all credit for this stuff), to participate in our latest venture, which I'll get back to, but first..

About two years ago..

I was discussing the still immature wiki with the boss. Already we were seeing effects of decay and staleness in the quickly growing content. He asked me what we should do about it, and I said "I honestly think we should just open it up.". He gave a small laugh and said that was not very realistic. And it wasn't. Too much confidential customer stuff was mixed in with the pure knowledge about various open source projects and tools.

Well, since then our wiki has grown and matured. It is better structured and filled with a lot of good content (much to the credit of the nameless guy mentioned earlier).

Some stats..

It's a meager 3.418 pages. You could be worried that it's a bunch of useless pages, but these pages count 29.555 edits, or nearly 9 edits per page, which I'm guessing is a good number for an internal wiki. 159 different authors have contributed to the content, and there are over 2.000 attachments.

Now, finally due to a lot of internal efforts (not many of which were my own, to be frank), the political descision has been made to open up *some* of the content.

Enter wiki.community.objectware.no

So we took an evening and set it up on our new fancy Sun/Solaris box. Did I mention how easy/great it was to set up a Solaris with a database and Confluence? Well, I did get someone else to do the dirty work of setting up and configuring the zone, but after that it was real easy :)

But why, you ask? Why take our hard-earned intellectual property worth hundreds of hours of consultant hours and just share them with everyone?

Open source, open knowledge

Well, first thing is that the knowledge in those pages isn't worth more than how much they are used. If more people use them, the (especially Java) community can benefit as a whole, and make our work easier/more fun. We have to work with our competitors on many projects, so if we can help them for example understand how to set up a Maven enterprise infrastructure, then we will benefit as well in the long run.

Good PR

Well, obvious argument isn't it :)

We needed a good wiki for these open source projects

We wished to host a Confluence for the Backward Compatibility Tester and the EDR project. More will probably follow soon. Sorry CollabNet, but your wiki sucks.

We need help!

We want input from other people who have experiences with the tools we use. We're hoping that people will contribute back with either their knowledge, or link to places where it exists on the net.

Why it might be a bad idea..

My main concern is that we'll get some negative reactions claiming we are duplicating/harnessing documentation which should reside other places. Well, we're too impatient to wait for these other places to update their FAQs and wiki pages with our stuff. If they wish they can just copy the content back to their sites whenever they feel like it.

There are some other concerns, like what license should we use, spam-prevention, and cross-wiki search (well, atleast now we can search the wiki with Google).

And finally, it might just not take off because people might be too shy to write stuff on the public wiki. Well, we'll see how it goes. No matter what, it will be my (and some others) way of sharing stuff with partners and other people in the community when we want to get some content *out there* quickly. Feel free to use it for the same.

It's not more than 81 pages out there yet, but take a look at the Smidig 2.0 stuff. It has a lot of good stuff about Maven and testing strategies, among other things. We've tried to keep all of it in English but some of it is still Norwegian, unfortunately. Smidig 2.0 roughly translates into "Agile 2.0" and is our pet-name for practices that have evolved after the first wave of agile bubbles. If you know Norwegian you can take a look at Totto's presentation from the Smidig 2007 conference for some more thoughts on that.

Comments

Popular posts from this blog

Open source CMS evaluations

I have now seen three more or less serious open source CMS reviews. First guy to hit the field was Matt Raible ( 1 2 3 4 ), ending up with Drupal , Joomla , Magnolia , OpenCms and MeshCMS being runner-ups. Then there is OpenAdvantage that tries out a handful ( Drupal , Exponent CMS , Lenya , Mambo , and Silva ), including Plone which they use for their own site (funny/annoying that the entire site has no RSS-feeds, nor is it possible to comment on the articles), following Matt's approach by exluding many CMS that seem not to fit the criteria. It is somewhat strange that OpenAdvantage cuts away Magnolia because it "Requires J2EE server; difficult to install and configure; more of a framework than CMS", and proceed to include Apache Lenya in the full evaluation. Magnolia does not require a J2EE server. It runs on Tomcat just like Lenya does (maybe it's an idea to bundle Magnolia with Jetty to make it seem more lightweight). I'm still sure that OpenAdvant

Encrypting and Decrypting with Spring

I was recently working with protecting some sensitive data in a typical Java application with a database underneath. We convert the data on its way out of the application using Spring Security Crypto Utilities . It "was decided" that we'd be doing AES with a key-length of 256 , and this just happens to be the kind of encryption Spring crypto does out of the box. Sweet! The big aber is that whatever JRE is running the application has to be patched with Oracle's JCE  in order to do 256 bits. It's a fascinating story , the short version being that U.S. companies are restricted from exporting various encryption algorithms to certain countries, and some countries are restricted from importing them. Once I had patched my JRE with the JCE, I found it fascinating how straight forward it was to encrypt and decrypt using the Spring Encryptors. So just for fun at the weekend, I threw together a little desktop app that will encrypt and decrypt stuff for the given password

The Git Users Mailing List

A year ago or so, I came across the Git-user mailing list (aka. "Git for human beings"). Over the year, I grew a little addicted to helping people out with their Git problems. When the new git-scm.com webpage launched , and the link to the mailing list had disappeared, I was quick to ask them to add it again . I think this mailing list fills an important hole in the Git community between: The Git developer mailing list git@vger.kernel.org  - which I find to be a bit too hard-core and scary for Git newbies. Besides, the Majordomo mailing list system is pretty archaic, and I personally can't stand browsing or searching in the Gmane archives. The IRC channel #git on Freenode, which is a bit out-of-reach for people who never experienced the glory days of IRC. Furthermore, when the channel is busy, it's a big pain to follow any discussion. StackOverflow questions tagged git , these come pretty close, but it's a bit hard to keep an overview of what questio

Git tools for keeping patches on top of moving upstreams

At work, we maintain patches for some pretty large open source repositories that regularly release new versions, forcing us to update our patches to match. So far, we've been using basic Git operations to transplant our modifications from one major version of the upstream to the next. Every time we make such a transplant, we simply squash together the modifications we made in the previous version, and land it as one big commit into the next version. Those who are used to very stringent keeping of Git history may wrinkle their nose at this, but it is a pragmatic choice. Maintaining modifications on top of the rapidly changing upstream is a lot of work, and so far we haven't had the opportunity to figure out a more clever way to do it. Nor have we really suffered any consequences of not having an easy to read history of our modifications - it's a relatively small amount of patches, after all. With a recent boost in team size, we may have that opportunity. Also the need for be

Managing dot-files with vcsh and myrepos

Say I want to get my dot-files out on a new computer. Here's what I do: # install vcsh & myrepos via apt/brew/etc vcsh clone https://github.com/tfnico/config-mr.git mr mr update Done! All dot-files are ready to use and in place. No deploy command, no linking up symlinks to the files . No checking/out in my entire home directory as a Git repository. Yet, all my dot-files are neatly kept in fine-grained repositories, and any changes I make are immediately ready to be committed: config-atom.git     -> ~/.atom/* config-mr.git     -> ~/.mrconfig     -> ~/.config/mr/* config-tmuxinator.git       -> ~/.tmuxinator/* config-vim.git     -> ~/.vimrc     -> ~/.vim/* config-bin.git        -> ~/bin/* config-git.git               -> ~/.gitconfig config-tmux.git       -> ~/.tmux.conf     config-zsh.git     -> ~/.zshrc How can this be? The key here is to use vcsh to keep track of your dot-files, and its partner myrepos/mr for o