git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: Emily Shaffer <emilyshaffer@google.com>,
	git@vger.kernel.org,
	Philippe Blain <levraiphilippeblain@gmail.com>
Subject: Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool
Date: Thu, 28 May 2020 23:24:54 -0400	[thread overview]
Message-ID: <20200529032454.GB1271617@coredump.intra.peff.net> (raw)
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

  reply	other threads:[~2020-05-29  3:24 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-28 23:16 [git-scm.com PATCH] community: advertise 'git-bugreport' tool Emily Shaffer
2020-05-28 23:33 ` Junio C Hamano
2020-05-28 23:53   ` Emily Shaffer
2020-05-29  0:27 ` Jonathan Nieder
2020-05-29  3:24   ` Jeff King [this message]
2020-05-29  1:49 ` Philippe Blain
2020-05-29  3:33   ` Jeff King
2020-05-29  3:37 ` Jeff King

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200529032454.GB1271617@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    --cc=levraiphilippeblain@gmail.com \
    /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.
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 NNTP newsgroup(s).