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
DOC: Update documentation to reference SSH #26343
Conversation
I think we should remove all the "typical" github interactions from this page and leave only the "special" things that are specific to NumPy. This will also future-proof the page for any changes in github policy. |
This appears to be a small part missed in the removal of too verbose Git details at the end of last year. See #25340 Would the best course of action be to just remove the bullet point entirely? I think there is one more lingering reference located in RELEASE_WALKTHROUGH.rst. Would a simple " You will also need to authenticate with GitHub to push the documentation (search online for details)." work to replace "You will also need a GitHub personal access token (PAT) to push the documentation" and the bullet point that follows? This removes any reference to using a PAT or SSH. |
I think most all of points (1), (2) and (3) can be removed, except the part where
There may be more that can be deleted. This should all be rephrased to flow better. |
As a first time contributor to an open source project. I think parts (1), (2), and (3) are great helps. Here are some thoughts.
The above removes the GitHub items related to authentication and leaves enough for a newcomer to hopefully jump in. The comment I made above about RELEASE_WALKTHROUGH.rst should be ignored. @ogidig5 , those are my thoughts. As a different PR, or in addition to this one, here is one more thing I wish I knew when I made my first contribution.
|
…kip azp] [skip actions] [skip cirrus]
… azp] [skip actions] [skip cirrus]
This should be done in a separate branch rather than
You can then make the PR from your fork on github. |
You can see the relevant branches right under the title on this page. |
Note that I also edited the title to add the |
I'll work with @ogidig5 on Monday clean up his fork and submit a new clean PR on a branch. Thanks for the comments all. We can close this PR. |
ENH: Update documentation to reference SSH
I've updated the documentation in numpy/doc/source/dev/index.rst.
This change reflects the current authentication methods using SSH keys.
This pull request replaces outdated references to GitHub Usernames and Passwords.
This change improves the clarity and accuracy of the documentation
I'd appreciate it if @bmwoodruff and @InessaPawson could review these changes.
See #26343