New docs version process

This page describes the procedures for creating a new Moodle Docs version wiki.

4 weeks prior

Tidying up in current latest version wiki:

1. Delete https://docs.moodle.org/en/Special:BrokenRedirects
2. Edit https://docs.moodle.org/en/Special:DoubleRedirects (ignoring redirects to dev docs)
3. Check and delete as necessary https://docs.moodle.org/en/Special:NewFiles
4. Check and delete as necessary https://docs.moodle.org/en/Special:ListDuplicatedFiles
5. (Check and delete as necessary https://docs.moodle.org/en/Special:ShortPages )

Create tracker issues for creating new en and de version wikis similar to MDLSITE-2198 and MDLSITE-2202.

3 weeks prior

In new version wiki:

1. Ensure email notification of watched pages is disabled initially - in LocalSettings.php set all the Email settings to False - check in the new wiki that there are no email options in user preferences
2. Edit MediaWiki:MoodleDocsVersionLinks
3. Edit Main_page
4. Remove new features template from all pages in Category:New_features
5. Edit Template:New_features and Category:New_features
6. Go through tracker issues with the docs_required label and the release notes for the upcoming release and add documentation on new features plus the new features template
7. Create https://docs.moodle.org/2x/en/Upgrading_to_Moodle_2.x
8. Update version numbers in various places:
   • https://docs.moodle.org/en/Upgrading
   • https://docs.moodle.org/en/Installation_Quickstart
   • https://docs.moodle.org/en/Installing_Moodle
   • https://docs.moodle.org/en/Git_for_Administrators
   • https://docs.moodle.org/en/Upgrade_overview
   • https://docs.moodle.org/en/Language_packs
   • https://docs.moodle.org/en/Language_customization
9. Edit https://docs.moodle.org/en/Template:Release_notes to point to new release notes page
10. Edit https://docs.moodle.org/en/Theme_credits if necessary
11. Review https://docs.moodle.org/en/Special:WantedPages
12. Review https://docs.moodle.org/en/Special:LonelyPages
13. Document new features in en:New features
14. Remove "(new in 2.x)" text
15. Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
16. Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview

Day of release

In all older version wikis:

• Edit https://docs.moodle.org/en/MediaWiki:MoodleDocsVersionLinks to add the new version

In previous latest version wiki:

• Edit https://docs.moodle.org/en/MediaWiki:Noarticletext to make it like https://docs.moodle.org/2x-1/en/MediaWiki:Noarticletext
• Edit https://docs.moodle.org/en/Creating_SCORM_Content to make it like https://docs.moodle.org/2x-1/en/Creating_SCORM_Content
• Go through https://docs.moodle.org/en/Special:RecentChanges and add relevant changes to the new version wiki
• Edit https://docs.moodle.org/en/Awards and add #redirect [[:en:Awards]] so it redirects to the latest version of the page
• Edit https://docs.moodle.org/en/ MoodleDocs:Overview and add #redirect [[:en:MoodleDocs:Overview]] so it redirects to the latest version of the page
• Create MediaWiki:Sitenotice by copying content from https://docs.moodle.org/26/en/MediaWiki:Sitenotice

On moodle.org and dev.moodle.org in footersitesmap change the version number.

Final checks:

• Email notification of watched pages enabled
• Links without version number e.g. https://docs.moodle.org/en/Main_page redirect to the new version wiki
• New version wiki listed in https://docs.moodle.org/overview/