From: Michael J Gruber <git@drmicha.warpmail.net>
To: Jeff King <peff@peff.net>, Daniel Campbell <zlg@gentoo.org>
Cc: Junio C Hamano <gitster@pobox.com>, git@vger.kernel.org
Subject: Re: `man 1 git`: Invalid link to online documentation
Date: Wed, 8 Jun 2016 14:43:57 +0200 [thread overview]
Message-ID: <eeb75a91-17d6-bb49-e4d6-34bf4fb3defe@drmicha.warpmail.net> (raw)
In-Reply-To: <20160606232536.GA23537@sigill.intra.peff.net>
Jeff King venit, vidit, dixit 07.06.2016 01:25:
> On Mon, Jun 06, 2016 at 07:19:36PM -0400, Jeff King wrote:
>
>> 2. Make git-htmldocs a real site on GitHub. I think this should be as
>> simple as pushing to the `gh-pages` branch of the repository, which
>> would make it available as https://gitster.github.io/git-htmldocs.
>> You can do a bunch of Jekyll magic, but you don't have to; it should
>> serve arbitrary html files (though I think we'd maybe want to add
>> an "index.html"; we may also want to host it under a git/htmldocs
>> project just to make the repo more official looking).
>
> Just to make sure I wasn't spewing nonsense, I tried pushing the tip of
> gitster/git-htmldocs to the "gh-pages" branch of git/htmldocs, and
> indeed:
>
> https://git.github.io/htmldocs/git.html
>
> now works. If we like that solution, Junio, you should already have
> access to just push there (instead of gitster/git-htmldocs, or in
> addition to if you prefer).
>
> If not, I'll delete the repository (I don't plan on doing further
> pushes, so leaving it will just confuse people).
>
> I see that we _do_ have an index.html symlink in the built tree, but it
> does not seem to actually work via GitHub Pages.
>
> -Peff
>
I like that a lot. It makes good use of the existing infrastructure at
github, and the rendering uses screen real estate much better than the
version on git-scm.com.
If Junio integrates it into his usual workflow then we don't have the
update issues that we have over there. Rendered documentation in-sync
with the code, hooray :)
Michael
prev parent reply other threads:[~2016-06-08 12:44 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-06 3:59 `man 1 git`: Invalid link to online documentation Daniel Campbell
2016-06-06 23:19 ` Jeff King
2016-06-06 23:25 ` Jeff King
2016-06-08 12:43 ` Michael J Gruber [this message]
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=eeb75a91-17d6-bb49-e4d6-34bf4fb3defe@drmicha.warpmail.net \
--to=git@drmicha.warpmail.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=zlg@gentoo.org \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).