Re: `man 1 git`: Invalid link to online documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]