Changes between Version 36 and Version 37 of TracProject/DefaultWikiPages

Timestamp:

Aug 8, 2011, 11:37:16 AM (13 years ago)

Author:

Christian Boos

Comment:

document the #lifecycle in more details, based on ticket:10284#comment:15

TracProject/DefaultWikiPages

@@ -70 +70 @@
 
 
-== Life-cycle of the default wiki pages
+== Life-cycle of the default wiki pages #lifecycle
+
+In the following, we call "0.X" the current stable version. 
+
+=== Status quo
+
+The TracGuide pages present at the toplevel of the project correspond to the current stable version 0.X.
+
+Their content is usually matching the one which has been shipped in the corresponding release, except for:
+ - a banner mentioning the current version and linking to the page corresponding to the //previous// release (e.g. for TracWiki: **Note: this page documents the 0.12 version of Trac, see [[0.11/TracWiki]] if you need the previous version**)
+ - the edits users have made in the meantime, which will be reviewed and integrated in the next minor and major releases (see [#sync] below)
+
+So a "backup" of the toplevel pages for the previous major release is present in the wiki page hierarchy below `0.(X-1)/`.
+
+Likewise, upcoming changes are prepared below the  `0.(X+1)/` page hierarchy (dev pages). Pages are created there as needed, when a new feature or change in behavior needs to be documented. 
+
+
 === When migrating to a new major release
 
- - Prepare documentation below !wiki:0.X/<page> by copying current TracGuide pages wiki:<page>
- - When the beta testing period begins:
-    - rename the default pages to !wiki:0.X-1/<page>, taking care of replacing dynamic content in TracAdmin, TracIni, TracSyntaxColoring (starting with 0.12) and WikiMacros by the output generated by Trac 0.X-1
-    - rename the !wiki:0.X/<page> pages to wiki:<page>
+When the time of a new major `0.(X+1)` release is getting near (usually at the time of the beta), the toplevel pages are copied to X/... as a backup.
+Some care should be taken about  replacing the dynamic content found in TracAdmin, TracIni, TracSyntaxColoring (starting with 0.12) and WikiMacros by the output generated by Trac `0.X`.
 
+The changes that occurred in a toplevel page since the corresponding `0.(X+1)/` page has been created are eventually ported, if those changes are also relevant for the new major version.
+
+Then the `0.(X+1)/` pages are copied to toplevel, with the appropriate change in the warning banner.
+
+All toplevel pages are reviewed and updated as needed for the new version X.
+
+The `0.(X+1)` pages won't be touched anymore until we'll prepare the migration to the `0.(X+2)` release and make a "backup" of the default pages below `0.(X+1)/` (thereby overwriting the old dev pages).
+
+The `0.(X+2)/` dev pages can be created anytime after the `0.(X+1)` release.
 
 === How to maintain the default wiki pages in sync? === #sync