Published
Migrate Development Practices to the XWiki 2.1 syntax
Last modified by Manuel Leduc on 2026/10/15 18:07
Preview the image
Migrate the page from the XWiki 2.0 syntax to the XWiki 2.1 syntax. The content does not change.
The only incompatibility is the links to a heading anchor: XWiki 2.1 reads "#HAnchor" at the end of a reference as part of the page name. The 11 anchor links now use the anchor link parameter, e.g. label.
This is a prerequisite to document the outcome of https://forum.xwiki.org/t/prefer-async-await-over-promise-chaining-in-javascript-and-typescript/18966 in the JavaScript Best Practices section.
PS: This change request was prepared with Claude Code.
-
Manuel Leduc created this Change Request with changes for Development Practices 5 hours ago
-
Manuel Leduc added a new approval review 4 hours ago
-
Manuel Leduc changed the status of the Change Request from ready for review to ready for publication 4 hours ago
-
Manuel Leduc changed the status of the Change Request from ready for publication to published 4 hours ago
All changes
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -xwiki:XWiki. VincentMassol1 +xwiki:XWiki.mleduc - Syntax
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki 2. 01 +XWiki 2.1 - Content
-
... ... @@ -29,7 +29,7 @@ 29 29 30 30 == Roadmap == 31 31 32 -* The [[Roadmap Manager>> #HRoadmapManagerRole]] regularly starts a roadmap proposal thread on the forum, proposing high level topics to work on in the coming XWiki releases.32 +* The [[Roadmap Manager>>||anchor="HRoadmapManagerRole"]] regularly starts a roadmap proposal thread on the forum, proposing high level topics to work on in the coming XWiki releases. 33 33 * The idea is to discuss with the XWiki community and especially the XWiki committers what everyone is interested to work on, but also to verify that in the proposed list, there's nothing that the committers think are not going in the good interest of the project. At this point, committers can also propose new items they'd like to work on. 34 34 * Once the roadmap is agreed, or if there are no comments, the Roadmap Manager updates the [[Roadmap page>>xwiki:Roadmaps.WebHome]] with its content. 35 35 * Then, each committers having accepted to implement tasks from the roadmap should analyse their tasks, discuss (to cover all topics including functional needs but also cross-topics such as security, risk, performance, accessibility, and more) with others about them (especially with the person who's proposed the topic), and quickly create a list of JIRA issues, representing the different elements to implement the high level topics. ... ... @@ -80,12 +80,12 @@ 80 80 81 81 Process: 82 82 83 -* We have a [[list of declared Release Managers>>ReleasePlans.WebHome #HNextReleaseManagers]]. Any committer willing to help the project is free to ask to perform a release!83 +* We have a [[list of declared Release Managers>>ReleasePlans.WebHome||anchor="HNextReleaseManagers"]]. Any committer willing to help the project is free to ask to perform a release! 84 84 * We take turns, following the order (from top to bottom). When a newcomer is added he's inserted at the bottom of the list. 85 85 * If a committer cannot do the release for a reason or another (sick, holiday, workload, etc) he’s still responsible for the release and he/she needs to find a replacement. He also has the option to propose changing the release date but that needs to be accepted by the project. If he/she finds a replacement, it’s up to them to decide together who will do the release the next time that replacement’s time comes. 86 86 * All releases are included in this process: milestones, RCs, final, bugfix releases. 87 87 * We switch Release Manager at each release (be it a milestone, RC, final or bugfix release). 88 -* Once a Release is done, the Release Manager updates the [[Release Manager order>>ReleasePlans.WebHome #HNextReleaseManagers]] by moving himself/herself at the bottom of the pile.88 +* Once a Release is done, the Release Manager updates the [[Release Manager order>>ReleasePlans.WebHome||anchor="HNextReleaseManagers"]] by moving himself/herself at the bottom of the pile. 89 89 90 90 == Build Manager Role == 91 91 ... ... @@ -195,7 +195,7 @@ 195 195 196 196 Process: 197 197 198 -* See [[Dependency upgrade pull requests>> #HDependencyupgradepullrequests]].198 +* See [[Dependency upgrade pull requests>>||anchor="HDependencyupgradepullrequests"]]. 199 199 200 200 == Performance Manager Role == 201 201 ... ... @@ -576,7 +576,7 @@ 576 576 577 577 We follow 2 steps when it comes to deprecating code: 578 578 579 -* **First step**: We start by deprecating it [[using the ##@deprecate## and ##@Deprecated## Javadoc and java annotations>>Community.CodeStyle.JavaCodeStyle.WebHome #HDeprecation]]. The code remains where it was before the deprecation happens.579 +* **First step**: We start by deprecating it [[using the ##@deprecate## and ##@Deprecated## Javadoc and java annotations>>Community.CodeStyle.JavaCodeStyle.WebHome||anchor="HDeprecation"]]. The code remains where it was before the deprecation happens. 580 580 * **Second step**: When our own code doesn't use any of the deprecated APIs anymore then move the code to a **legacy** module. This can be done as soon as the deprecation is added. 581 581 582 582 This has the following advantages: ... ... @@ -798,7 +798,7 @@ 798 798 799 799 When using icons in content, they must rely on [[the XWiki icon set>>xwiki:documentation.xs.admin.icons.icon-set.WebHome]]. 800 800 801 -When adding new icons to the XWiki icon set, their names must follow our [[icon naming conventions>>xwiki:documentation.xs.admin.icons.icon-set.WebHome #HIconnamingconvention]].801 +When adding new icons to the XWiki icon set, their names must follow our [[icon naming conventions>>xwiki:documentation.xs.admin.icons.icon-set.WebHome||anchor="HIconnamingconvention"]]. 802 802 803 803 == JavaScript Best Practices == 804 804 ... ... @@ -826,7 +826,7 @@ 826 826 ** either by using the JSX plugin (e.g. ##$xwiki.jsx.use(...)##) from a server-side script (e.g. to load the JavaScript module that serves as your entry point) 827 827 ** or by declaring the module as a dependency of another JavaScript module 828 828 * We recommend loading JSX using "On demand only". That is: load your JavaScript code only where / when it is needed. Avoid using "On this wiki". 829 -* Localizations in Javascript should use [[a dedicated module and the specific loader>>extensions:Extension.Localization #HFromJavaScript]].829 +* Localizations in Javascript should use [[a dedicated module and the specific loader>>extensions:Extension.Localization||anchor="HFromJavaScript"]]. 830 830 * Avoid mixing JavaScript with server-side scripting (e.g. Velocity), especially for JavaScript code packaged as WebJar, because in this case the scripts are evaluated long after the JavaScript code is **minified** and the minifier can rewrite the JavaScript code in a way that breaks the embedded server-side scripts. If this is not possible then use this pattern to separate the JavaScript-only code from the embedded scripts:((( 831 831 {{code language="js"}} 832 832 /*! ... ... @@ -872,7 +872,7 @@ 872 872 } 873 873 {{/code}} 874 874 ))) 875 -* JavaScript modules should have [[automated unit-like tests>>Community.Testing.WebHome #HJavaScriptUnitTesting]].875 +* JavaScript modules should have [[automated unit-like tests>>Community.Testing.WebHome||anchor="HJavaScriptUnitTesting"]]. 876 876 877 877 Check [[xwiki:Documentation.DevGuide.FrontendResources.WebHome]] for more JavaScript-related documentation. 878 878 ... ... @@ -991,8 +991,8 @@ 991 991 992 992 * Send a VOTE propose on the Forum 993 993 * Once agreed: 994 -** If you're retiring the whole GitHub repo, then simply move it on GitHub and if you're only retiring a part of the repo then [[Extract out the module>> #HExtractingoutamodule]].995 -** [[Retire the JIRA project>> #HRetiringaJIRAproject]]994 +** If you're retiring the whole GitHub repo, then simply move it on GitHub and if you're only retiring a part of the repo then [[Extract out the module>>||anchor="HExtractingoutamodule"]]. 995 +** [[Retire the JIRA project>>||anchor="HRetiringaJIRAproject"]] 996 996 ** Update the page on e.x.o to indicate this with a warning and information in the Compatibility section. 997 997 998 998 {{info}} ... ... @@ -1050,7 +1050,7 @@ 1050 1050 1051 1051 = Add a new committer = 1052 1052 1053 -See [[Community.Committership #HChecklisttoaddanewcommitter]].1053 +See [[Community.Committership||anchor="HChecklisttoaddanewcommitter"]]. 1054 1054 1055 1055 = Security = 1056 1056
Oct 15, 2026, 6:06:23 PM
Approved by Manuel Leduc
Approvers
Approvers have not been explicitly defined for this Change Request. Approvers will be based entirely on approval rights.