From: Jeff King <peff@peff.net>
To: 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: Mon, 6 Jun 2016 19:19:36 -0400 [thread overview]
Message-ID: <20160606231936.GB22756@sigill.intra.peff.net> (raw)
In-Reply-To: <ed8f000f-b8a2-ca92-e0f2-e26ff9928bbe@gentoo.org>
On Sun, Jun 05, 2016 at 08:59:00PM -0700, Daniel Campbell wrote:
> In `man 1 git`, the Description section outlines an address to
> pre-generated documentation [0]. That link returns a 404 error. Playing
> around, I found the repository at [1] and found that it hasn't been
> updated since August 2015. Given that 2.8.3 is more recent than that, it
> seems like this is something that should be updated (if the
> pre-generated docs still exist somewhere) or removed altogether.
>
> Also worth considering is Google Code was shut down earlier this year.
> While archives exist, it can't be relied upon for future use. The
> closest approximation I could find that was up to date is [2], though
> [3] is a repository that's even fresher than 2.8.3.
Yeah, I think Google Code is out. The git-scm.com page automatically
pulls in released versions of the pages, but not the tip of master
(which is what the git-htmldocs repository has).
That repository is hosted at kernel.org and at GitHub, so either of:
https://git.kernel.org/cgit/git/git-htmldocs.git/plain/git.html
https://raw.githubusercontent.com/gitster/git-htmldocs/master/git.html
but in both cases the content-type is such that it doesn't render in a
browser (and at least in the GitHub case, that is intentional; we don't
want people using their repos directly as a CDN. They should build a
Pages site and push to it).
So I think the options are basically:
1. Point to git-scm.com/docs as "new enough" as it covers released
versions (and lets you walk back to earlier versions, too). People
who want bleeding edge can clone htmldocs themselves.
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).
3. Publish to some other Pages-like service. I don't think kernel.org
has one, but it's not like there's a lack of sites you can push
static HTML files to. I mentioned GitHub in (2) mostly because
Junio already pushes there.
-Peff
next prev parent reply other threads:[~2016-06-06 23:19 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 [this message]
2016-06-06 23:25 ` Jeff King
2016-06-08 12:43 ` Michael J Gruber
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=20160606231936.GB22756@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--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).