updated release management guide with new instructions for docs build #5241
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zenmonkeykstop
requested review from
emkll,
kushaldas and
redshiftzero
as code owners
eloquence
reviewed
May 8, 2020
| #. 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. |
There was a problem hiding this comment.
The previous version said:
Building from the branch instead of a given tag enables us to more easily add documentation changes after release.
With this new process, I think we should make the expectations for post-release/post-tag docs updates even more explicit, to avoid confusion about what's permissible, and to avoid missing required steps.
What's the expected process going forward?
- Will we still permit post-tag backports of docs changes into the release branch, without creating a new tag?
- Will such docs changes then need to be individually ported into
master, or is the expectation to do a single merge tomasteronce towards the very end of the process?
There was a problem hiding this comment.
Per the discussion at our retro, we also want to clarify what merge strategy we want to use here (ideally one that is low-effort, since master is only used for docs builds).
kushaldas
approved these changes
Jun 8, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Status
Ready for review
Description of Changes
Resolves #5081.
Updates release management docs with instructions on updating public documentation.
Testing
Deployment
Any special considerations for deployment? Consider both:
Checklist
If you made changes to documentation:
make docs-lint) passed locally