Trac #34648: Developer's guide: warn the transition to GitHub and add…

… links to the transition guide

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

URL: https://trac.sagemath.org/34648
Reported by: mkoeppe
Ticket author(s): Matthias Koeppe, Kwankyu Lee
Reviewer(s): Kwankyu Lee, Matthias Koeppe

src/doc/en/developer/advanced_git.rst

@@ -6,6 +6,17 @@
 Advanced Git
 ============
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 This chapter covers some advanced uses of git that go beyond what is
 required to work with branches. These features can be used in Sage
 development, but are not really necessary to contribute to Sage. If

src/doc/en/developer/git_trac.rst

@@ -6,6 +6,17 @@
 Optional: Using the Git-Trac Command
 ====================================
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 Git is a separate project from trac, and the two do not know how to
 talk to each other. To simplify the development, we have a special
 ``git trac`` subcommand for the git suite. Note that this really is
@@ -40,7 +51,7 @@ do this by symlinking::
     [user@localhost git-trac-command]$ ln -s `pwd`/git-trac ~/bin/
 
 See the `git-trac README <https://github.com/sagemath/git-trac-command>`_ for
-more details. At this point you leave ``git-trac-command`` subdirectory, and only go 
+more details. At this point you leave ``git-trac-command`` subdirectory, and only go
 there whenever you need to update the ``git-trac`` command.
 
 

src/doc/en/developer/index.rst

@@ -4,6 +4,17 @@
 Welcome to the Sage Developer's Guide!
 ======================================
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 Everybody who uses Sage is encouraged to contribute something back to Sage at
 some point. You could:
 
@@ -44,7 +55,7 @@ development!
   As an easy way to get started, you can run and edit Sage's code and contribute
   your changes using `Gitpod <https://www.gitpod.io>`_,
   a free online development environment based on VS Code.
-  It will launch a pre-made workspace with all dependencies and tools installed 
+  It will launch a pre-made workspace with all dependencies and tools installed
   so that you can start contributing straight away.
   Start by `going to Gitpod <https://gitpod.io/#https://github.com/sagemath/sage>`_,
   and read :ref:`our Gitpod guidelines <section-gitpod>` to learn more.

src/doc/en/developer/manual_git.rst

@@ -6,6 +6,17 @@
 Using Git with the Sage Trac Server
 ===================================
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 Now we continue our introduction to git from :ref:`chapter-walkthrough`.
 We discuss how to push your local changes to a remote repository
 so that your changes can be reviewed for inclusion in Sage.
@@ -154,6 +165,13 @@ repository, use these commands::
     [user@localhost sage]$ git remote add trac https://github.com/sagemath/sagetrac-mirror.git -t master
     [user@localhost sage]$ git remote set-url --push trac git@trac.sagemath.org:sage.git
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** After the
+    move, the Sage trac server git@trac.sagemath.org:sage.git will no longer be
+    available, but all branches will be available (in read-only mode) on
+    https://github.com/sagemath/sagetrac-mirror.git.
+
 Instead of ``trac`` you can use any other name you want, of course.
 To verify that it is set up correctly::
 
@@ -201,13 +219,17 @@ following commands instead::
     trac        git@trac.sagemath.org:sage.git (fetch)
     trac        git@trac.sagemath.org:sage.git (push)
 
+* The Patch buildbot will automatically test your ticket. See :trac:`wiki/patchbot`
+  for more information about its features and limitations. Make sure that you
+  look at the log, especially if the patch buildbot did not give you
+  the green blob.
+
 
 .. _section-git-checkout:
 
 Checking Out Tickets
 --------------------
 
-
 Trac tickets that are finished or in the process of being worked on
 can have a git branch attached to them. This is the "Branch:" field in
 the ticket description. The branch name is generally of the form
@@ -280,6 +302,7 @@ branch.
 The ``Branch`` field on the trac ticket can appear in red/green. See
 :ref:`section-trac-fields` to learn what it means.
 
+
 .. _section-git-pull:
 
 Getting Changes

src/doc/en/developer/reviewer_checklist.rst

@@ -6,6 +6,17 @@
 The reviewer's check list
 =========================
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 All code that goes into Sage is peer-reviewed. Two reasons for this are:
 
 - Because a developer cannot think of everything at once;

src/doc/en/developer/trac.rst

@@ -6,6 +6,17 @@
 The Sage Trac Server
 ====================
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 Sometimes you will only want to work on local changes to Sage, for
 your own private needs.  However, typically it is beneficial to
 share code and ideas with others; the manner in which the
@@ -33,6 +44,13 @@ trac server. Items on the server are called *tickets*, and anyone may
 search or browse the tickets. For a list of recent changes, just visit
 the :trac:`Sage trac timeline <timeline>`.
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.**
+    All functions of our Trac server will be taken over by our main repository,
+    https://github.com/sagemath/sage.
+
+
 .. _section-trac-account:
 
 Obtaining an Account
@@ -288,11 +306,6 @@ After pushing a branch to a ticket, the ticket will show badges
 linking to results of automated tests that run on the patchbot and
 other tests that run on GitHub Actions.
 
-* The Patch buildbot will automatically test your ticket. See :trac:`wiki/patchbot`
-  for more information about its features and limitations. Make sure that you
-  look at the log, especially if the patch buildbot did not give you
-  the green blob.
-
 * A `linting workflow
   <https://github.com/sagemath/sage/blob/develop/.github/workflows/lint.yml>`_
   runs on all pushes to a branch on Trac. It checks that the code of
@@ -334,6 +347,17 @@ other tests that run on GitHub Actions.
   <https://github.com/sagemath/sagetrac-mirror/actions/workflows/doc-build.yml>`_
   and choose the particular branch to see what went wrong.
 
+* The patch buildbot will automatically test your ticket. See :trac:`wiki/patchbot`
+  for more information about its features and limitations. Make sure that you
+  look at the log, especially if the patch buildbot did not give you
+  the green blob.
+
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.**
+    After the move, the patch buildbot will no longer be available; the three
+    workflows above are considered a full replacement. If you miss any features
+    of the patch buildbot, please report this in :trac:`33457`.
 
 The following are some other relevant issues:
 

src/doc/en/developer/walk_through.rst

@@ -6,6 +6,17 @@
 Sage Development Process
 ========================
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 This section is a concise overview of the Sage development process. In
 it, we will see how to make changes to the Sage source code and record
 them in the ``git`` revision control system.
@@ -111,6 +122,11 @@ For the experts, note that the repository at
 `git.sagemath.org <http://git.sagemath.org>`_ is where development
 actually takes place.
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.**
+    After the move, https://github.com/sagemath/sage.git will be the
+    primary repository.
 
 .. _section-walkthrough-branch:
 

src/doc/en/developer/workflows.rst

@@ -6,6 +6,17 @@
 Distributed Development
 =======================
 
+.. WARNING::
+
+    **Sage development is scheduled to move to GitHub in February 2023.** The exact
+    date will be announced in `<https://groups.google.com/g/sage-devel>`_. After
+    the transition, some parts of this guide (especially those related with `the
+    Sage Trac server <https://trac.sagemath.org>`_) will become obsolete and be
+    updated according to the new workflow on GitHub. See our `transition guide from Trac to
+    GitHub
+    <https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md>`_
+    for the preliminary version of the workflow.
+
 Git is a tool to exchange commits (organized into branches) with other
 developers. As a distributed revision control system, it does not have
 the notion of a central server. The Sage trac server is just one of