git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: Shourya Shukla <shouryashukla.oo@gmail.com>
Cc: Johannes.Schindelin@gmx.de, emilyshaffer@google.com, git@vger.kernel.org
Subject: Re: [PATCH 1/1] docs: add a FAQ
Date: Thu, 19 Mar 2020 23:31:38 +0000	[thread overview]
Message-ID: <20200319233138.GE366567@camp.crustytoothpaste.net> (raw)
In-Reply-To: <20200319170204.5291-1-shouryashukla.oo@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 1612 bytes --]

On 2020-03-19 at 17:02:04, Shourya Shukla wrote:
> This seems like a really good idea! There are tons of redundant questions on StackOverflow
> regarding Git in fact. One thing I want to ask, is that will this FAQ cover questions of the type:
> 
> "How do I change the remote of my repository?"
> "What is the difference between a git merge and a git pull?"
> "Git is tracking the files mentioned in .gitignore, what to do?"
> "When do I rebase and when do I merge?"
> 
> And stuff like that. Basically questions which are more of a help to someone. Or are we focusing
> only on the FAQs to kind of guide the user in Git, aiming to answer the fundamental questions and
> not the general problems faced by a user?

I think these kinds of questions are good things to add.  I do see the
tracked-file-in-.gitignore question a lot in particular.

Part of my goal here is to address these kinds of questions in Git's
documentation itself.  If many people are asking the same question on
Stack Overflow, clearly there's confusion and we should address that by
making our documentation clearer and easier to find.

My hope is that folks will start linking to the FAQ once we have it up
on the website and it will become a good starting point for people to
find answers when they're unsure of something.

> Also, I had some FAQs in mind, can I add some into this?

I had always planned this patch as a start.  I fully expect that we'll
add more to it in the future, so I'd love to see additional
contributions.
-- 
brian m. carlson: Houston, Texas, US
OpenPGP: https://keybase.io/bk2204

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 263 bytes --]

      reply	other threads:[~2020-03-19 23:31 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-15 22:39 [PATCH 0/1] FAQ for common user questions brian m. carlson
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 [this message]

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=20200319233138.GE366567@camp.crustytoothpaste.net \
    --to=sandals@crustytoothpaste.net \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    --cc=shouryashukla.oo@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.
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).