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
m (→‎4 weeks prior: tracker issue update)
m (→‎3 weeks prior: removing links)
Line 24: Line 24:
# Edit Template:New_features and Category:New_features
# Edit Template:New_features and Category:New_features
# 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 https://docs.moodle.org/2x/en/Upgrading_to_Moodle_2.x
# Create Upgrading_to_Moodle_2.x and redirect to Upgrading
# Update version numbers in various places:
# Update version numbers in various places:
#* https://docs.moodle.org/en/Upgrading
#* Upgrading
#* https://docs.moodle.org/en/Upgrading_FAQ
#* Upgrading_FAQ
#* https://docs.moodle.org/en/Installation_Quickstart
#* Installation_Quickstart
#* https://docs.moodle.org/en/Installing_Moodle
#* Installing_Moodle
#* https://docs.moodle.org/en/Git_for_Administrators
#* Git_for_Administrators
#* https://docs.moodle.org/en/Upgrade_overview
#* Upgrade_overview
#* https://docs.moodle.org/en/Language_packs
#* Language_packs
#* https://docs.moodle.org/en/Language_customization
#* Language_customization
# Edit https://docs.moodle.org/en/Template:Release_notes to point to new release notes page
# Edit Template:Release_notes to point to new release notes page
# Edit https://docs.moodle.org/en/Theme_credits if necessary
# Edit Theme_credits if necessary
# Review https://docs.moodle.org/en/Special:WantedPages
# Review Special:WantedPages
# Review https://docs.moodle.org/en/Special:LonelyPages
# Review Special:LonelyPages
# Document new features in [[:en:New features]]
# Review instances of "(new in 2.x)" text (not always necessary to remove them)
# Review instances of "(new in 2.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

Revision as of 14:57, 20 April 2015

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 a tracker issue for creating new en and de version wikis similar to MDLSITE-3951.

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. Add message to MediaWiki:Sitenotice
  5. Remove new features template from all pages in Category:New_features
  6. Edit Template:New_features and Category:New_features
  7. 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
  8. Create Upgrading_to_Moodle_2.x and redirect to Upgrading
  9. Update version numbers in various places:
    • Upgrading
    • Upgrading_FAQ
    • Installation_Quickstart
    • Installing_Moodle
    • Git_for_Administrators
    • Upgrade_overview
    • Language_packs
    • Language_customization
  10. Edit Template:Release_notes to point to new release notes page
  11. Edit Theme_credits if necessary
  12. Review Special:WantedPages
  13. Review Special:LonelyPages
  14. Review instances of "(new in 2.x)" text (not always necessary to remove them)
  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 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: