Repository navigation
Create git guides for beginners #5033
Description
Why: The current version-control page is just a generic overview, slightly flavored with git. The github docs is also more a of UI and feature tour. Both assume git knowledge.
What: Beginner-focused content should walk through specific use cases that developers struggle with. By sticking to UI-based flows, those pages can lower the steep learning curve that most git guides have.
How: We'll add a new top-level /git docs category with a handful of short scenario-based articles. Anything that new developers need help with can be considered, prioritizing topics that cover most common use cases and pitfalls.
🚧 Draft ideas for topics, to be discussed:
- Track and commit changed files
- Resolving merge conflict
- Checkout a remote branch
- Create a github pull requests
- FAQ for misc details
TBD:
- Brainstorm initial topics and converge on a shortlist
- Outline for top 3
- Create articles (2 pager)
What git issues do developers struggle with most?
Search results on google are probably more driven by frustration than importance/frequency of the use case.
cc Burke Holland (@burkeholland) Alessandro (Ale) Segala (@ItalyPaleAle) Sana Ajani (@sana-ajani)
Activity
ItalyPaleAle commentedon Dec 16, 2021
Is this something we could work on with support for someone at GitHub? Like someone in Martin's team?
And do you think our docs would be a good place to also explain the why of Git, in addition to the how ?
digitarald commentedon Dec 17, 2021
Alessandro (Ale) Segala (@ItalyPaleAle) yes and yes (especially for use cases, so they make sense to their audience). Let's sync next year to pull in the right people to help write & review.
nelsonmic commentedon Mar 19, 2022
hi Harald Kirschner (@digitarald), I would like to help out with this, please can you help me get started?
AriESQ commentedon May 15, 2022
This seems out of scope for VS-Code documentation. There is actually good reason to be intentional about keeping a conceptually clear boundary between GitHub features, Git, and VS-Code /(web).
gregvanl commentedon Jun 24, 2022
Closing issue as not on any current milestone plan. We can reopen the issue when the work is resourced and scheduled.