Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds new documentation pages describing deprecation approaches for JavaScript and Mustache templates, and expands the main deprecation policy page to clarify that deprecation considerations apply beyond just “public APIs”.
Changes:
- Added deprecation policy pages for JavaScript and templates under
general/development/policies/deprecation/. - Added a JavaScript deprecation “how-to” guide under
docs/guides/javascript/. - Updated the deprecation policy index to explicitly include non-PHP areas (JS, templates, React, web services, etc.) and breaking changes via “changes”.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| general/development/policies/deprecation/templates.md | New policy page describing how template deprecations should be handled. |
| general/development/policies/deprecation/javascript.md | New policy page describing JavaScript deprecation principles and pointing to the guide. |
| general/development/policies/deprecation/index.md | Clarifies that deprecation policy applies broadly across Moodle code and breaking changes. |
| docs/guides/javascript/deprecation.md | New guide describing usage of the core/deprecated utility and related behaviors. |
| --- | ||
| title: Deprecation of JavaScript | ||
| tags: | ||
| - deprecation |
There was a problem hiding this comment.
Frontmatter tags here use only a single lowercase deprecation tag. In this same section, other deprecation policy pages consistently use a fuller, Title Case tag set (e.g. Processes, Core development, Deprecation, plus a topic tag like SCSS/Icon). Aligning the tags avoids splitting tag indexes (e.g. Deprecation vs deprecation) and keeps these pages grouped consistently.
| - deprecation | |
| - Processes | |
| - Core development | |
| - Deprecation | |
| - JavaScript |
| --- | ||
| title: Deprecation of JavaScript | ||
| tags: | ||
| - deprecation |
There was a problem hiding this comment.
This page sits under docs/guides/javascript/, but its frontmatter tags don’t include the commonly used Javascript tag used by other pages in the same section (e.g. ajax/index.md, modules.md, modal/index.md). Adding Javascript (and using the same capitalization conventions for tags) will keep tag-based navigation/search consistent for JavaScript guides.
| - deprecation | |
| - deprecation | |
| - Javascript |
| - deprecation | ||
| --- | ||
|
|
||
| The Mustache Templating system does not formally support any deprecation process, therefore the deprecation _process_ is slightly different, while the principle and intent is the same. |
There was a problem hiding this comment.
The sentence has subject/verb agreement and comma-splice issues ("principle and intent is" should be "are"; consider splitting into two sentences for readability).
| The Mustache Templating system does not formally support any deprecation process, therefore the deprecation _process_ is slightly different, while the principle and intent is the same. | |
| The Mustache Templating system does not formally support any deprecation process. Therefore, the deprecation _process_ is slightly different, while the principle and intent are the same. |
| --- | ||
| title: Deprecation of templates | ||
| tags: | ||
| - deprecation |
There was a problem hiding this comment.
Frontmatter tags here use only a single lowercase deprecation tag. In this same section, other deprecation policy pages consistently use a fuller, Title Case tag set (e.g. Processes, Core development, Deprecation, plus a topic tag like Icon/SCSS). Aligning the tags avoids splitting tag indexes (e.g. Deprecation vs deprecation) and keeps these pages grouped consistently in navigation/search.
| - deprecation | |
| - Processes | |
| - Core development | |
| - Deprecation | |
| - Templates |
This is based on #1562 and also includes a couple of more general deprecation notes.