docs: Add OpenEdX Release Notes Checklist to Repo. #313
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
One item on the checklist is currently: 'Commit this checklist to a more durable location' - Github flavored Markdown is easy, accessible, and durable so it seems a good fit.
|
Thanks for the pull request, @feoh! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
openedx-webhooks
added
the
open-source-contribution
Comment on lines
+2
to
+14
| - [ ] find the date for the previous release (for Olive, this was October 11, 2022) | ||
| - [ ] find the date for the next release (for Palm, this was April xx, 2022) | ||
| - [ ] Create a wiki page for the _next_ release, on the [Open edX Release Planning](https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845) wiki page ([Redwood](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3890380898/Next+Release+Redwood)) | ||
| ### Things to do after the release is cut | ||
| - [ ] add an appropriate TOC to the release notes | ||
| - [ ] add any items from the [Pending Release wiki page](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3726802953/Pending+Release+Quince) | ||
| - [ ] Review and incorporate any feature posts from [edX Partner announcements](https://partners.edx.org/announcements) | ||
| - [ ] Review and incorporate any feature posts from the [open edX blog](https://open.edx.org/category/blog/) | ||
| - [ ] Review commit messages from relevant repos. [Dinghy](https://github.com/nedbat/dinghy) seems like a useful tool for this. I used this config [olive-dinghy.yaml](https://gist.github.com/pdpinch/a1749421cc2af23f9d9a2335e065489b) | ||
| - [ ] Review [DEPR tickets ](https://openedx.atlassian.net/secure/RapidBoard.jspa?rapidView=452) | ||
| - [ ] Diff the technical documentation and build a list of links to both new and removed settings. | ||
| ### Meta tasks | ||
| - [ ] Review and update this checklist |
There was a problem hiding this comment.
Suggested change
| - [ ] find the date for the previous release (for Olive, this was October 11, 2022) | |
| - [ ] find the date for the next release (for Palm, this was April xx, 2022) | |
| - [ ] Create a wiki page for the _next_ release, on the [Open edX Release Planning](https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845) wiki page ([Redwood](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3890380898/Next+Release+Redwood)) | |
| ### Things to do after the release is cut | |
| - [ ] add an appropriate TOC to the release notes | |
| - [ ] add any items from the [Pending Release wiki page](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3726802953/Pending+Release+Quince) | |
| - [ ] Review and incorporate any feature posts from [edX Partner announcements](https://partners.edx.org/announcements) | |
| - [ ] Review and incorporate any feature posts from the [open edX blog](https://open.edx.org/category/blog/) | |
| - [ ] Review commit messages from relevant repos. [Dinghy](https://github.com/nedbat/dinghy) seems like a useful tool for this. I used this config [olive-dinghy.yaml](https://gist.github.com/pdpinch/a1749421cc2af23f9d9a2335e065489b) | |
| - [ ] Review [DEPR tickets ](https://openedx.atlassian.net/secure/RapidBoard.jspa?rapidView=452) | |
| - [ ] Diff the technical documentation and build a list of links to both new and removed settings. | |
| ### Meta tasks | |
| - [ ] Review and update this checklist | |
| - [ ] find the date for the previous release (for Olive, this was October 11, 2022) | |
| - [ ] find the date for the next release (for Palm, this was April xx, 2022) | |
| - [ ] Create a wiki page for the _next_ release, on the [Open edX Release Planning](https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845) wiki page ([Redwood](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3890380898/Next+Release+Redwood)) | |
| ### Things to do after the release is cut | |
| - [ ] Add an appropriate TOC to the release notes | |
| - [ ] Add any items from the [Pending Release wiki page](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3726802953/Pending+Release+Quince) | |
| - [ ] Review and incorporate any feature posts from [edX Partner announcements](https://partners.edx.org/announcements) | |
| - [ ] Review and incorporate any feature posts from the [Open edX blog](https://openedx.org/category/blog/) | |
| - [ ] Review commit messages from relevant repos. [Dinghy](https://github.com/nedbat/dinghy) seems like a useful tool for this. I used this config [olive-dinghy.yaml](https://gist.github.com/pdpinch/a1749421cc2af23f9d9a2335e065489b) | |
| - [ ] Review [DEPR tickets ](https://openedx.atlassian.net/secure/RapidBoard.jspa?rapidView=452) | |
| - [ ] Diff the technical documentation and build a list of links to both new and removed settings. | |
| ### Meta tasks | |
| - [ ] Review and update this checklist |
Comment on lines
+2
to
+3
| - [ ] find the date for the previous release (for Olive, this was October 11, 2022) | ||
| - [ ] find the date for the next release (for Palm, this was April xx, 2022) |
There was a problem hiding this comment.
how is this information used?
| - [ ] find the date for the next release (for Palm, this was April xx, 2022) | ||
| - [ ] Create a wiki page for the _next_ release, on the [Open edX Release Planning](https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845) wiki page ([Redwood](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3890380898/Next+Release+Redwood)) | ||
| ### Things to do after the release is cut | ||
| - [ ] add an appropriate TOC to the release notes |
| - [ ] add any items from the [Pending Release wiki page](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3726802953/Pending+Release+Quince) | ||
| - [ ] Review and incorporate any feature posts from [edX Partner announcements](https://partners.edx.org/announcements) | ||
| - [ ] Review and incorporate any feature posts from the [open edX blog](https://open.edx.org/category/blog/) | ||
| - [ ] Review commit messages from relevant repos. [Dinghy](https://github.com/nedbat/dinghy) seems like a useful tool for this. I used this config [olive-dinghy.yaml](https://gist.github.com/pdpinch/a1749421cc2af23f9d9a2335e065489b) |
There was a problem hiding this comment.
what should we do with the commit messages?
|
Hi there! As per feedback from the community, this is moving to a page on OpenEdX Confluence. Please add all questions and comments to that page, and thanks for your patience all! Closing this. |
|
@feoh Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future. |
1 similar comment
|
@feoh Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future. |
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.
docs: Add OpenEdX Release Notes Checklist to Repo.
One item on the checklist is currently:
'Commit this checklist to a more durable location' - Github flavored Markdown is easy, accessible, and durable so it seems a good fit.