From 6b0a020d066abaad590a4f3bebb8db80607e4bc4 Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Sun, 1 Jan 2023 12:35:31 -0800 Subject: [PATCH 1/5] src/doc/en/developer/index.rst: Point to GitHub transition guide --- src/doc/en/developer/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/doc/en/developer/index.rst b/src/doc/en/developer/index.rst index de24e3e3b7e..d45c46919a4 100644 --- a/src/doc/en/developer/index.rst +++ b/src/doc/en/developer/index.rst @@ -24,7 +24,7 @@ Here are brief overviews of each part; for more details, see the extended table of contents below. No matter where you start, good luck and welcome to Sage development! -- **Trac server:** all changes go through `the Sage Trac server +- **Trac server (until early 2023):** all changes go through `the Sage Trac server `_ at some point. It contains bug reports, upgrade requests, changes in progress, and those already part of Sage today. :ref:`Click here ` for more information. @@ -32,6 +32,10 @@ development! Importantly, you will need to :ref:`create a trac account ` in order to contribute. + **Sage development is scheduled to move to GitHub in early 2023.** + See our `transition guide from Trac to GitHub + `. + - **Source code:** You need your own copy of Sage's source code to change it. `Go there `_ to get it and for instructions to build it. From d58322393139683dd938b3a8387ff0c843525c8a Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Wed, 4 Jan 2023 16:49:13 -0800 Subject: [PATCH 2/5] src/doc/en/developer: In various files, point to GitHub transition guide --- src/doc/en/developer/manual_git.rst | 37 +++++++++++++++++++++++++++ src/doc/en/developer/trac.rst | 31 ++++++++++++++++++---- src/doc/en/developer/walk_through.rst | 5 ++++ 3 files changed, 68 insertions(+), 5 deletions(-) diff --git a/src/doc/en/developer/manual_git.rst b/src/doc/en/developer/manual_git.rst index c08c44ec793..c058d72bae6 100644 --- a/src/doc/en/developer/manual_git.rst +++ b/src/doc/en/developer/manual_git.rst @@ -33,6 +33,10 @@ In order to push changes securely to a remote repository, git uses public-key cryptography. This section will show you how to set up the necessary cryptographic keys for Secure Shell (SSH). +**Sage development is scheduled to move to GitHub in early 2023.** +See our `transition guide from Trac to GitHub +` +for the new procedures. Checking whether you have already have suitable SSH keys -------------------------------------------------------- @@ -154,6 +158,14 @@ 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 +**Sage development is scheduled to move to GitHub in early 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; see our `transition guide from Trac +to GitHub +` +for more details. + Instead of ``trac`` you can use any other name you want, of course. To verify that it is set up correctly:: @@ -201,12 +213,21 @@ 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 -------------------- +**Sage development is scheduled to move to GitHub in early 2023.** +See our `transition guide from Trac to GitHub +` +for the new procedures. 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 @@ -250,6 +271,11 @@ local branch. Pushing Your Changes to a Ticket -------------------------------- +**Sage development is scheduled to move to GitHub in early 2023.** +See our `transition guide from Trac to GitHub +` +for the new procedures. + To add your local branch to a trac ticket, you should first decide on a name on the Sage trac repository. @@ -280,11 +306,17 @@ 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 --------------- +**Sage development is scheduled to move to GitHub in early 2023.** +See our `transition guide from Trac to GitHub +` +for the new procedures. + A common task during development is to synchronize your local copy of the branch with the branch on trac. In particular, assume you downloaded somebody else's branch and made some suggestions for @@ -329,6 +361,11 @@ section. Updating Master --------------- +**Sage development is scheduled to move to GitHub in early 2023.** +See our `transition guide from Trac to GitHub +` +for the new procedures. + The ``master`` branch can be updated just like any other branch. However, your local copy of the master branch should stay **identical** to the trac master branch. diff --git a/src/doc/en/developer/trac.rst b/src/doc/en/developer/trac.rst index 8b8872b9eef..f4699a3c622 100644 --- a/src/doc/en/developer/trac.rst +++ b/src/doc/en/developer/trac.rst @@ -33,6 +33,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 `. +**Sage development is scheduled to move to GitHub in early 2023.** +All functions of our Trac server will be taken over by our main repository, +https://github.com/sagemath/sage; see our `transition guide from Trac to GitHub +` +for more information. + + .. _section-trac-account: Obtaining an Account @@ -143,6 +150,14 @@ describing the idea. Unless you know what you are doing, leave the milestone field to its default value. +**Sage development is scheduled to move to GitHub in early 2023.** +After the move, instead of opening a Trac ticket, open an Issue or Pull Request +in our main repository, https://github.com/sagemath/sage; see our +`transition guide from Trac to GitHub +` +for more details. + + .. _section-trac-fields: The Ticket Fields @@ -288,11 +303,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 `_ runs on all pushes to a branch on Trac. It checks that the code of @@ -334,6 +344,17 @@ other tests that run on GitHub Actions. `_ 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. + + **Sage development is scheduled to move to GitHub in early 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`. + See also our `transition guide from Trac to GitHub + `. The following are some other relevant issues: diff --git a/src/doc/en/developer/walk_through.rst b/src/doc/en/developer/walk_through.rst index a4de6f5f138..795494e9595 100644 --- a/src/doc/en/developer/walk_through.rst +++ b/src/doc/en/developer/walk_through.rst @@ -111,6 +111,11 @@ For the experts, note that the repository at `git.sagemath.org `_ is where development actually takes place. +**Sage development is scheduled to move to GitHub in early 2023.** +After the move, https://github.com/sagemath/sage.git will be the +primary repository. +See our `transition guide from Trac to GitHub +`. .. _section-walkthrough-branch: From abd204db0066d0e7ad516cf5d8c9050675b350e6 Mon Sep 17 00:00:00 2001 From: Kwankyu Lee Date: Thu, 5 Jan 2023 12:16:27 +0900 Subject: [PATCH 3/5] Replace early to February --- src/doc/en/developer/index.rst | 17 +++++++---- src/doc/en/developer/manual_git.rst | 42 ++++++++------------------- src/doc/en/developer/trac.rst | 29 +++++++++--------- src/doc/en/developer/walk_through.rst | 13 +++++++-- 4 files changed, 46 insertions(+), 55 deletions(-) diff --git a/src/doc/en/developer/index.rst b/src/doc/en/developer/index.rst index d45c46919a4..fecfdf99cce 100644 --- a/src/doc/en/developer/index.rst +++ b/src/doc/en/developer/index.rst @@ -20,11 +20,20 @@ reporting bugs to modifying and extending Sage and its documentation. We also discuss how to share your new and modified code with other Sage users around the globe. +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +for the preliminary version of the workflow. + Here are brief overviews of each part; for more details, see the extended table of contents below. No matter where you start, good luck and welcome to Sage development! -- **Trac server (until early 2023):** all changes go through `the Sage Trac server +- **Trac server:** all changes go through `the Sage Trac server `_ at some point. It contains bug reports, upgrade requests, changes in progress, and those already part of Sage today. :ref:`Click here ` for more information. @@ -32,10 +41,6 @@ development! Importantly, you will need to :ref:`create a trac account ` in order to contribute. - **Sage development is scheduled to move to GitHub in early 2023.** - See our `transition guide from Trac to GitHub - `. - - **Source code:** You need your own copy of Sage's source code to change it. `Go there `_ to get it and for instructions to build it. @@ -48,7 +53,7 @@ development! As an easy way to get started, you can run and edit Sage's code and contribute your changes using `Gitpod `_, 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 `_, and read :ref:`our Gitpod guidelines ` to learn more. diff --git a/src/doc/en/developer/manual_git.rst b/src/doc/en/developer/manual_git.rst index c058d72bae6..1b592abaaac 100644 --- a/src/doc/en/developer/manual_git.rst +++ b/src/doc/en/developer/manual_git.rst @@ -6,6 +6,15 @@ Using Git with the Sage Trac Server =================================== +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +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. @@ -33,10 +42,6 @@ In order to push changes securely to a remote repository, git uses public-key cryptography. This section will show you how to set up the necessary cryptographic keys for Secure Shell (SSH). -**Sage development is scheduled to move to GitHub in early 2023.** -See our `transition guide from Trac to GitHub -` -for the new procedures. Checking whether you have already have suitable SSH keys -------------------------------------------------------- @@ -158,13 +163,10 @@ 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 -**Sage development is scheduled to move to GitHub in early 2023.** -After the move, the Sage trac server git@trac.sagemath.org:sage.git will no longer be +**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; see our `transition guide from Trac -to GitHub -` -for more details. +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:: @@ -224,11 +226,6 @@ following commands instead:: Checking Out Tickets -------------------- -**Sage development is scheduled to move to GitHub in early 2023.** -See our `transition guide from Trac to GitHub -` -for the new procedures. - 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 @@ -271,11 +268,6 @@ local branch. Pushing Your Changes to a Ticket -------------------------------- -**Sage development is scheduled to move to GitHub in early 2023.** -See our `transition guide from Trac to GitHub -` -for the new procedures. - To add your local branch to a trac ticket, you should first decide on a name on the Sage trac repository. @@ -312,11 +304,6 @@ The ``Branch`` field on the trac ticket can appear in red/green. See Getting Changes --------------- -**Sage development is scheduled to move to GitHub in early 2023.** -See our `transition guide from Trac to GitHub -` -for the new procedures. - A common task during development is to synchronize your local copy of the branch with the branch on trac. In particular, assume you downloaded somebody else's branch and made some suggestions for @@ -361,11 +348,6 @@ section. Updating Master --------------- -**Sage development is scheduled to move to GitHub in early 2023.** -See our `transition guide from Trac to GitHub -` -for the new procedures. - The ``master`` branch can be updated just like any other branch. However, your local copy of the master branch should stay **identical** to the trac master branch. diff --git a/src/doc/en/developer/trac.rst b/src/doc/en/developer/trac.rst index f4699a3c622..dd905bb189f 100644 --- a/src/doc/en/developer/trac.rst +++ b/src/doc/en/developer/trac.rst @@ -6,6 +6,15 @@ The Sage Trac Server ==================== +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +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,11 +42,9 @@ 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 `. -**Sage development is scheduled to move to GitHub in early 2023.** +**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; see our `transition guide from Trac to GitHub -` -for more information. +https://github.com/sagemath/sage. .. _section-trac-account: @@ -150,14 +157,6 @@ describing the idea. Unless you know what you are doing, leave the milestone field to its default value. -**Sage development is scheduled to move to GitHub in early 2023.** -After the move, instead of opening a Trac ticket, open an Issue or Pull Request -in our main repository, https://github.com/sagemath/sage; see our -`transition guide from Trac to GitHub -` -for more details. - - .. _section-trac-fields: The Ticket Fields @@ -344,17 +343,15 @@ other tests that run on GitHub Actions. `_ and choose the particular branch to see what went wrong. -* The Patch buildbot will automatically test your ticket. See :trac:`wiki/patchbot` +* 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. - **Sage development is scheduled to move to GitHub in early 2023.** + **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`. - See also our `transition guide from Trac to GitHub - `. The following are some other relevant issues: diff --git a/src/doc/en/developer/walk_through.rst b/src/doc/en/developer/walk_through.rst index 795494e9595..d852e843851 100644 --- a/src/doc/en/developer/walk_through.rst +++ b/src/doc/en/developer/walk_through.rst @@ -6,6 +6,15 @@ Sage Development Process ======================== +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +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,11 +120,9 @@ For the experts, note that the repository at `git.sagemath.org `_ is where development actually takes place. -**Sage development is scheduled to move to GitHub in early 2023.** +**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. -See our `transition guide from Trac to GitHub -`. .. _section-walkthrough-branch: From 5bd2d256a96c92bf7beae22e507221013b689416 Mon Sep 17 00:00:00 2001 From: Kwankyu Lee Date: Thu, 5 Jan 2023 12:32:37 +0900 Subject: [PATCH 4/5] Add warning header to more places --- src/doc/en/developer/advanced_git.rst | 9 +++++++++ src/doc/en/developer/git_trac.rst | 11 ++++++++++- src/doc/en/developer/index.rst | 18 +++++++++--------- src/doc/en/developer/reviewer_checklist.rst | 9 +++++++++ src/doc/en/developer/workflows.rst | 9 +++++++++ 5 files changed, 46 insertions(+), 10 deletions(-) diff --git a/src/doc/en/developer/advanced_git.rst b/src/doc/en/developer/advanced_git.rst index cb5422cfb3a..a86504220fc 100644 --- a/src/doc/en/developer/advanced_git.rst +++ b/src/doc/en/developer/advanced_git.rst @@ -6,6 +6,15 @@ Advanced Git ============ +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +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 diff --git a/src/doc/en/developer/git_trac.rst b/src/doc/en/developer/git_trac.rst index 25977e5ef23..f23ffd52cd3 100644 --- a/src/doc/en/developer/git_trac.rst +++ b/src/doc/en/developer/git_trac.rst @@ -6,6 +6,15 @@ Optional: Using the Git-Trac Command ==================================== +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +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 +49,7 @@ do this by symlinking:: [user@localhost git-trac-command]$ ln -s `pwd`/git-trac ~/bin/ See the `git-trac README `_ 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. diff --git a/src/doc/en/developer/index.rst b/src/doc/en/developer/index.rst index fecfdf99cce..18e2414d304 100644 --- a/src/doc/en/developer/index.rst +++ b/src/doc/en/developer/index.rst @@ -4,6 +4,15 @@ Welcome to the Sage Developer's Guide! ====================================== +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +for the preliminary version of the workflow. + Everybody who uses Sage is encouraged to contribute something back to Sage at some point. You could: @@ -20,15 +29,6 @@ reporting bugs to modifying and extending Sage and its documentation. We also discuss how to share your new and modified code with other Sage users around the globe. -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. - Here are brief overviews of each part; for more details, see the extended table of contents below. No matter where you start, good luck and welcome to Sage development! diff --git a/src/doc/en/developer/reviewer_checklist.rst b/src/doc/en/developer/reviewer_checklist.rst index 271290e3dc8..6b3badd5bbf 100644 --- a/src/doc/en/developer/reviewer_checklist.rst +++ b/src/doc/en/developer/reviewer_checklist.rst @@ -6,6 +6,15 @@ The reviewer's check list ========================= +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +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; diff --git a/src/doc/en/developer/workflows.rst b/src/doc/en/developer/workflows.rst index 1b89ecee1c0..6553b61f3f3 100644 --- a/src/doc/en/developer/workflows.rst +++ b/src/doc/en/developer/workflows.rst @@ -6,6 +6,15 @@ Distributed Development ======================= +**Sage development is scheduled to move to GitHub in February 2023.** The exact +date will be announced in ``_. After +the transition, some parts of this guide (especially those related with `the +Sage Trac server `_) will become obsolete and be +updated according to the new workflow on GitHub. See our `transition guide from Trac to +GitHub +`_ +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 From cecbcace201a4d52c72da44450860de773255fe1 Mon Sep 17 00:00:00 2001 From: Kwankyu Lee Date: Thu, 5 Jan 2023 15:10:11 +0900 Subject: [PATCH 5/5] Add WARNING directive --- src/doc/en/developer/advanced_git.rst | 18 ++++++----- src/doc/en/developer/git_trac.rst | 18 ++++++----- src/doc/en/developer/index.rst | 18 ++++++----- src/doc/en/developer/manual_git.rst | 28 +++++++++------- src/doc/en/developer/reviewer_checklist.rst | 18 ++++++----- src/doc/en/developer/trac.rst | 36 ++++++++++++--------- src/doc/en/developer/walk_through.rst | 26 ++++++++------- src/doc/en/developer/workflows.rst | 18 ++++++----- 8 files changed, 102 insertions(+), 78 deletions(-) diff --git a/src/doc/en/developer/advanced_git.rst b/src/doc/en/developer/advanced_git.rst index a86504220fc..eb128986452 100644 --- a/src/doc/en/developer/advanced_git.rst +++ b/src/doc/en/developer/advanced_git.rst @@ -6,14 +6,16 @@ Advanced Git ============ -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + 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 diff --git a/src/doc/en/developer/git_trac.rst b/src/doc/en/developer/git_trac.rst index f23ffd52cd3..462291488b9 100644 --- a/src/doc/en/developer/git_trac.rst +++ b/src/doc/en/developer/git_trac.rst @@ -6,14 +6,16 @@ Optional: Using the Git-Trac Command ==================================== -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + 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 diff --git a/src/doc/en/developer/index.rst b/src/doc/en/developer/index.rst index 18e2414d304..d851df7b0e7 100644 --- a/src/doc/en/developer/index.rst +++ b/src/doc/en/developer/index.rst @@ -4,14 +4,16 @@ Welcome to the Sage Developer's Guide! ====================================== -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + for the preliminary version of the workflow. Everybody who uses Sage is encouraged to contribute something back to Sage at some point. You could: diff --git a/src/doc/en/developer/manual_git.rst b/src/doc/en/developer/manual_git.rst index 1b592abaaac..83f595abab7 100644 --- a/src/doc/en/developer/manual_git.rst +++ b/src/doc/en/developer/manual_git.rst @@ -6,14 +6,16 @@ Using Git with the Sage Trac Server =================================== -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + 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 @@ -163,10 +165,12 @@ 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 -**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. +.. 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:: diff --git a/src/doc/en/developer/reviewer_checklist.rst b/src/doc/en/developer/reviewer_checklist.rst index 6b3badd5bbf..3ddc6b94f96 100644 --- a/src/doc/en/developer/reviewer_checklist.rst +++ b/src/doc/en/developer/reviewer_checklist.rst @@ -6,14 +6,16 @@ The reviewer's check list ========================= -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + for the preliminary version of the workflow. All code that goes into Sage is peer-reviewed. Two reasons for this are: diff --git a/src/doc/en/developer/trac.rst b/src/doc/en/developer/trac.rst index dd905bb189f..a584a61284f 100644 --- a/src/doc/en/developer/trac.rst +++ b/src/doc/en/developer/trac.rst @@ -6,14 +6,16 @@ The Sage Trac Server ==================== -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + 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 @@ -42,9 +44,11 @@ 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 `. -**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. +.. 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: @@ -348,10 +352,12 @@ other tests that run on GitHub Actions. look at the log, especially if the patch buildbot did not give you the green blob. - **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`. +.. 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: diff --git a/src/doc/en/developer/walk_through.rst b/src/doc/en/developer/walk_through.rst index d852e843851..74f0fd514f0 100644 --- a/src/doc/en/developer/walk_through.rst +++ b/src/doc/en/developer/walk_through.rst @@ -6,14 +6,16 @@ Sage Development Process ======================== -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + 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 @@ -120,9 +122,11 @@ For the experts, note that the repository at `git.sagemath.org `_ is where development actually takes place. -**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. +.. 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: diff --git a/src/doc/en/developer/workflows.rst b/src/doc/en/developer/workflows.rst index 6553b61f3f3..b4d00265ee2 100644 --- a/src/doc/en/developer/workflows.rst +++ b/src/doc/en/developer/workflows.rst @@ -6,14 +6,16 @@ Distributed Development ======================= -**Sage development is scheduled to move to GitHub in February 2023.** The exact -date will be announced in ``_. After -the transition, some parts of this guide (especially those related with `the -Sage Trac server `_) will become obsolete and be -updated according to the new workflow on GitHub. See our `transition guide from Trac to -GitHub -`_ -for the preliminary version of the workflow. +.. WARNING:: + + **Sage development is scheduled to move to GitHub in February 2023.** The exact + date will be announced in ``_. After + the transition, some parts of this guide (especially those related with `the + Sage Trac server `_) will become obsolete and be + updated according to the new workflow on GitHub. See our `transition guide from Trac to + GitHub + `_ + 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