Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create git guides for beginners #5033

Closed
3 tasks
digitarald opened this issue Dec 16, 2021 · 5 comments
Closed
3 tasks

Create git guides for beginners #5033

digitarald opened this issue Dec 16, 2021 · 5 comments
Assignees
Labels
doc-enhancement suggested addition or improvement
Milestone

Comments

@digitarald
Copy link
Contributor

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:

  1. Track and commit changed files
  2. Resolving merge conflict
  3. Checkout a remote branch
  4. Create a github pull requests
  5. 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.

image

image

image

cc @burkeholland @ItalyPaleAle @sana-ajani

@digitarald digitarald added the doc-enhancement suggested addition or improvement label Dec 16, 2021
@digitarald digitarald added this to the January 2022 milestone Dec 16, 2021
@digitarald digitarald self-assigned this Dec 16, 2021
@ItalyPaleAle
Copy link
Contributor

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
Copy link
Contributor Author

@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
Copy link

hi @digitarald, I would like to help out with this, please can you help me get started?

@AriESQ
Copy link

AriESQ commented 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
Copy link

Closing issue as not on any current milestone plan. We can reopen the issue when the work is resourced and scheduled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement suggested addition or improvement
Projects
None yet
Development

No branches or pull requests

5 participants