Oct 19 2004

Easier documentation

Published by at 11:34 am under Subversion

This is an old article and the information contained within it may be out of date, not reflect my current views and/or contain broken links. If you feel this article is still valid and requires updating, you can use the contact form to let me know. However, I make no guarantee that it will get updated.

When installing a new software system, what you really need is some simple documentation to give a brief overview of the system and how it can be setup and the various options that are available. And this is exactly what I could have done with for Subversion.

The documentation that comes with Subversion is very comprehensive and covers everything that the system can do to help me with managing my project source code. Unfortunatrly, what it doesn’t do is to give me a concise overview of the various ways in which Subversion can be accessed (direct, subversion protocol and Apache http). It did give details of how to setup each of these methods but what I wanted to know was which of these methods was best for me.

In the end, I had to try all of them (with varying degrees of success). FInally I tried using TortoiseSVN to access my Subversion repository. I also had a read through the TortoiseSVN help documentation and found that they also give information on setting up Subversion and how it can be configured to authenticate a user against a Windows domain when Subversion is accessed via the Apache http server, which is exactly what I wanted to do but didn’t know how to.

I’m not saying that the documentation that is provided with Subversion is bad but they could do with providing simple access to more information about how to setup the system and what the system is capable of.

No responses yet