git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: <git@vger.kernel.org>
Cc: Emily Shaffer <emilyshaffer@google.com>,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: [PATCH 0/1] FAQ for common user questions
Date: Sun, 15 Mar 2020 22:39:22 +0000	[thread overview]
Message-ID: <20200315223923.170371-1-sandals@crustytoothpaste.net> (raw)

Git is an enormously flexible and power piece of software, but many
people find it confusing and hard to use.  Over the time I've been
contributing, I've noticed a lot of the same questions keep coming up
over and over.  Some of these questions are well answered by existing
documentation, but people have trouble finding it.  Others are not
answered, and still others are questions about integrating with common
tools and hosting platforms.

To help people find and discover this documentation, let's provide a FAQ
that covers common issues.  A lot of these issues are things I've seen
asked on Stack Overflow or elsewhere and we'd be doing everyone a
service if we included some stock answers in one place in our
documentation.

The FAQ is designed to be conversational, approachable, and geared
towards a competent novice user.  However, it also addresses questions
that I've seen from technically advanced colleagues.  I've tried to make
it address common questions about integrations with other tools, such as
CI systems and hosting platforms, without mentioning any specific tool
by name.  This keeps us neutral on particular tools, but recognizes that
these tools are a common part of people's development experiences.

I definitely think we'll add more questions as we go along, but this
seems like a reasonable start for now.  I'd love feedback about the
phrasing of questions or answers, anything I've missed, and anything
that might be technically inaccurate, especially about Windows.

brian m. carlson (1):
  docs: add a FAQ

 Documentation/Makefile   |   1 +
 Documentation/gitfaq.txt | 330 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 331 insertions(+)
 create mode 100644 Documentation/gitfaq.txt


             reply	other threads:[~2020-03-15 22:45 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-15 22:39 brian m. carlson [this message]
2020-03-15 22:39 ` [PATCH 1/1] docs: add a FAQ brian m. carlson
2020-03-15 23:34   ` Junio C Hamano
2020-03-16  0:13     ` brian m. carlson
2020-03-18 23:00   ` Emily Shaffer
2020-03-19  0:09     ` Junio C Hamano
2020-03-19 23:49     ` brian m. carlson
2020-03-19 17:02   ` Shourya Shukla
2020-03-19 23:31     ` brian m. carlson

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=20200315223923.170371-1-sandals@crustytoothpaste.net \
    --to=sandals@crustytoothpaste.net \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.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).