From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: Michael J Gruber <git@drmicha.warpmail.net>,
Git Mailing List <git@vger.kernel.org>
Subject: Re: RFD: leveraging GitHub's asciidoc rendering for our Documentation/
Date: Fri, 9 Sep 2011 15:05:47 -0400 [thread overview]
Message-ID: <20110909190547.GF28480@sigill.intra.peff.net> (raw)
In-Reply-To: <7v4o0lvcq3.fsf@alter.siamese.dyndns.org>
On Fri, Sep 09, 2011 at 10:37:24AM -0700, Junio C Hamano wrote:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
>
> > Our own customisation is not loaded (of course) so that, e.g., the
> > linkgit macro does not work; and the include statement makes GitHub's
> > parser unhappy and choke.
> >
> > Does anybody feel this is worth pursuing?
> >
> > + Nicer blob view
> > + Simpler way to judge documentation changes
> > - Need to get our asciidoc config in there
> > - GitHub's parser neeeds to learn include
>
> Personally I am not very interested. Couldn't you just visit the html
> branch instead for viewing?
I agree that it's not very nice for release-quality documentation. But
if I understand correctly, Michael means that you can go straight to any
blob at any commit of any fork on github, and get the rendered (or raw)
version. Which is neat.
How frequently do you build the html branch? I always assumed it was
once in a while (every push?), not for every commit.
We could help that along by giving our documentation a more descriptive
filename. But it would be cool if GitHub respected gitattributes for
this, too.
-Peff
next prev parent reply other threads:[~2011-09-09 19:05 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-09-09 14:34 RFD: leveraging GitHub's asciidoc rendering for our Documentation/ Michael J Gruber
2011-09-09 15:45 ` Scott Chacon
2011-09-09 15:58 ` Michael Haggerty
2011-09-09 16:05 ` Michael J Gruber
2011-09-10 3:02 ` Giuseppe Bilotta
[not found] ` <CAMK1S_hOY-riZnHAZhC32UAA0BYF1YyXUPujj_jFUEjcYC_4ZA@mail.gmail.com>
2011-09-09 15:55 ` Fwd: " Sitaram Chamarty
2011-09-09 17:37 ` Junio C Hamano
2011-09-09 19:05 ` Michael J Gruber
2011-09-09 19:05 ` Jeff King [this message]
2011-09-09 20:50 ` Junio C Hamano
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=20110909190547.GF28480@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@drmicha.warpmail.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).