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
(→‎After copying: updating version numbers, checking requirements)
m (Protected "New docs version process": Developer Docs Migration ([Edit=Allow only administrators] (indefinite)))
 
(53 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:Migrated|newDocId=/general/development/process/release/newuserdocs}}
This page describes the procedures for creating a new Moodle Docs version wiki.
This page describes the procedures for creating a new Moodle Docs version wiki.


==Pre-copying tidying up==
==4 weeks prior==


In latest version wiki:
Tidying up in current latest version wiki:


# Delete https://docs.moodle.org/en/Special:BrokenRedirects
# Delete https://docs.moodle.org/en/Special:BrokenRedirects
# 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==


==After copying==
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 [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
# 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. [https://moodle.org/mod/forum/discuss.php?d=404029 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:
 
* 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]])


In new version wiki:
==Day of release==


* 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
Request for the new version wiki to be made default and email notification of watched pages to be enabled.
* Edit https://docs.moodle.org/en/MediaWiki:Sidebar
* Edit https://docs.moodle.org/en/Main_page
* Remove new features template from all pages in https://docs.moodle.org/en/Category:New_features
* Edit https://docs.moodle.org/en/Template:New_features and https://docs.moodle.org/en/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
* Create https://docs.moodle.org/2x/en/Upgrading_to_Moodle_2.x
* 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
* Check that the requirements listed in https://docs.moodle.org/en/Installing_Moodle match those in the release notes
* Edit https://docs.moodle.org/en/Theme_credits if necessary
* Review https://docs.moodle.org/en/Special:WantedPages
* Review https://docs.moodle.org/en/Special:LonelyPages


==After release==
In previous latest version wiki:


* Edit https://docs.moodle.org/24/en/MediaWiki:Sidebar
* 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/24/en/Main_page
* 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/24/en/MediaWiki:Noarticletext to make it like https://docs.moodle.org/23/en/MediaWiki:Noarticletext
* 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/24/en/Creating_SCORM_Content to make it like https://docs.moodle.org/23/en/Creating_SCORM_Content
* Edit https://docs.moodle.org/en/Awards and add <code><nowiki>#redirect [[:en:Awards]]</nowiki></code> so it redirects to the latest version of the page
* Edit https://docs.moodle.org/en/MoodleDocs:Overview and add <code><nowiki>#redirect [[:en:MoodleDocs:Overview]]</nowiki></code> 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


Finally:
==Final checks==


* Go through https://docs.moodle.org/24/en/Special:RecentChanges and https://docs.moodle.org/23/en/Special:RecentChanges and add relevant changes to the new version wiki
* Email notification of watched pages enabled
* Enable email notification of watched pages
* Links without version number e.g. https://docs.moodle.org/en/Main_page redirect to the new version wiki
* Add link to new version wiki to main pages of other wikis
* Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki
* Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
* New version wiki listed in https://docs.moodle.org/overview/  
* Redirect links without version number e.g. https://docs.moodle.org/en/Main_page to the new version wiki
* Add a link to new version wiki to https://docs.moodle.org/overview/  


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

Latest revision as of 12:54, 28 May 2022

Important:

This content of this page has been updated and migrated to the new Moodle Developer Resources. The information contained on the page should no longer be seen up-to-date.

Why not view this page on the new site and help us to migrate more content to the new site!

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

Retrieved from "https://docs.moodle.org/dev/index.php?title=New_docs_version_process&oldid=63168"
Powered by MediaWiki