... | ... | @@ -16,9 +16,27 @@ When you save your changes version, GitHub automatically creates a fork (if it d |
|
|
|
|
|
(For creating new pages, you can use the GitHub interface as well.)
|
|
|
|
|
|
### Release process checklist
|
|
|
### Release process checklist -- GitHub version
|
|
|
|
|
|
0. This is part of the [[Release process checklist]].
|
|
|
(Almost all of this can be done via the GitHub UI.)
|
|
|
|
|
|
0. This is part of the [[Release process checklist]]. The first few items could be done before the beta launch. We're working within the main docs repo.
|
|
|
1. Make a pull request to merge `master` back into the branch `current`, the branch corresponding to the version that will be replaced by the new release. This compensates for any updates made to master (since we usually won't fix `current`)
|
|
|
1. Create a branch from `master` named `vN.m-latest`. (Enter `vN.m-latest` in the "switch branches" menu and choose "create brach")
|
|
|
1. Log into ReadTheDocs and add the `vN.m-latest` branch to the build list.
|
|
|
1. Update `vN.m-latest` with all necessary documentation changes for the new release; in particular
|
|
|
* update the version number in the Sphinx configuration file `config.py`.
|
|
|
* Create a "What's new"-page for the new release.
|
|
|
* Document all new features.
|
|
|
* Note: The `master` branch will always be the one to keep up-to-date, being visible at docs.mathjax.org/en/latest.
|
|
|
1. When everything is finished, make a pull request to merge `vN.m-latest` back into `master`.
|
|
|
1. Check if docs.mathjax.org has successfully built `vN.m-latest` and `master` at docs.mathjax.org
|
|
|
|
|
|
|
|
|
|
|
|
### Release process checklist -- git version
|
|
|
|
|
|
0. This is part of the [[Release process checklist]]. The first few items could be done before the beta launch.
|
|
|
1. Clone the repository `git clone https://github.com/mathjax/mathjax-docs.git`
|
|
|
1. Merge `master` into the branch `current` corresponding to the **current** version, i.e., the version that will be replaced by the new release.
|
|
|
1. Push `current` to github: `git commit -a -m "(log message about the 'current' branch)" &&
|
... | ... | @@ -30,7 +48,7 @@ When you save your changes version, GitHub automatically creates a fork (if it d |
|
|
* Create a "What's new"-page for the new release.
|
|
|
* Document all new features.
|
|
|
* Note: The `master` branch will always be the one to keep up-to-date, being visible at docs.mathjax.org/en/latest.
|
|
|
1. When everythingis finished, make a pull request to merge `vN.m-latest` back into `master`.
|
|
|
1. When the new documentation is finished, merge `vN.m-latest` back into `master` and make a pull request to the main repo.
|
|
|
1. Check if docs.mathjax.org has successfully built `vN.m-latest` and `master` at docs.mathjax.org
|
|
|
|
|
|
### Appendix: Understanding the process
|
... | ... | |