diff --git a/general/development/process/release/index.md b/general/development/process/release/index.md index 82c587142..9d3258cda 100644 --- a/general/development/process/release/index.md +++ b/general/development/process/release/index.md @@ -55,7 +55,7 @@ sidebar_position: 7 | 5. | ✓ | | Release candidates release (The Moodle release tool - `mdlrelease` - manages it): At some points (between beta to final release) produce release candidates (Z = 1, 2, 3..), which are normal builds with the following changes: | Integration Team | | 6. | ✓ | | Add a new version in the Plugins Directory with the version's name and the beta release version build number (https://moodle.org/plugins/admin/softwareversions.php). | Plugins Liaison | | 7. | ✓ | | Push any plugins to the plugins database which were previously a part of core. | Plugins Liaison | -| 8. | ✓ | | Tidy up current latest en version of Moodle Docs prior to copying it to create new version wiki as described in [New docs version process](./newuserdocs.md). | Community Manager | +| 8. | ✓ | | Tidy up current latest en version of Moodle Docs prior to copying it to create new version wiki. | Community Manager | ## 3 weeks prior {/* #3-weeks-prior */} @@ -63,7 +63,7 @@ sidebar_position: 7 | :---: | :---: | :---: | --- | --- | | 1. | ✓ | | Ask developers to begin QA tests marked [`external_skipped`](https://moodle.atlassian.net/issues/?filter=22055) then [`test_server_required` tests](https://moodle.atlassian.net/issues/?filter=22055&jql=filter%20%3D%20%22Current%20QA%20cycle%20filter%22%20AND%20status%20%3D%20Open%20AND%20labels%20%3D%20test_server_required%20) and [`credentials_required` tests](https://moodle.atlassian.net/issues/?filter=22055&jql=filter%20%3D%20%22Current%20QA%20cycle%20filter%22%20AND%20status%20%3D%20Open%20AND%20labels%20%3D%20credentials_required). | Product delivery lead | | 2. | ✓ | | Create new en and de Moodle Docs version wikis. | Moodle Docs Maintainer | -| 3. | ✓ | | Go through all points listed under 3 weeks prior in [New docs version process](./newuserdocs.md). | Community Manager | +| 3. | ✓ | | Continue the Moodle Docs new version setup: 3 weeks prior tasks. | Community Manager | | 4. | ✓ | | Review issues with labelled with [`dev_docs_required`](https://moodle.atlassian.net/issues/?filter=11824&jql=labels%20in%20%28dev_docs_required%29%20AND%20resolution%20%3D%20fixed%20ORDER%20BY%20assignee%20ASC%2C%20created%20ASC), prompting assigned developers to create/update this documentation and remove this label when relevant docs are updated. | Product delivery lead | | 5. | ✓ | ✓ | Organise a meeting to verify how everything is going and, before the end of the week, decide (dev leaders from Platform, Educational solutions, Cloud, Apps, Workplace & integrators) if there are real reasons for delaying any release. Whenever a delay is agreed, run the *"Release delaying process"* (doc) actions ASAP.

**Important note**: ASAP stands for as soon as possible ;-), the delay needs to happen before the last week before release begins (there are flows changing that week requiring the decision and actions to be taken and applied earlier) | Product delivery lead | @@ -96,7 +96,7 @@ sidebar_position: 7 | 11. | ✓ | | Organise a meeting to review the following issues: | Product delivery lead | | 12. | ✓ | | Have the community team update the following (in order) to beta release: | Community Manager | | 13. | ✓ | | Prepare pull requests for CI Repositories: | Integration Team | -| 14. | ✓ | | Go through all points listed under 1 week prior in [New docs version process](./newuserdocs.md). | Community Manager | +| 14. | ✓ | | Continue the Moodle Docs new version setup: 1 week prior tasks. | Community Manager | | 15. | ✓ | | Update the `BRANCHLIST` and `VERSIONLIST` in the [JSDoc](https://github.com/moodle/jsdoc) and [PHPDoc](https://github.com/moodle/phpdoc) repositories with the list of supported versions. These are built on a Sunday so this should be done in the final week before release. | Integration Team | ## Releasing {/* #releasing */} @@ -146,7 +146,7 @@ Usually on Monday | 8. | ✓ | | Add the next branch code to the `branchesall` admin setting at lang.moodle.org. Review the list of supported versions and update the value of `branchsupported` there eventually, too. | AMOS Maintainer | | 9. | ✓ | ✓ | Verify, 24h after tagging, that https://moodle.org/dev/contributions.php has been updated with new versions. If not, file an urgent `MDLSITE` issue, crons must be running! | Integration Team | | 10. | ✓ | | For `en` and `de` Moodle Docs, update default redirects and enable email notifications. | Moodle Docs Maintainer | -| 11. | ✓ | | Go through all points listed under Day of release in [New docs version process](./newuserdocs.md). | Community Manager | +| 11. | ✓ | | Continue the Moodle Docs new version setup: Day of release tasks. | Community Manager | | 12. | ✓ | | | Product delivery lead | | 13. | ✓ | | Add calendar events in the [moodle.org calendar](https://moodle.org/calendar) for coming Major and Minor releases up to the next Major release. | Community Manager | | 14. | ✓ | ✓ | Update release schedule image on [Releases page](../../../releases.md#version-support) | Platform Manager | diff --git a/general/development/process/release/newuserdocs.md b/general/development/process/release/newuserdocs.md deleted file mode 100644 index 438b01e64..000000000 --- a/general/development/process/release/newuserdocs.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: New user docs version process -sidebar_label: New user docs -sidebar_position: 1 -tags: - - Documentation - - Processes - - User docs ---- - -:::info - -This page describes the procedures for creating a new Moodle user docs version wiki. - -::: - -## 4 weeks prior {/* #4-weeks-prior */} - -Tidying up in current latest version wiki: - -1. Delete https://docs.moodle.org/en/Special:BrokenRedirects -1. Edit https://docs.moodle.org/en/Special:DoubleRedirects (ignoring redirects to dev docs) -1. Check and delete as necessary https://docs.moodle.org/en/Special:NewFiles -1. Check and delete as necessary https://docs.moodle.org/en/Special:ListDuplicatedFiles -1. Check and delete as necessary https://docs.moodle.org/en/Special:UnusedFiles - -Create a tracker issue for creating new en and de version wikis similar to [MDLSITE-7357](https://moodle.atlassian.net/browse/MDLSITE-7357). - -{/* */} - -## 3 weeks prior {/* #3-weeks-prior */} - -In new version wiki: - -1. Edit MediaWiki:MoodleDocsVersionLinks -1. Edit Main_page -1. Add message to MediaWiki:Sitenotice -1. Remove new features template from all pages in Category:New_features -1. Edit Template:New_features and Category:New_features -1. Follow the [Documentation process](./docsrequiredissues) for adding documentation about new features and improvements -1. Create Upgrading_to_Moodle_x.y and redirect to Upgrading -1. Update version number in Template:Version and Template:Version2 and Git for Administrators -1. Review Special:WantedPages -1. Review Special:LonelyPages -1. Review instances of "(new in x.y)" text (not always necessary to remove them) -1. Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview -1. Post on moodle.org in the Moodle community sites forum about the new version wikis, for example, [Moodle Docs 4.5 English wiki now available](https://moodle.org/mod/forum/discuss.php?d=461965) - -## 1 week prior {/* #1-week-prior */} - -In new wiki: - -1. Remove message in MediaWiki:Sitenotice -1. Check (and update if needed) Upgrading and Upgrade overview pages - -In all older version wikis: - -- Edit https://docs.moodle.org/en/MediaWiki:MoodleDocsVersionLinks to add the new version and remove older versions (though keeping [LTS releases](../../../releases.md)) - -## Day of release {/* #day-of-release */} - -Request for the new version wiki to be made default and email notification of watched pages to be enabled. - -In previous latest version wiki: - -1. Edit https://docs.moodle.org/en/MediaWiki:Noarticletext to make it like https://docs.moodle.org/2x-1/en/MediaWiki:Noarticletext -1. Edit https://docs.moodle.org/en/Creating_SCORM_Content to make it like https://docs.moodle.org/2x-1/en/Creating_SCORM_Content -1. Go through Special:RecentChanges in the previous most recent version wiki and add relevant changes to the new version wiki -1. Edit https://docs.moodle.org/en/Awards and add `#REDIRECT [[:en:Awards]]` so it redirects to the latest version of the page -1. Edit https://docs.moodle.org/en/MoodleDocs:Overview and add `#REDIRECT [[:en:MoodleDocs:Overview]]` so it redirects to the latest version of the page -1. For no longer supported versions, create MediaWiki:Sitenotice by copying content from https://docs.moodle.org/37/en/MediaWiki:Sitenotice - -## Final checks {/* #final-checks */} - -1. Email notification of watched pages enabled -1. Links without version number, for example https://docs.moodle.org/en/Main_page , redirect to the new version wiki -1. Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki -1. New version wiki listed in https://docs.moodle.org/overview/