New docs version process
From MoodleDocs
This page describes the procedures for creating a new Moodle Docs version wiki.
4 weeks prior
Tidying up in current latest version wiki:
- Delete https://docs.moodle.org/en/Special:BrokenRedirects
- Edit https://docs.moodle.org/en/Special:DoubleRedirects (ignoring redirects to dev docs)
- Check and delete as necessary https://docs.moodle.org/en/Special:NewFiles
- (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:
- 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
- Edit MediaWiki:Sitenotice
- Edit Main_page
- Remove new features template from all pages in Category:New_features
- Edit Template:New_features and Category:New_features
- 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
- Create https://docs.moodle.org/2x/en/Upgrading_to_Moodle_2.x
- Update version numbers in various places e.g. 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
- Check that the requirements listed in https://docs.moodle.org/en/Installing_Moodle match those in the release notes
- Edit https://docs.moodle.org/en/Theme_credits if necessary
- Review https://docs.moodle.org/en/Special:WantedPages
- Review https://docs.moodle.org/en/Special:LonelyPages
- Document new features in en:New features
- Remove "(new in 2.x)" text
- Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
Day of release
In new version wiki:
- Edit MediaWiki:Sitenotice
In all older version wikis:
- Edit https://docs.moodle.org/en/MediaWiki:Sitenotice 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
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/