git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Jun 8, 2016, 12:43 UTC
Message-ID
<eeb75a91-17d6-bb49-e4d6-34bf4fb3defe@drmicha.warpmail.net>
In-Reply-To
<20160606232536.GA23537@sigill.intra.peff.net>
Jeff King venit, vidit, dixit 07.06.2016 01:25:
Show 28 quoted lines
> 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
Previous: Jeff King
Message 4 of 4 in “`man 1 git`: Invalid link to online documentation”
  1. Daniel CampbellJun 6, 2016
  2. Jeff KingJun 6, 2016
  3. Jeff KingJun 6, 2016
  4. Michael J GruberJun 8, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.