Edgewall Software

Changes between Version 51 and Version 52 of TracProject/DefaultWikiPages


Ignore:
Timestamp:
Nov 20, 2016, 2:33:44 PM (7 years ago)
Author:
Christian Boos
Comment:

update the lifecycle info to take into account the stable vs. dev lines of development, and the ancillary trac-guide repo

Legend:

Unmodified
Added
Removed
Modified
  • TracProject/DefaultWikiPages

    v51 v52  
    7272|| WikiRestructuredTextLinks  || || ||
    7373
     74
    7475== Life-cycle of the default wiki pages #lifecycle
    7576
    76 A "backup" of the toplevel pages for the previous major releases is present in the wiki page hierarchy [[0.11/]], [[0.12/]].
     77A "backup" of the top-level pages for the previous major releases is present in the wiki page hierarchies [[0.11/]], [[0.12/]], and [[1.0/]].
    7778
    78 The toplevel pages (TracGuide and related) correspond to the documentation for the current stable release (1.0) and the minor maintenance releases (1.0.x).
     79The **top-level** pages (TracGuide and related) correspond to the documentation for the **current stable release** (1.2) and the minor maintenance releases (1.2.x).
    7980
    80 Likewise, upcoming changes will be prepared below the [[1.1/]] page hierarchy (dev pages). Pages are created there as needed, when a new feature or change in behavior needs to be documented, the first version being a copy of the content of the corresponding toplevel page.
     81Likewise, upcoming changes will be prepared below the [[1.3/]] page hierarchy (dev pages). Pages are created there as needed, when a new feature or change in behavior needs to be documented, the first version being a copy of the content of the corresponding top-level page.
    8182
    82 == Life-cycle of the wiki pages for Trac 0.12 (LTS)
    8383
    84 The TracGuide pages for [[0.12/]] are not likely to change much. Their content usually matches with what has been shipped in the corresponding release, except for the edits users have made in the meantime, which will be reviewed and integrated in the next minor releases 0.12.x.
     84== Life-cycle of the wiki pages for Trac 0.12 (LTS), and Trac 1.0
    8585
    86 == How to keep the default wiki pages in sync? #sync
     86The TracGuide pages for [[0.12/]], [[1.0/]] are not likely to change much. Their content usually matches with what has been shipped in the corresponding release, except for the edits users have made in the meantime, which will be reviewed and integrated in the next minor releases 0.12.x / 1.0.x.
     87
     88== How to keep the default wiki pages in the repository in sync with t.e.o? #sync
    8789
    8890* Get the latest changes from the t.e.o wiki:
    8991 {{{#!sh
    90 $ cd branches/1.0-stable
     92$ cd branches/1.2-stable
    9193$ PYTHONPATH=. contrib/checkwiki.py -d
    9294}}}
     
    9698  for t.e.o and should be removed from the downloaded content.
    9799* Commit in svn.
    98 * TODO: Describe how to merge content forward (e.g. merge changes from TracWorkflow to [wiki:1.1/TracWorkflow].
    99100
    100 Note that porting changes from 0.12 to 1.0 happens quite naturally when we port over the changes from [source:branches/1.0-stable] to [source:trunk], //but this happens only in the repository//, the toplevel pages on t.e.o won't contain these changes. It might be useful from time to time to do a sync the other way round.
     101Note that merging the changes upward to the development version (e.g. from TracNotification to [[1.3/TracNotification]]) will be done by Trac developers by using the [source:trac-guide] Git repository and some scripts on t.e.o.
     102Likewise, we can also integrated the local edits done during reviewing or merging back into t.e.o that way, see !HowToTracGuide in the admin wiki for details.
     103
    101104
    102105== Migrating to a new major release
    103106
    104 When the time of a new major release `X` is getting near, usually at the time of the beta-release, the toplevel pages are copied to `(X-1)/...` as a backup.
     107//Reminder: a major release corresponds to the creation of a new **stable** line of development 1.X (X being an even number), derived from the **development** version 1.(X-1) happening on [source:trunk]. See RoadMap for details.//
     108
     109At the time of a new major release `X` is getting near, usually at the time of the beta-release, the top-level pages still document the stable version previously released, i.e. version `(X-2)`.
     110
     111Before upgrading the default Trac pages to version `X`, we must copy these top-level pages to the Wiki hierarchy `(X-2)/...` as a backup.
     112
     113The upgrade to version `X` can then be done by copying the pages from the development hierarchy `(X-1)/...` to the top-level.
     114
     115We have some scripting to assist with both these operations on the t.e.o. server (see !HowToTracGuide in the admin wiki).
     116
    105117Some 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 the previous version of Trac .
    106118
    107 The changes that occurred in a toplevel page since the corresponding `X/` page has been created are eventually ported, if those changes are also relevant for the new major version.
     119After the upgrade of the top-level pages, the `(X-1)/` pages won't be touched anymore and can therefore be made read-only.
    108120
    109 Then the `X/` pages are copied to toplevel. All toplevel pages are reviewed and updated as needed for the new version `X`.
    110 
    111 The `X/` pages won't be touched anymore until we'll prepare the migration to the `(X+1)/` release and make a "backup" of the default pages below `X/` (thereby overwriting the old dev pages).
    112 
    113 The `(X+1)/` dev pages can be created anytime after the `X` release.
     121The `(X+1)/` new development pages for the next stable version `(X+2)` can be created anytime after the `X` release, on a case by case basis, as soon as the introduction of a new feature needs to be documented in a specific page.