Developer's guide: warn the transition to GitHub and add links to the transition guide

[mkoeppe]

Adding warnings and

• links to the transition guide https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md

As of this ticket (for Sage 9.8, assuming it can be released in January 2023), we keep the Trac instructions.

In a follow-up ticket (for Sage 9.9), we will remove the trac instructions, update the developer manual according to the transition guide, and add links to github command-line interface, e.g., https://cli.github.com/manual/gh_repo_fork

Part of Meta-ticket #30363: Migration from Trac to GitHub

CC: @kwankyu @soehms @tobiasdiez

Component: documentation

Author: Matthias Koeppe, Kwankyu Lee

Branch/Commit: cecbcac

Reviewer: Kwankyu Lee, Matthias Koeppe

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

[kwankyu]

comment:3

I don't have the capability to lead the work for this ticket, but can help from a side as time (not much in January) permits.

It seems there are two things to do here. To build the workflow first and write it down for developers. But it seems to me that the workflow is not clear yet. It is not clear to me. I need to educate myself first to even start helping writing it down.

So instead of thinking in the air, we may need a sample project to experiment and experience how to do what we have been doing in trac, now in github. Thus I suggest to work on this ticket not here, but in the github repository https://github.com/sagemath/trac-to-github, regarding it as the "trac" in github. So we start using the issue template or PR template, and build the workflow there while working on updating the developer guide.

Let's start by opening an issue in the repository for this ticket.

[mkoeppe]

comment:5

What I hope we can add here (in time for the Sage 9.8 release) is not necessarily (or likely) the final form of the workflow. I just want to make sure that the developer's guide in the upcoming release already acknowledges the transition to github.

[kwankyu]

comment:6

Replying to Matthias Köppe:

What I hope we can add here (in time for the Sage 9.8 release) is not necessarily (or likely) the final form of the workflow.

Okay. Then the draft in https://github.com/sagemath/sage/wiki/migration-from-trac-to-Git**b would suffice?

I just want to make sure that the developer's guide in the upcoming release already acknowledges the transition to github.

Then would it be just an announcement pointing to the draft of the workflow?

But I think by the time of the scheduled transition to github in February, more solid form of the workflow should be in place. So the upddated developer guide should be provided (or at least ready) at the same time. Perhaps this is for another ticket

Anyway I think we need a playground to consolidate the workflow before the transition, though the final form would (and could) be settled after the transition.

[kwankyu]

comment:7

By the way, I find this article interesting:

https://jtway.co/convert-github-issue-to-pull-request-c624834835d8

which solves the main difference between github vs trac workflows.

[mkoeppe]

comment:8

Issues have a button on the right side "Create a branch for this issue or link pull request" -- is this the same?

[kwankyu]

comment:9

Replying to Matthias Köppe:

Issues have a button on the right side "Create a branch for this issue or link pull request" -- is this the same?

I don't see the button, perhaps because of permission. Anyway I guess it creates a new PR. The point is, I think, that a issue is converted to a PR so that they have the same number.

[mkoeppe]

comment:10

I have just moved the transition guide from the sage github wiki to https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md (because the description how things such as milestones are mapped from Trac to Github should be updated at the same time as we make changes to the migration script).

[mkoeppe]

Branch: u/mkoeppe/developer_s_guide__update_for_workflows_after_transition_to_github

[mkoeppe]

Author: Matthias Koeppe, ...

[mkoeppe]

Commit: 6b0a020

[mkoeppe]

New commits:

6b0a020

src/doc/en/developer/index.rst: Point to [GitHub](../wiki/GitHub) transition guide

[sagetrac-git]

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

d583223

src/doc/en/developer: In various files, point to [GitHub](../wiki/GitHub) transition guide

[sagetrac-git]

Changed commit from 6b0a020 to d583223

[mkoeppe]

Changed author from Matthias Koeppe, ... to Matthias Koeppe

[kwankyu]

Changed branch from u/mkoeppe/developer_s_guide__update_for_workflows_after_transition_to_github to u/klee/developer_s_guide__update_for_workflows_after_transition_to_github

[kwankyu]

Changed author from Matthias Koeppe to Matthias Koeppe, Kwankyu Lee

[kwankyu]

Reviewer: Kwankyu Lee, Matthias Koeppe

[kwankyu]

Changed commit from d583223 to 5bd2d25

[kwankyu]

comment:16

• Edited the warning header. I replaced early with February.
• Removed the warning from some places, and instead put the warning header at the top of the file.
• Put the warning header to more files.

Otherwise LGTM. Feel free to revert or edit further.

---

New commits:

abd204d	Replace early to February
5bd2d25	Add warning header to more places

[mkoeppe]

comment:17

Looking great, thanks very much!

[sagetrac-git]

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

cecbcac

Add WARNING directive

[sagetrac-git]

Changed commit from 5bd2d25 to cecbcac

[mkoeppe]

comment:21

Documentation builds and is looking great.

[kwankyu]

comment:22

Yes. Thank you.

[vbraun]

Changed branch from u/klee/developer_s_guide__update_for_workflows_after_transition_to_github to cecbcac