Calum Lind 82ecf8a416 [Docs] Reorganise and add sections from wiki
- Change the layout and contents of docs to be better organised and
  follow ideas from: https://www.divio.com/blog/documentation/
- Use markdown for non-technical documents to speed up writing.
- Added new sections and imported documents from Trac wiki.

Build fixes:

- Added a patch to fix recommonmark 0.4 and doc referencing:
    https://github.com/rtfd/recommonmark/issues/93
- Set docs build in tox to Py2.7 since there are problems with autodoc
  mocking multiple inheritance on Python 3 resulting in metaclass errors.
- Supressed warning about `modules.rst` not in the toctree by creating
  a static `modules.rst` with `:orphan:` file directive and add to git.
  Also skip creating this toc file with sphinx-apidoc in setup and tox.
- Simplified finding exported RPC and JSON API methods by adding an
  autodoc custom class directive. Removed unneeded __rpcapi.py.
2018-11-01 17:38:10 +00:00

1.3 KiB

Release Checklist

Pre-Release

  • Update translation po files from Launchpad account.
  • Changelog is updated with relevant commits and release date is added.
  • Version number increment:
    • setup.py
    • man pages
    • osx/Info.plist
    • Version and month sed commands:
      • git grep -l '2\.0\.0' | grep -v CHANGELOG.md | xargs sed -i 's/2\.0\.0/2\.0\.1/g'
      • git grep -l 'October' docs/man | xargs sed -i 's/October/November/g'
  • Increment copyright year:
    • osx/Info.plist
  • Tag release in git and push upstream.
    • e.g. git tag -a deluge-2.0.0 -m "Deluge 2.0.0 Release"

Release

  • Run make_release script on extracted tarball e.g.
    • make_release deluge-2.0.0
  • Package for OSs, Ubuntu, Windows, OSX.
  • Upload source tarballs and packages to ftp. (Ensure file permissions are global readable: 0644)

Post-Release

  • Update with version, hashes and release notes:
    • ReleaseNotes (Create new version page and add link to this page)
    • Forum announcement
    • IRC welcome message
    • Website index.php and version files
    • Wikipedia
  • Trac close the milestone and add new version for tickets.
  • Ensure all stable branch commits are also applied to development branch.