[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Tip of the day: Cheatsheet for common cmdline client operations

From: Pavel Lyalyakin <pavel.lyalyakin_at_visualsvn.com>
Date: Tue, 29 Aug 2017 15:15:07 +0300

Hello,

On Fri, Aug 25, 2017 at 2:03 PM, Johan Corveleyn <jcorvel_at_gmail.com> wrote:
>
> [ cc -= svnbook-dev, as I guess this will not become book-material.
> More below ... ]
>
> On Thu, Jul 13, 2017 at 6:34 PM, C. Michael Pilato
> <cmpilato_at_red-bean.com> wrote:
> > On Thu, Jul 13, 2017 at 11:21 AM, Daniel Shahaf <d.s_at_daniel.shahaf.name>
> > wrote:
> >>
> >> [moving from users@ ]
> >>
> >> Daniel Shahaf wrote on Fri, 30 Jun 2017 09:15 +0000:
> >> > I just ran into the following cheatsheet:
> >> >
> >> > http://www.chim.unifi.it/~signo/did/etc/subversion/neat.html
> >> >
> >> > It covers the normal multi-user workflow, branching, etc..
> >> >
> >> > (Kudos to the author, Giorgio Signorini, not to me.)
> >>
> >> As some of you know, the author gave us permission to incorporate that
> >> cheatsheet into the official documentation. Any volunteers to start the
> >> process?
> >>
> >> Cheers,
> >>
> >> Daniel
> >>
> > With respect to the author and the work he's done, I'm not really interested
> > in us maintaining yet another collection of the same information already
> > covered -- in some cases multiple times, when you factor in the reference
> > sections -- by the book. At best this cheatsheet would be an appendix. I'm
> > happy to link to the cheatsheet from from the book website, though.
> >
> > -- Mike
>
> FWIW, I think this cheatsheet is quite good and valuable (though I
> agree there is a lot of overlap with existing documentation),
> especially for newcomers. Just to have a good summary / reminder of
> common things you'll encounter.
>
> We have our own quickstart page: http://subversion.apache.org/quick-start
>
> How about:
>
> - Putting a link at the bottom of that page (there is already a link
> to the quickstart section of the book), linking to the original
> webpage of the author.
>
> or
>
> - Incorporating (some of) the content of that cheatsheet directly on
> http://subversion.apache.org/quick-start, so it's right there in front
> of you ...
>
>
> The latter option would be my personal preference (putting my user /
> admin hat on) -- I like having short info right in front of me in the
> right place -- but obviously imposes some amount of doc-maintenance
> work on "us".
>
> Maybe someone on this list would be willing to take this doc-task
> (migrating the current content, and keep an eye on keeping it up to
> date)?
>
> --
> Johan

IMO, this doc-task has to be reworded into composing a walkthrough for SVN end
user who wants to start performing basic version control tasks over remote
repository, but did not read SVNBook or other SVN-related documentation. What do
you think?

I feel that the cheatsheet[1] needs to be reworked or at least restructured. In
the current state I feel that it is just personal notes that describe various
common SVN tasks, actions and tricks. Cheatsheet or personal notes is not
a "quick start" guide.

Anyway, I like the idea of adding some of the content from the cheatsheet to
the quick start page[2] and I would be glad to take this task.

The question is: what kind of topics should the quick start page cover?

My idea is that the page should provide task-based guidance for SVN end user on
how to
* checkout a working copy,
* update the working copy,
* modify the data in the working copy and commit it,
* make a branch or tag,
* perform a simple merge.

BTW, don't miss SVN-related docs on StackOverflow Documentation[3]. I'm pretty
sure that some of the topics from that doc will be useful.

[1]: http://www.chim.unifi.it/~signo/did/etc/subversion/neat.html
[2]: http://subversion.apache.org/quick-start
[3]: https://stackoverflow.com/documentation/svn/topics

--
With best regards,
Pavel Lyalyakin
VisualSVN Team
Received on 2017-08-29 14:15:55 CEST

This is an archived mail posted to the Subversion Dev mailing list.