New docs version process: Difference between revisions
From MoodleDocs
(Check (and update if needed) Upgrading and Upgrade overview pages) |
Helen Foster (talk | contribs) (→Final checks: dev site link redirecting) |
||
Line 63: | Line 63: | ||
* Email notification of watched pages enabled | * 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 | * Links without version number e.g. https://docs.moodle.org/en/Main_page redirect to the new version wiki | ||
* Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki | |||
* New version wiki listed in https://docs.moodle.org/overview/ | * New version wiki listed in https://docs.moodle.org/overview/ | ||
Revision as of 12:53, 3 September 2020
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:ListDuplicatedFiles
- Check and delete as necessary https://docs.moodle.org/en/Special:UnusedFiles
- (Check and delete as necessary https://docs.moodle.org/en/Special:ShortPages )
Create a tracker issue for creating new en and de version wikis similar to MDLSITE-5946.
3 weeks prior
In new version wiki:
- Edit MediaWiki:MoodleDocsVersionLinks
- Edit Main_page
- Add message to MediaWiki:Sitenotice
- 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 Upgrading_to_Moodle_3.x and redirect to Upgrading
- Update version number in Template:Version and Template:Version2 and Git for Administrators
- Review Special:WantedPages
- Review Special:LonelyPages
- Review instances of "(new in 3.x)" text (not always necessary to remove them)
- Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
- Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview
- Post on moodle.org in the Moodle community sites forum about the new version wikis e.g. Moodle Docs 3.9 wikis now available
1 week prior
Create a tracker issue for making the new wiki default, similar to MDLSITE-6027.
In new wiki:
- Remove message in MediaWiki:Sitenotice
- 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 3.5 as LTS release)
Day of release
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 Special:RecentChanges in the previous most recent version wiki 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, dev.moodle.org, download.moodle.org and lang.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
- Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki
- New version wiki listed in https://docs.moodle.org/overview/