Search code examples
ubuntusvnrabbitvcs

How to configure RabbitVCS?


I have installed rabbitvcs-core and rabbitvcs-nautilus on Ubuntu 11.10. I have the IP address of our SVN server and have no trouble using TortiseSVN from a Windows 7 PC. How do I configure RabbitVCS to make a working directory and work with our SVN server? I can't find anything in the RabbitVCS FAQ or docs.


Solution

  • RabbitVCS is suppose to be like TortoiseSVN on Windows. That is, when you right-click on a directory, you should see a context menu and in that context menu should be Subversion commands that allow you to do checkouts, etc.

    I don't have a Linux system with Nautilus installed on it, so I can't give you the details. However, you might have to restart Nautilus (easiest way is to logout and login). Beyond that, I can't help you.

    And, there's not much information on the project's website. The Wiki contains an FAQ that answers 9 questions (and none of the answers are that detailed), and a four line instructions on how to remove RabbitVCS.

    Excuse me while I get on my soapbox here...

    <soapbox>

    To all of you people who run various open source projects: A Wiki is not documentation. You don't simply say "Hey, let's install a Wiki" and think that documentation will handle itself.

    YOU HAVE TO CREATE YOUR OWN DOCUMENTATION

    Yeah, I shouted it and put caplocks on, but I don't know how many open source projects I've seen without any documentation who think a Google group and Wiki suffice. If you create an open source project:

    • Put in what your software does and a general overview of how it works.
    • Let me know what's required. What operating systems? What other packages do I need. I want to know before I download and attempt to install it.
    • Give me a complete installation documentation. Explain step by step and include command lines. Tell me what I should do or look for if some part of the install instruction doesn't work.
    • Create a complete user's manual. Don't simply list the commands it can do. Let me know how to use it. Give me a basic workflow, so I understand how it works.
    • If there is any sort of administration task, there should be some sort of administration manual with it. And, let me know about how I can diagnose the most common issues.
    • And, most important of all: Keep the documentation up to date.
    • Have a support mailing list and MONITOR it. I've seen a lot of active groups with threads like this:

    • I had this particular problem...

    • Me too.
    • Yeah, I had it too.
    • Does anyone know how to fix it?
    • No, but if you find an answer, post it here...

    That's better than some which are more like this:

    • I had this particular problem...
    • Hello?
    • Anyone here?

    A beautiful example on how to do things right in this regard is the Subversion project. They have a beautiful on line manual (which is available in book form) that goes through how to install Subversion, the basic workflows, how to use it, how to administer it, and some basic dos and don'ts. The manual is continuously updated.

    If you have a question, someone on the mailing list can usually answer it. If not, a developer will pipe in and answer the question.

    One of the reasons why Subversion became so popular so quickly was their support documentation and community. If you want your open source project to succeed, the documentation must be good.

    Yeah, I know you don't like to write. You're a developer and not a tech writer. However, the documentation is just as important to your project as the actual code. In fact, good user documentation improves code because it gives developers a framework on how things work.

    </soapbox>