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
updated: release checklist to include directions for the rtfd-account authored Oct 08, 2012 by pkra's avatar pkra
Hide whitespace changes
Inline Side-by-side
Documentation-update-process.md
View page @ 08a8853f
......@@ -20,17 +20,18 @@ When you save your changes version, GitHub automatically creates a fork (if it d
0. This is part of the [[Release process checklist]].
1. Clone the repository `git clone https://github.com/mathjax/mathjax-docs.git`
1. Create a branch corresponding to the **current** version, i.e., the version that will be replaced by the new release.
1. In that "current" branch, modify
* the edit-on-github link `_templates/sourcelink.html` to point to the "current" branch.
1. Create a branch `current` corresponding to the **current** version, i.e., the version that will be replaced by the new release.
1. In the `current` branch, modify
* the edit-on-github link `_templates/sourcelink.html` to point to the `current` branch.
* the theme layout `_themes/sphinx-bootstrap/layout.html`: add the version-warning to the quick-links:
* After `<li><strong>Quick links</strong></li>` insert `<li> <a class="btn btn-mini btn-success" href="http://docs.mathjax.org/">Newer version available!</a> </li>`
1. Commit & push pack to github: `git commit -a -m "(log message about the 'current' branch)" &&
git push origin (current branch)`
1. Checkout the `master` branch,
git push origin "current"`
1. Then checkout the `master` branch,
* update the version number in the Sphinx configuration file `config.py`.
1. Commit & push pack to github: `git commit -a -m "(log message about version change)" &&
git push origin master`
1. Visit the user page on ReadTheDocs and check that `current` branch is included in the build list.
### Appendix: Understanding the process
......
Clone repository

MathJax Wiki

  • Contributing
  • Development
    • Development Process
      • Release Process Checklist
      • Hotfix Release Process
      • Documentation Update Process
      • Source Control Policies
    • Design Documents
      • MathJax Roadmap
      • CDN Hosting
        • Managing Rackspace Cloud Files & CDN
        • Directory Structure
        • .htaccess settings
        • Managing Amazon Cloudfront
      • Performance Discussion
      • Profiling and Diagnostics Tools
      • Configuration Options
      • Documentation generation guide
      • Testing
        • Platforms supported
        • Amazon EC2
        • DSI test machine
  • MathJax web presence