Skip to content

Commit

Permalink
Merge pull request #5241 from freedomofpress/docs-update-rm-5081
Browse files Browse the repository at this point in the history
updated release management guide with new instructions for docs build
  • Loading branch information
kushaldas committed Jun 8, 2020
2 parents e300a6e + d7f8d77 commit 309f17e
Showing 1 changed file with 4 additions and 20 deletions.
24 changes: 4 additions & 20 deletions docs/development/release_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,26 +188,10 @@ Release Process
#. Ask Infrastructure to perform the DNS cutover to switch
``apt-qa.freedom.press`` to ``apt.freedom.press``. Once complete,
the release is live.
#. Make sure that the default branch of documentation is being built
off the tip of the release branch. Building from the branch instead
of a given tag enables us to more easily add documentation changes
after release. You should:

a. Log into readthedocs.
#. Navigate to **Projects** → **securedrop** → **Versions** →
**Inactive Versions** → **release/branch** → **Edit**.
#. Mark the branch as Active by checking the box and save your
changes. This will kick off a new docs build.
#. Once the documentation has built, it will appear in the version
selector at the bottom of the column of the.
#. Now set this new release as default by navigating to **Admin** →
**Advanced Settings** → **Global Settings** → **Default
Version**.
#. Select ``release/branch`` from the dropdown menu and save the
changes.
#. Verify that docs.securedrop.org redirects users to the
documentation built from the release branch.

#. Issue a PR to merge the release branch changes into ``master``. Once the PR is
merged, verify that the `public documentation <https://docs.securedrop.org/>`_
refers to the new release version. If not, log in to ReadTheDocs and start a
build of the ``master`` version.
#. Create a `release
<https://github.com/freedomofpress/securedrop/releases>`_ on GitHub
with a brief summary of the changes in this release.
Expand Down

0 comments on commit 309f17e

Please sign in to comment.