svn quick-start idea

'Quick-starts' is an idea for setting up a info-style help system that
offers users 'quick-starts' on the command line. Something like that is
often used on MUDS too, for players and wizards.

Quick-starts are short 'cooking recipes' that help users get from A to
B in the shortest way, but may also contain hints and links to the svn
book or other web resources.

Here is how it all would (probably) look:

$ svn --quick-start help

=> --qs topics list the available topics
=> --qs help help how to use quick-start
=> --qs help local list local svn help entries
=> ...

$ svn --qs topics

=> Repository, Propset, Diff, Log, Merge, ..., Tricks, .....
=>
=> To view the list of quick-starts pertaining to a topic, type
=> $svn --qs <topic>.
=> The quick-starts are listed by number, to view it type
=> $svn --qs <topic> <number>
=> To view all the available quick-starts pertaining to 'foo' that
=> also contain '-bar' type $ svn --qs --grep "foo" "bar"

$ svn --qs Repository

   1. make a local repository with local branches for one user
   2. make a public repository
   3. upgrade a repository
   ...

$ svn --quick-start Repository 1

=> Make a local repository with local branches for one user
=> --------------------------------------------------------
=>
=> $ mkdir myRepository; svnadmin create myRepository; ls -al nwRepo/
=>
=> ... more instruction steps ...
=>
=> Also see the Subversion book, page n
$ ...

======================================================================

Disadvantages:

* it's OS dependent.

* It adds documentation chores.

* it's a group project for devs and users.

Advantages:

* it's within svn, where you need it, if you do. If you have to switch
   away to the web or pick up the book, there goes part of your
   concentration.

* it helps devs to quickly understand how parts of svn are used which
   they are not familiar with.

* it's searchable. If you want to see in what constructs and
   combinations command 'foo' is used, you can get a comprehensive
   list, so it also functions as an 'svn command dictionary'.

* it allows implementation of an elective daily tip feature (I find
   them quite fun)

* it can be built over time, the starter kit is done if we have
   quick-starts for the most basic tasks.

* devs can populate it as they go along, and users can contribute.
   For fun add a small token gift for a lottery user contribs can win
   -- mugs, tshirts or other small souveniers.

* Users could add their own site-specific section(s) for their local
   installation.

* it would act as the canonical source for quick-starts. The web has
   a ton of svn cooking recipes, not all of which work(anymore), and as
   was pointed out, copying text from a webpage can be unhealthy for
   your computer and privacy.

have a great weekend,

Gabriela
Received on 2013-07-12 21:51:49 CEST