Update references to "Git reference" #16968

phil-blain · 2022-04-09T19:42:39Z

Why:

Update the "Using Git" section of the page "Git and GitHub learning resources" to bring it up to date.

What's being changed:

1/4: git-and-github-learning-resources: mark "Git reference" as GitHub's
2/4: git-and-github-learning-resources: fix URL for Git reference
3/4: git-and-github-learning-resources: remove "Try Git" reference
4/4: .gitattributes: mark '*.md' as Markdown files

Notes from the commit messages...

git-and-github-learning-resources: mark "Git reference" as GitHub's

The "Git reference" is created and maintained by GitHub, not by the Git
community, so use "our" to refer to it.
git-and-github-learning-resources: fix URL for Git reference

The URL 'gitref.org' for the "Git Reference" does not work since August
2017 [1]. Fix the URL to point to the right place, and use an HTTPS URL.

[1] gitref.org now redirects to services.github.com; should this repos desc be updated? git/git-reference#112
git-and-github-learning-resources: remove "Try Git" reference

The interactive "Try Git" tutorial that used to be available at
'try.github.com' [1] is not available since 2018 [2]. Stop mentioning
it.

[1] https://github.blog/2012-07-04-try-git-in-your-browser/
[2] Try Git tutorial is gone git/git-scm.com#1239
.gitattributes: mark '*.md' as Markdown files

Denote Markdown files as such with the 'diff' Git attribute [1]. This
allows various Git commands (diff [2, 3], grep [4, 5], log [6], blame
[7]) to show in which part of the "code" the changes are located in the
hunk header.

The history of the "Using Git" section modified in the previous commit
specific entry can now be interrogated using

git log -L:"Using Git":content/get-started/quickstart/git-and-github-learning-resources.md

[1] https://git-scm.com/docs/gitattributes#_defining_a_custom_hunk_header
[2] https://git-scm.com/docs/git-diff#_generating_patch_text_with_p
[3] https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--W
[4] https://git-scm.com/docs/git-grep#Documentation/git-grep.txt--p
[5] https://git-scm.com/docs/git-grep#Documentation/git-grep.txt--W
[6] https://git-scm.com/docs/git-log#Documentation/git-log.txt--Lltfuncnamegtltfilegt
[7] https://git-scm.com/docs/git-blame#Documentation/git-blame.txt--Lltfuncnamegt
Update content/get-started/quickstart/git-and-github-learning-resources.md

Check off the following:

I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

This pull request impacts the contribution experience
- I have added the 'writer impact' label
- I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

The "Git reference" is created and maintained by GitHub, not by the Git community, so use "our" to refer to it.

The URL 'gitref.org' for the "Git Reference" does not work since August 2017 [1]. Fix the URL to point to the right place, and use an HTTPS URL. [1] git/git-reference#112

The interactive "Try Git" tutorial that used to be available at 'try.github.com' [1] is not available since 2018 [2]. Stop mentioning it. [1] https://github.blog/2012-07-04-try-git-in-your-browser/ [2] git/git-scm.com#1239

github-actions · 2022-04-09T19:43:49Z

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source	Preview	Production	What Changed
content/get-started/quickstart/git-and-github-learning-resources.md	Modified	Original

Denote Markdown files as such with the 'diff' Git attribute [1]. This allows various Git commands (diff [2, 3], grep [4, 5], log [6], blame [7]) to show in which part of the "code" the changes are located in the hunk header. The history of the "Using Git" section modified in the previous commit specific entry can now be interrogated using git log -L:"Using Git":content/get-started/quickstart/git-and-github-learning-resources.md [1] https://git-scm.com/docs/gitattributes#_defining_a_custom_hunk_header [2] https://git-scm.com/docs/git-diff#_generating_patch_text_with_p [3] https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--W [4] https://git-scm.com/docs/git-grep#Documentation/git-grep.txt--p [5] https://git-scm.com/docs/git-grep#Documentation/git-grep.txt--W [6] https://git-scm.com/docs/git-log#Documentation/git-log.txt--Lltfuncnamegtltfilegt [7] https://git-scm.com/docs/git-blame#Documentation/git-blame.txt--Lltfuncnamegt

ramyaparimi · 2022-04-11T14:17:24Z

@phil-blain
Thanks so much for opening a PR! I'll get this triaged for review ⚡

felicitymay

@phil-blain - thank you for taking the time to track down the missing site and open this PR to fix the references. Your help is much appreciated 💖

It looks as if one of the other references is no longer maintained, so I'm going to remove that link too. When we've resolved the question of the .gitattributes file, this pull request will be ready to merge.

.gitattributes

felicitymay · 2022-04-22T19:15:34Z

content/get-started/quickstart/git-and-github-learning-resources.md

@@ -18,7 +18,7 @@ shortTitle: Learning resources
 ---
 ## Using Git

-Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can review the [Git command list](https://git-scm.com/docs) or [Git command lookup reference](http://gitref.org) while using the [Try Git](https://try.github.com) simulator.
+Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs) or our [Git command lookup reference](https://git.github.io/git-reference/).


Thank you for removing the outdated link a git simulator and for tracking down the Git command reference that's backed by https://github.com/git/git-reference. 💖

It looks as if the Git command reference is no longer actively maintained, so I suggest we remove this reference too.

Suggested change

Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs) or our [Git command lookup reference](https://git.github.io/git-reference/).

Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs).

Well, I agree it does not look actively maintained, but it did help me at first when I was learning Git. So it's you call :)

It's good to know you found this resource useful, even though it's not actively maintained. I guess the core functionality of Git doesn't change much.

…es.md

rsese

👍 on that .gitattributes update

.gitattributes

felicitymay

@phil-blain - thanks for your patience with our review process ✨
@rsese - thank you for confirming that the change to .gitattributes is safe 🙇🏻‍♀️

This looks ready to merge. Thanks for your help.

github-actions · 2022-04-27T10:38:50Z

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

phil-blain added 3 commits April 9, 2022 15:40

git-and-github-learning-resources: mark "Git reference" as GitHub's

6f67649

The "Git reference" is created and maintained by GitHub, not by the Git community, so use "our" to refer to it.

git-and-github-learning-resources: fix URL for Git reference

2aad708

The URL 'gitref.org' for the "Git Reference" does not work since August 2017 [1]. Fix the URL to point to the right place, and use an HTTPS URL. [1] git/git-reference#112

git-and-github-learning-resources: remove "Try Git" reference

8b2e278

The interactive "Try Git" tutorial that used to be available at 'try.github.com' [1] is not available since 2018 [2]. Stop mentioning it. [1] https://github.blog/2012-07-04-try-git-in-your-browser/ [2] git/git-scm.com#1239

github-actions bot added the triage Do not begin working on this issue until triaged by the team label Apr 9, 2022

felicitymay added the engineering Will involve Docs Engineering label Apr 22, 2022

felicitymay reviewed Apr 22, 2022

View reviewed changes

Update content/get-started/quickstart/git-and-github-learning-resourc…

851e5d1

…es.md

felicitymay requested a review from a team April 25, 2022 07:46

rsese approved these changes Apr 26, 2022

View reviewed changes

.gitattributes Show resolved Hide resolved

Leshka163rus referenced this pull request Apr 26, 2022

add working in repo file

5efa016

felicitymay approved these changes Apr 27, 2022

View reviewed changes

felicitymay added 2 commits April 27, 2022 11:13

Merge branch 'main' into git-reference

ec6a07b

Merge branch 'main' into git-reference

576c118

felicitymay enabled auto-merge (squash) April 27, 2022 10:34

felicitymay added the ready to merge This pull request is ready to merge label Apr 27, 2022

felicitymay merged commit cc5b24d into github:main Apr 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update references to "Git reference" #16968

Update references to "Git reference" #16968

phil-blain commented Apr 9, 2022 •

edited by felicitymay

Loading

github-actions bot commented Apr 9, 2022 •

edited

Loading

ramyaparimi commented Apr 11, 2022

felicitymay left a comment •

edited

Loading

felicitymay Apr 22, 2022

phil-blain Apr 22, 2022

felicitymay Apr 25, 2022

rsese left a comment

felicitymay left a comment

github-actions bot commented Apr 27, 2022

	Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs) or our [Git command lookup reference](https://git.github.io/git-reference/).
	Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs).

Update references to "Git reference" #16968

Update references to "Git reference" #16968

Conversation

phil-blain commented Apr 9, 2022 • edited by felicitymay Loading

Why:

What's being changed:

Check off the following:

Writer impact (This section is for GitHub staff members only):

github-actions bot commented Apr 9, 2022 • edited Loading

Automatically generated comment ℹ️

Content directory changes

ramyaparimi commented Apr 11, 2022

felicitymay left a comment • edited Loading

Choose a reason for hiding this comment

felicitymay Apr 22, 2022

Choose a reason for hiding this comment

phil-blain Apr 22, 2022

Choose a reason for hiding this comment

felicitymay Apr 25, 2022

Choose a reason for hiding this comment

rsese left a comment

Choose a reason for hiding this comment

felicitymay left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 27, 2022

phil-blain commented Apr 9, 2022 •

edited by felicitymay

Loading

github-actions bot commented Apr 9, 2022 •

edited

Loading

felicitymay left a comment •

edited

Loading