From d65fe7309e1162b148853d4f2295aafdc02175f6 Mon Sep 17 00:00:00 2001 From: Helen Foster Date: Thu, 27 Nov 2025 09:28:13 +0100 Subject: [PATCH 1/2] Adding new section Information required --- .../process/release/docsrequiredissues.md | 28 +++++++++++++++---- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/general/development/process/release/docsrequiredissues.md b/general/development/process/release/docsrequiredissues.md index f5743a05ea..35204031d3 100644 --- a/general/development/process/release/docsrequiredissues.md +++ b/general/development/process/release/docsrequiredissues.md @@ -6,19 +6,35 @@ tags: - Processes --- -## Issue labelling +## Information required -Prior to each major release, add labels to closed issues as follows: +Issue descriptions should include enough details to document the new feature or improvement, ideally answering the following questions: + +- What problem does this feature solve? +- What is the goal of the user? +- Who is the target audience (e.g. admins, teachers)? +- How does the feature work from a user’s perspective? What are the steps? +- Are there any dependencies / other features that this new feature relies on? +- Does the user interface change for existing users? +- Are there any differences in an upgraded site versus a new install? +- Is there anything a site administrator should know about before upgrading their site? +- Are error messages possible, and if so, how can each error be resolved? + +## Identifying issues + +A list of key features and improvements in the new version should be created for providing content for [New features](https://docs.moodle.org/en/New_features). + +Issues should be labelled as follows: - `docs_required` - new features and improvements which need documenting, also changes which require the existing documentation to be updated. - `ui_change` - significant changes to the student or teacher user interface. - `upgrade_notes` - issues that may affect upgraded sites such as new site admin settings, user tours, major UI changes. -## Writing documentation +## Adding documentation -1. Go through the list of [closed MDL docs_required-labelled issues](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20status%20%3D%20Closed%20AND%20labels%20%3D%20docs_required) and write documentation based on the issue description or testing instructions. If it's unclear, comment in the issue asking for help. -2. Go through the list of ui_change-labelled issues for the version e.g. [ui_change-labelled issues with 4.3 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.3%20AND%20labels%20%3D%20ui_change) and update existing documentation including screenshots. -3. Go through the list of upgrade_notes-labelled issues for the version e.g. [upgrade_notes-labelled issues with 4.3 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.3%20AND%20labels%20%3D%20upgrade_notes) and add documentation to the docs page [Upgrading](https://docs.moodle.org/en/Upgrading) under 'Possible issues that may affect you in Moodle x'. +1. Go through the list of [closed MDL docs_required-labelled issues](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20status%20%3D%20Closed%20AND%20labels%20%3D%20docs_required) and add documentation to the appropriate place in the user documentation. +2. Go through the list of ui_change-labelled issues for the version e.g. [ui_change-labelled issues with 5.1 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%205.1%20AND%20labels%20%3D%20ui_change) and update existing documentation including screenshots. +3. Go through the list of upgrade_notes-labelled issues for the version e.g. [upgrade_notes-labelled issues with 5.1 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%205.1%20AND%20labels%20%3D%20upgrade_notes) and add documentation to the docs page [Upgrading](https://docs.moodle.org/en/Upgrading) under 'Possible issues that may affect you in Moodle x'. 4. When saving the documentation wiki edit, mention the tracker issue number in the edit summary. 5. For a new feature or improvement with at least a paragraph of documentation, edit the tracker issue and add the documentation link. For an existing documentation update, there is no need to add a documentation link. 6. Optional: Add a comment to the tracker issue with the documentation link. From 26c48b157ac4632200ae7dc8bf24b7b9bdd105ce Mon Sep 17 00:00:00 2001 From: Helen Foster Date: Thu, 27 Nov 2025 09:39:14 +0100 Subject: [PATCH 2/2] Fixed apostrophe --- general/development/process/release/docsrequiredissues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general/development/process/release/docsrequiredissues.md b/general/development/process/release/docsrequiredissues.md index 35204031d3..18e2ecde62 100644 --- a/general/development/process/release/docsrequiredissues.md +++ b/general/development/process/release/docsrequiredissues.md @@ -13,7 +13,7 @@ Issue descriptions should include enough details to document the new feature or - What problem does this feature solve? - What is the goal of the user? - Who is the target audience (e.g. admins, teachers)? -- How does the feature work from a user’s perspective? What are the steps? +- How does the feature work from a user's perspective? What are the steps? - Are there any dependencies / other features that this new feature relies on? - Does the user interface change for existing users? - Are there any differences in an upgraded site versus a new install?