Skip to content

Update GitHub instructions in 10_manage_python_project.ipynb#360

Open
yakutovicha wants to merge 2 commits intomainfrom
fix/306-connection-to-git-in-manage-python-project-advanced
Open

Update GitHub instructions in 10_manage_python_project.ipynb#360
yakutovicha wants to merge 2 commits intomainfrom
fix/306-connection-to-git-in-manage-python-project-advanced

Conversation

@yakutovicha
Copy link
Copy Markdown
Member

fixes #306

In this PR, we ask users to establish a passwordless connection to GitHub based on an SSH key pair.

In this PR we ask users to establish passwordless connection to
GitHub based on SSH key pair.
"1. [Create an access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-personal-access-token-classic) for your account that will be used instead of your password.\n",
" You should enable `workflow`, `write:packages`, `delete:packages`.\n",
" Make sure to store the token in some secure location.\n",
" The URL can be found by clicking on the `<Code>` dropdown and selecting the __SSH__ tab.\n",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add just a simple sentence explaining what an SSH key is and why it is useful. Perhaps provide a link for more info

"<details>\n",
"<summary>How to set up SSH keys (click to expand)</summary>\n",
"\n",
"1. Open the Terminal and generate an SSH key pair:\n",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can say that this can be done from the Jupyter terminal as well

" ```\n",
" Hit `Enter` three times to accept the default values.\n",
"\n",
"2. In the File Browser, enter the `.ssh` folder and open the file named `id_rsa.pub`. Copy its content.\n",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

People might not be sure how to find this folder, some additional guidance would be useful.
For example, if one uses the terminal within JupyterLab:

  • when the terminal opens you are in C:\Users\username\path\to\python-tutorial on Windows
  • navigate to C:\Users\username\
  • ls will show that the .ssh folder exists there
  • cd .ssh
  • cat id_rsa.pub
  • copy

OR
Add a screenshot from the Windows file explorer?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Errors found in manage_python_project notebook

2 participants