git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: Julian Phillips <julian@quantumfyre.co.uk>,
	Scott Chacon <schacon@gmail.com>, Petr Baudis <pasky@suse.cz>,
	git list <git@vger.kernel.org>
Subject: Re: markdown 2 man, was Re: Git Community Book
Date: Wed, 30 Jul 2008 12:32:02 -0700	[thread overview]
Message-ID: <7vy73j418t.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: <alpine.LSU.1.00.0807301514280.3486@wbgn129.biozentrum.uni-wuerzburg.de> (Johannes Schindelin's message of "Wed, 30 Jul 2008 15:27:38 +0200 (CEST)")

Johannes Schindelin <Johannes.Schindelin@gmx.de> writes:

> Note also that Markdown cannot create TOCs automatically, AFAICT.  So 
> probably it would be not all that easy to convert the User Manual to that 
> format.

The use of markdown may mean updates to the User Manual won't be merged
back to his book without effort and manual porting on his side, and the
side porting in the other direction has the same issue as well, but the
contents and the way materials are presented will be vastly different in
future versions anyway; not being able to side-port new material verbatim
may not be an issue.  Discussion with Scott seems to suggest that the
overall philosophy of his book is "this is a different book targetted for
different audiences; its initial text happens to heavily borrow from the
existing documents but expected to become vastly improved", in other
words, fork-and-never-return.

That's one valid approach.  I or you might have taken a different avenue,
but after all, it's his book, not mine, not yours, nor git list's book.

As I am not in "graphics and screencast" camp, I may probably not be able
to offer much help improving his book, and I suspect some people on this
list might feel the same way.  But that's is Ok --- we are not dumping the
User Manual.

We originally hoped (well, at least I did) that Scott's effort on his book
might help us in improving the User Manual as well, but the approach seems
to make it unlikely.  But that is nothing to hold against him --- he is
doing his own thing in a way he feels is the best, and that's perfectly
fine.  We lost nothing, perhaps except for a chance to cooperate a bit
better and to widen the community.

> If at all, I would have preferred a format switch to Wiki syntax so that 
> we can use the same source on the Git wiki as in our Documentation/ 
> directory.

Yeah, that's also true.  I seem to recall markdown was used in ikiwiki?

  reply	other threads:[~2008-07-30 19:33 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-07-29 16:20 Git Community Book Scott Chacon
2008-07-29 16:28 ` Miklos Vajna
2008-07-29 17:09 ` Petr Baudis
2008-07-29 18:30   ` Scott Chacon
2008-07-29 18:42     ` Junio C Hamano
2008-07-29 19:00       ` Julian Phillips
2008-07-29 19:09         ` Junio C Hamano
2008-07-30 13:27         ` markdown 2 man, was " Johannes Schindelin
2008-07-30 19:32           ` Junio C Hamano [this message]
2008-07-30 23:48             ` Wincent Colaiuta
2008-07-31  0:13               ` Scott Chacon
2008-07-31  0:30               ` Junio C Hamano
2008-07-31 11:24             ` Abdelrazak Younes
2008-07-31 13:01               ` Stephan Beyer
2008-07-31 14:13                 ` Abdelrazak Younes
2008-07-31 14:33                 ` Abdelrazak Younes
2008-07-31 15:09                   ` Miklos Vajna
2008-07-31 15:29                     ` Abdelrazak Younes
2008-07-31 19:00                       ` Miklos Vajna
2008-08-01  0:45                   ` Junio C Hamano
2008-08-01  7:11                     ` Abdelrazak Younes
2008-08-01  9:46                       ` Thomas Rast
2008-08-01 10:19                         ` Abdelrazak Younes
2008-07-31 20:57               ` Jan Krüger
2008-08-01  7:50                 ` Abdelrazak Younes
2008-08-01 10:45                   ` Dmitry Potapov
2008-08-01 11:06                     ` Abdelrazak Younes
2008-07-29 19:34       ` Scott Chacon
2008-07-29 19:57         ` Junio C Hamano
2008-07-30 21:39     ` J. Bruce Fields
2008-07-29 17:43 ` Junio C Hamano
2008-07-29 18:25   ` Junio C Hamano
2008-07-29 19:29     ` Scott Chacon
2008-07-29 19:24   ` Scott Chacon
2008-07-29 22:34 ` Daniel Barkalow
2008-07-29 22:47   ` Junio C Hamano
2008-07-30 13:20     ` Bart Trojanowski
2008-07-30 18:27       ` Junio C Hamano
2008-07-30 13:31     ` Bart Trojanowski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7vy73j418t.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=julian@quantumfyre.co.uk \
    --cc=pasky@suse.cz \
    --cc=schacon@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).