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
(rewording)
m (Text replacement - "</code>" to "</syntaxhighlight>")
(44 intermediate revisions by 3 users not shown)
Line 8: Line 8:
# Edit https://docs.moodle.org/en/Special:DoubleRedirects (ignoring redirects to dev docs)
# 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: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 )
# (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.
Create a tracker issue for creating new en and de version wikis similar to MDLSITE-6265.
 
==3 weeks prior==
==3 weeks prior==


In new version wiki:
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:MoodleDocsVersionLinks
* Edit MediaWiki:Sidebar and MediaWiki:Sitenotice
# Edit Main_page
* Edit Main_page
# Add message to MediaWiki:Sitenotice
* Remove new features template from all pages in Category:New_features
# Remove new features template from all pages in Category:New_features
* 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_3.x and redirect to Upgrading
* 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/25/en/Git_for_Administrators
# Update version number in Template:Version and Template:Version2 and Git for Administrators
* Check that the requirements listed in https://docs.moodle.org/en/Installing_Moodle match those in the release notes
# Review Special:WantedPages
* Edit https://docs.moodle.org/en/Theme_credits if necessary
# Review Special:LonelyPages
* Review https://docs.moodle.org/en/Special:WantedPages
# Review instances of "(new in 3.x)" text (not always necessary to remove them)
* Review https://docs.moodle.org/en/Special:LonelyPages
# Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
* Document new features in [[:en:New features]]
# Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview
* Remove "(new in 2.x)" text
# Post on moodle.org in the Moodle community sites forum about the new version wikis e.g. [https://moodle.org/mod/forum/discuss.php?d=404029 Moodle Docs 3.9 wikis now available]
* Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
 
==1 week prior==


==Day of release==
In new wiki:


In new version wiki:
* Remove message in MediaWiki:Sitenotice
* Check (and update if needed) Upgrading and Upgrade overview pages
* Edit MediaWiki:Sitenotice


In all older version wikis:
In all older version wikis:


* Edit https://docs.moodle.org/en/MediaWiki:Sidebar and https://docs.moodle.org/en/MediaWiki:Sitenotice
* Edit https://docs.moodle.org/en/MediaWiki:MoodleDocsVersionLinks to add the new version and remove older versions (though keeping 3.9 as [[Releases|LTS release]])
 
==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:
In previous latest version wiki:


* Edit https://docs.moodle.org/en/Main_page
* 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/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  
* 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 and add relevant changes to the new version wiki
* 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 <syntaxhighlight lang="php"><nowiki>#redirect [[:en:Awards]]</nowiki></syntaxhighlight> so it redirects to the latest version of the page
* Edit https://docs.moodle.org/en/MoodleDocs:Overview and add <syntaxhighlight lang="php"><nowiki>#redirect [[:en:MoodleDocs:Overview]]</nowiki></syntaxhighlight> so it redirects to the latest version of the page
* For no longer supported versions, create MediaWiki:Sitenotice by copying content from https://docs.moodle.org/37/en/MediaWiki:Sitenotice
 
==Final checks==


Final checks:
* 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/  


[[Category:Documentation]]
[[Category:Processes]]
[[Category:Processes]]
[[Category:Moodle Docs]]

Revision as of 13:04, 14 July 2021

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-6265.

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 and Git for Administrators
  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
  14. 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

In new wiki:

  • Remove message in MediaWiki:Sitenotice
  • 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:

Final checks