Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • M MathJax
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 304
    • Issues 304
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 15
    • Merge requests 15
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • MathJax
  • MathJax
  • Wiki
  • Documentation update process

Documentation update process · Changes

Page history
minor tweaks during 2.5 releae authored Jan 09, 2015 by Peter Krautzberger's avatar Peter Krautzberger
Hide whitespace changes
Inline Side-by-side
Documentation-update-process.md
View page @ 36b905c4
...@@ -24,15 +24,14 @@ When you save your changes version, GitHub automatically creates a fork (if it d ...@@ -24,15 +24,14 @@ When you save your changes version, GitHub automatically creates a fork (if it d
1. Push `current` to github: `git commit -a -m "(log message about the 'current' branch)" && 1. Push `current` to github: `git commit -a -m "(log message about the 'current' branch)" &&
git push origin "current"` git push origin "current"`
1. Create a branch of `master` corresponding to the released version `vN.m-latest` and push it to github `git push origin vN.m-latest`. 1. Create a branch of `master` corresponding to the released version `vN.m-latest` and push it to github `git push origin vN.m-latest`.
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 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`. * update the version number in the Sphinx configuration file `config.py`.
* Create a "What's new"-page for the new release. * Create a "What's new"-page for the new release.
* Document all new features. * 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. * Note: The `master` branch will always be the one to keep up-to-date, being visible at docs.mathjax.org/en/latest.
1. Log into ReadTheDocs and add the `vN.m-latest` branch to the build list. 1. When everythingis finished, make a pull request to merge `vN.m-latest` back into `master`.
1. 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
1. Push `vN.m-latest` and `master` back to github. `git push origin master vN.m-latest`
1. Check if docs.mathjax.org has the new build for `vN.m-latest`
### Appendix: Understanding the process ### Appendix: Understanding the process
......
Clone repository

MathJax Wiki

  • Contributing
    • Contributor License Agreement etc
    • Quick guide to translating mathjax
  • Development
    • Development Process
      • Release Process Checklist
      • Documentation Update Process
      • Source Control Policies
    • Design Documents
      • MathJax Roadmap
      • CDN Hosting
        • CDN requirements
        • CDN Hosting at Google Cloud Storage
      • Performance Discussion
      • Profiling and Diagnostics Tools
      • Documentation generation guide
      • Testing
        • Platforms supported
        • Test Machines
  • MathJax web presence
  • Drafts