Skip to main content

New user docs version process

info

This page describes the process for creating a new user documentation wiki for the upcoming major release.

The new user documentation wiki should be available three weeks before the release date to give developers, including community developers, time to document new features and improvements. QA testers can also benefit from the new documentation during the QA testing cycle.

4 weeks prior​

Before cloning the existing user documentation wiki to use as a basis for the new wiki, complete the following clean-up tasks:

  1. Review Broken redirects and delete broken redirects (ignoring pages with a prefix 'Development').
  2. Review Double redirects and edit the pages so they redirect directly.
  3. Review List of files with duplicates and delete any duplicated files.

Create a tracker issue for setting up the new user documentation wiki e.g. MDLSITE-8325.

3 weeks prior​

In new version wiki:

  1. Edit MediaWiki:MoodleDocsVersionLinks
  2. Edit Main_page
  3. Add message to MediaWiki:Sitenotice
  4. Remove new features template from all pages in Category:New_features
  5. Edit Template:New_features and Category:New_features
  6. Follow the Documentation process for adding documentation about new features and improvements
  7. Create Upgrading_to_Moodle_x.y and redirect to Upgrading
  8. Update version number in Template:Version and Template:Version2 and Git for Administrators
  9. Review Special:WantedPages
  10. Review Special:LonelyPages
  11. Review instances of "(new in x.y)" text (not always necessary to remove them)
  12. Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview
  13. 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

1 week prior​

In new wiki:

  1. Remove message in MediaWiki:Sitenotice
  2. Check (and update if needed) Upgrading and Upgrade overview pages

In all older version wikis:

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
  2. Edit https://docs.moodle.org/en/Creating_SCORM_Content to make it like https://docs.moodle.org/2x-1/en/Creating_SCORM_Content
  3. Go through Special:RecentChanges in the previous most recent version wiki and add relevant changes to the new version wiki
  4. Edit https://docs.moodle.org/en/Awards and add #REDIRECT [[:en:Awards]] so it redirects to the latest version of the page
  5. Edit https://docs.moodle.org/en/MoodleDocs:Overview and add #REDIRECT [[:en:MoodleDocs:Overview]] so it redirects to the latest version of the page
  6. For no longer supported versions, create MediaWiki:Sitenotice by copying content from https://docs.moodle.org/37/en/MediaWiki:Sitenotice

Final checks​

  1. Email notification of watched pages enabled
  2. Links without version number, for example https://docs.moodle.org/en/Main_page , redirect to the new version wiki
  3. Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki
  4. New version wiki listed in https://docs.moodle.org/overview/