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

Developer's guide: Expand on GitHub accounts and SSH keys #33700

Closed
mkoeppe opened this issue Apr 13, 2022 · 17 comments
Closed

Developer's guide: Expand on GitHub accounts and SSH keys #33700

mkoeppe opened this issue Apr 13, 2022 · 17 comments

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Apr 13, 2022

(split out from #33687)

We move the section on creating SSH keys from the section on Trac to a later section, as creating tickets and participating in discussions on tickets does not require SSH keys.

This is also preparation for #33687 (gitlab workflow).

Depends on #33648

CC: @slel @dimpase @tobiasdiez @sagetrac-tmonteil @yuan-zhou

Component: documentation

Author: Matthias Koeppe

Branch/Commit: 4c03af3

Reviewer: Yuan Zhou

Issue created by migration from https://trac.sagemath.org/ticket/33700

@mkoeppe mkoeppe added this to the sage-9.6 milestone Apr 13, 2022
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 13, 2022

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 13, 2022

Last 10 new commits:

3f6c6e0src/doc/en/developer/workspace.rst: Link to Trac #30500
8716d80src/doc/en/installation/source.rst: Update required venv Python extension modules from build/pkgs/python3/spkg-configure.m4
f4c3604Merge #33088
88b04d4src/doc/en/developer/manual_git.rst: Do not recommend mixed sagetrac-mirror / trac operation when using VS Code
fc7aa4fsrc/doc/en/developer/advanced_git.rst: Mention git log --first-parent
aa9faaasrc/doc/en/developer: move "git the hard way" earlier, present "git-trac" only as an additional convenience
6ae0e52Merge #33648
106603esrc/doc/en/developer/trac.rst: Expand [GitHub](../wiki/GitHub) account instructions, remove legacy account instructions (duplicated from trac main page)
e500597src/doc/en/developer/trac.rst: Clarify Authors field, purpose of tickets
77d1e53src/doc/en/developer/manual_git.rst: Move section on SSH keys here from trac.rst, add links to [GitLab](../wiki/GitLab) instructions

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 13, 2022

Commit: 77d1e53

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 16, 2022

comment:3

Let's get this in please.

Only the last 3 commits need review, the earlier ones are all from #33648.

@yuan-zhou
Copy link

comment:4

It looks good to me, but maybe it is worth keeping a note regarding the non-github login that uses the legacy account, after deleting the following.

-**New:** Previously, it was necessary to manually request a Trac account in
-order to post anything to Sage's Trac.  Now, if you have a GitHub account, you
-may log in using it to create and comment on tickets, and edit wiki pages on
-Sage's Trac.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 16, 2022

comment:5

I deleted it because this information is also on the front page of Trac (https://trac.sagemath.org/#legacy-account-request).

I've just edited https://wiki.sagemath.org/#About_this_wiki to also be clearer about this.

The big problem with mentioning the legacy account requests is that no one actually tends to them. (I requested one in January for a special purpose and have not received a reply.)

@yuan-zhou
Copy link

comment:6

I didn't make it clear. Actually I was wondering if you could add a note in the guide, saying that the first login button on the trac page is only for legacy account users; and that if the user had such an account, then the login instead of github-login is the right one to use.

(If I haven't used trac for a while and I got a new laptop that does not have my Username/Password cached, then I will be confused about the trac page's login/github-login, and I won't find the instruction in the new developer's guide.)

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 16, 2022

Changed commit from 77d1e53 to 4c03af3

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 16, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

4c03af3src/doc/en/developer/trac.rst: Login info for users with legacy sage-trac accounts

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 16, 2022

comment:8

OK, done. I've also edited the top of https://trac.sagemath.org/ to make this clearer.

@yuan-zhou
Copy link

Reviewer: Yuan Zhou

@yuan-zhou
Copy link

comment:9

Great! Thank you for editing the top of trac page. I find it very helpful.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 16, 2022

comment:10

Thanks for the review!

@vbraun
Copy link
Member

vbraun commented Apr 21, 2022

comment:12

docbuild fails

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 22, 2022

comment:13

Can't reproduce an error here on top of vbraun/develop, 7950f93

@mkoeppe mkoeppe modified the milestones: sage-9.6, sage-9.7 May 15, 2022
@vbraun
Copy link
Member

vbraun commented May 16, 2022

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

No branches or pull requests

3 participants