From: Jeff King <peff@peff.net>
Date: Fri, 29 May 2020 03:24:54 GMT
Subject: Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool
Message-ID: <20200529032454.GB1271617@coredump.intra.peff.net>
In-Reply-To: <20200529002757.GD114915@google.com>

On Thu, May 28, 2020 at 05:27:57PM -0700, Jonathan Nieder wrote:

> > --- a/app/views/shared/ref/_debugging.html.erb
> > +++ b/app/views/shared/ref/_debugging.html.erb
> > @@ -2,5 +2,6 @@
> >  <ul class='unstyled'>
> >    <li><%= man('git-bisect') %></li>
> >    <li><%= man('git-blame') %></li>
> > +  <li><%= man('git-bugreport') %></li>
> >    <li><%= man('git-grep') %></li>
> >  </ul>
> 
> Where does this show up on the rendered page?  Is it
> https://git-scm.com/book/en/v2/Appendix-C:-Git-Commands-Debugging?

No, it's in the command-list in:

  https://git-scm.com/docs

in the section "debugging".

> Is there a way to preview how it renders?

Yes. :) You can clone the repo and build using the instructions in the
README (including importing at least one version's worth of manpages to
render). It's a minor-ish pain to do so if you're not used to working
with Ruby or Rails.

We also spin up a staging deploy for any PRs opened against that repo,
though I _think_ it won't do so for PRs opened from another fork (since
it can read the production database; we don't care for our project,
which contains no secrets, but many projects would).

-Peff