Skip to content

Commit 3059132

Browse files
committed
Also mention GCM
1 parent 94597b5 commit 3059132

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

src/doc/en/developer/git_basic.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ GitHub. Hence we assume that throughout this guide.
1616

1717
.. _section-git-ssh:
1818

19-
Git authentication through SSH instead of HTTPS
20-
===============================================
19+
Git authentication through SSH
20+
==============================
2121

2222
In order to push changes securely to a remote repository, Git uses public-key
2323
cryptography. This section will show you how to set up the necessary
2424
cryptographic keys for the case that you want to use SSH(Secure Shell) protocol
25-
to authenticate your Git to GitHub.
25+
to authenticate your Git to GitHub, instead of HTTPS protocol.
2626

2727

2828
.. _section-github-ssh-key:

src/doc/en/developer/github.rst

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ the following, we assume your username "alice". So you always read your own
2424
username if you see "alice".
2525

2626

27-
.. _chapter-github-cli:
27+
.. _section-github-cli:
2828

2929
Using the GitHub CLI
3030
====================
@@ -78,21 +78,26 @@ Linking Git to your GitHub account
7878
==================================
7979

8080
In order for your Git to work with GitHub, your GitHub account needs to be
81-
linked with your Git. No action is needed if you have already contributed to
81+
linked with your Git. No action is needed if you have already contributed to
8282
any other project on GitHub and set up Git credentials or SSH keys for this.
8383

84-
The above dialogue from ``gh auth login`` already linked your Git to GitHub by
85-
HTTPS protocol using your GitHub credentials. We assume this in the rest of
86-
this guide. For more details, see `Caching your GitHub credentials in Git
84+
The above dialogue from ``gh auth login`` linked your Git to GitHub by HTTPS
85+
protocol using your GitHub credentials. Alternatively you may like to use
86+
popular `Git Credential Manager
87+
<https://github.com/git-ecosystem/git-credential-manager>`_ which stores your
88+
credentials natively to your platform. For more information, see `Caching your
89+
GitHub credentials in Git
8790
<https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git>`_.
8891

89-
If you prefer SSH protocol for authenticating Git to GitHub, then you follow
90-
:ref:`section-git-ssh` to generate an SSH keypair and add the SSH public key to your
91-
GitHub account. A simple way to upload the public key is to choose SSH protocol
92-
for Git operations in the dialogue from ``gh auth login`` command above. For
93-
more details, see `Connecting to GitHub with SSH
92+
If you prefer SSH to HTTPS for authenticating Git to GitHub, then you follow
93+
:ref:`section-git-ssh` to generate an SSH keypair and add the SSH public key to
94+
your GitHub account. A simple way to upload the public key is to choose SSH
95+
protocol for Git operations in the dialogue from ``gh auth login`` command
96+
above. For more details, see `Connecting to GitHub with SSH
9497
<https://docs.github.com/en/authentication/connecting-to-github-with-ssh>`_.
9598

99+
We assume HTTPS protocol in the rest of this guide.
100+
96101

97102
Forking the Sage repository
98103
===========================

0 commit comments

Comments
 (0)