Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

New docs version process: Difference between revisions

From MoodleDocs
(→‎3 weeks prior: remove step)
(→‎3 weeks prior: version templates)
Line 25: Line 25:
# Go through [https://tracker.moodle.org/issues/?jql=labels%20%3D%20docs_required 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
# Go through [https://tracker.moodle.org/issues/?jql=labels%20%3D%20docs_required 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
# Create Upgrading_to_Moodle_3.x and redirect to Upgrading
# Update version numbers in various places:
# Update version number in Template:Version and Template:Version2
#* Upgrading
#* Upgrading_FAQ
#* Installation_Quickstart
#* Installing_Moodle
#* Git_for_Administrators
#* Upgrade_overview
#* Language_packs
#* Language_customization
# Edit Template:Release_notes to point to new release notes page
# Edit Theme_credits if necessary
# Review Special:WantedPages
# Review Special:WantedPages
# Review Special:LonelyPages
# Review Special:LonelyPages
# Review instances of "(new in 2.x)" text (not always necessary to remove them)
# 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/dev/MediaWiki:Sidebar
#  Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview
#  Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview

Revision as of 08:54, 16 November 2016

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:UnusedFiles
  6. (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-3951.

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. 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 Upgrading_to_Moodle_3.x and redirect to Upgrading
  8. Update version number in Template:Version and Template:Version2
  9. Review Special:WantedPages
  10. Review Special:LonelyPages
  11. Review instances of "(new in 3.x)" text (not always necessary to remove them)
  12. Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
  13. Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview

Day of release

Create a tracker issue for making the new wiki default, similar to MDLSITE-4043.

In new wiki:

  • Remove message in MediaWiki:Sitenotice

In all older version wikis:

In previous latest version wiki:

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

Final checks: