Skip to content

Commit

Permalink
Trac #29178: Beginner Ticket: Note to remind GitHub users of their tr…
Browse files Browse the repository at this point in the history
…ac username

One can authenticate themselves on the trac server in two ways. Either
they have a trac username and password, or via GitHub.

To be authenticated via GitHub, following the steps on the
`Collaborative Development with Git-
Trac`[https://doc.sagemath.org/html/en/developer/git_trac.html] page,
one would log onto the trac server and generate a token, and then type
the following command in the terminal as given in the documentation:

`git trac config --user=<username> --token=<token>`

However, it is extremely easy to miss the fact that the username to be
entered here is NOT the GitHub username, but rather the trac username
which is `gh-<GitHub-username>` as given on the top right corner of the
trac server.

This ticket is basically to add a note in the page:
[https://doc.sagemath.org/html/en/developer/git_trac.html] reminding new
developers of their trac username.

One would have to find where in the sage directory structure the
documentation file exists, make the relevant changes and commit.

URL: https://trac.sagemath.org/29178
Reported by: gh-Tinkidinki
Ticket author(s): Vishesh Tayal
Reviewer(s): Divesh Kumar
  • Loading branch information
Release Manager committed Mar 14, 2020
2 parents 9427e80 + 749b230 commit 6d192c9
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/doc/en/developer/git_trac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,11 @@ This is required if you authenticate to Trac with your GitHub account, as
you do not have a Trac password. Logged in users can find their token
under `the token tab in preferences on the trac site <https://trac.sagemath.org/prefs/token>`_ .

.. NOTE::

The username to be entered here is NOT the GitHub username, but rather the trac username which is gh-<GitHub-username>
as given on the top right corner of the trac server.

If both a token and a username/password are configured, the token-based
authentication takes precedence.

Expand Down

0 comments on commit 6d192c9

Please sign in to comment.