From 8b8eb93d094fb860bac1850c2bcad7e717ec1f34 Mon Sep 17 00:00:00 2001 From: Tim Hunt Date: Fri, 14 Jun 2024 15:29:38 +0100 Subject: [PATCH 1/2] Update 05.md Better link to the docs about upgrade notes tool. --- general/community/meetings/2024/05.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general/community/meetings/2024/05.md b/general/community/meetings/2024/05.md index b3c6904ff1..ef74bca32e 100644 --- a/general/community/meetings/2024/05.md +++ b/general/community/meetings/2024/05.md @@ -17,7 +17,7 @@ sidebar_position: -05 1. [Moodle Developer Experience (DX) update](./_files/2024-05-DX-presentation.pdf) [Andrew Lyons](https://moodle.org/user/profile.php?id=268794) Moodle HQ - Changes to [Moodle Versioning and Deprecation policies](https://moodle.org/mod/forum/discuss.php?d=457946) - - Writing upgrade notes for Moodle 4.5 and up (MDL-81125 | [Discussion](https://moodle.org/mod/forum/discuss.php?d=457756)) + - [Writing upgrade notes for Moodle 4.5 and up](../../../development/upgradenotes). (Added in MDL-81125 | See also [this discussion](https://moodle.org/mod/forum/discuss.php?d=457756)) - Coding Style and [MoodleCS](../../../development/tools/phpcs.md) - Dependency Injections - Hooks From a1de17ee26e772d84aac24af323d8a8c95bd1ed6 Mon Sep 17 00:00:00 2001 From: Tim Hunt Date: Mon, 10 Jun 2024 17:12:36 +0100 Subject: [PATCH 2/2] Update upgradenotes.md Small, but hopefully useful, wording addition. --- general/development/upgradenotes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general/development/upgradenotes.md b/general/development/upgradenotes.md index 75d5dd7ce1..424a53ed80 100644 --- a/general/development/upgradenotes.md +++ b/general/development/upgradenotes.md @@ -21,7 +21,7 @@ From Moodle 4.5 a new tool, `upgradenotes` has been created to help improve upgr - Think about whether your change actually needs documenting in upgrade notes: - if your change is in a plugin then it probably does not have any public APIs - most bug fixes do not need to be noted unless they change an API -- When deprecating a feature, the replacement should also be mentioned +- When deprecating a feature, the replacement should also be mentioned. To put it another way: what developers want to know is the right way to do things in the future, so focus on explaining that. ## Using `upgradenotes`