Update developer guide for workflows on github #35460
Conversation
kwankyu
changed the title
| 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>`_ |
There was a problem hiding this comment.
I'm not sure if we should remove the link to the transition guide just yet. Developers familiar with the Trac workflow but new to GitHub still could benefit from it.
There was a problem hiding this comment.
This PR would take long to be complete. The next sage release would go with the old developer manual. Perhaps we need another PR to update the banner for the release.
There was a problem hiding this comment.
I created #35482 for this purpose.
<!-- Please provide a concise, informative and self-explanatory title. --> <!-- Don't put issue numbers in the title. Put it in the Description below. --> <!-- For example, instead of "Fixes #12345", use "Add a new method to multiply two integers" --> ### 📚 Description Updating the developer manual with the new workflow on github would take some time. #35460 Meanwhile, we update the github transition notices in the developer manual as the transition is over now. <!-- Describe your changes here in detail. --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes #12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x ]`. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - #12345: short description why this is a dependency - #34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: #35482 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
|
Yes, that may be a good addition. I expect a sequel PR for that from you.
That may a section of the index page that guides what to read and what to skip. |
|
Thanks! Sorry for the late commits, where I removed some links to non-existing references and made some minor edits. |
|
|
Thanks. Fixed. |
|
Documentation preview for this PR is ready! 🎉 |
📚 Description
Our developer guide needs to be updated incorporating the new workflows on GitHub. Here is the updated developer guide.
I know this needs more editing, but at least it reached the point where other eyes would catch more errors, typos, and defects than mine alone.
So please examine the built documentation and report errors, typos, and defects. If you think a major addition such as a new section is needed, then please open a new PR that builds on this PR and provide your own writing.
📝 Checklist
⌛ Dependencies