| Version 46 (modified by , 9 years ago) ( diff ) |
|---|
Wiki pages to be included in a release
Every Trac release comes with a set of standard wiki pages. Shortly before a release, these pages need to be reviewed to keep them relevant and current. This page describes Trac's wiki pages that should be subject to such a review.
See also the discussion in 0.12#ReviewGuidelines.
Page list
This list is provided for convenience. See trunk/trac/wiki/default-pages for the official list of wiki pages to be included in releases. The WikiStart default page is not synched with Trac:WikiStart and does not appear in that list.
The following table lists the pages that will be included in the next release, and the name of the person who proof-read and possibly updated/corrected that page.
Life-cycle of the default wiki pages
A "backup" of the toplevel pages for the previous major releases is present in the wiki page hierarchy 0.11/, 0.12/.
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).
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.
Life-cycle of the wiki pages for Trac 0.12 (LTS)
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.
How to keep the Trac 0.12 wiki pages in sync?
We use a secondary DVCS for doing the sync, edit and merge. For example, in the repos:cboos.hg repository:
- repos:cboos.hg:trac-guide-teo-0.12-prefix contains the snapshots of the raw content of the 0.12/ pages, as obtained via:
$ cd 0.12-stable $ PYTHONPATH=. python contrib/checkwiki.py -d -p 0.12
- repos:cboos.hg:trac-guide-0.12 is the integration branch for the changes from t.e.o; changes that should not been merged in are discarded (once), like the version specific banner (removed after 0.12.6), the static content replacing macro expansions, etc.
Once the initial setup is done, the following is needed:
- get a new batch of changes from t.e.o
- inspect the changes, if there's anything that need to be fixed, change it in the wiki, iterate
- commit on
trac-guide-teo-0.12-prefix - switch to
trac-guide-0.12, merge from0.12-stable, merge fromtrac-guide-teo-0.12-prefix - commit in svn
Migrating to a new major release
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.
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 the previous version of Trac .
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.
Then the X/ pages are copied to toplevel. All toplevel pages are reviewed and updated as needed for the new version X.
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).
The (X+1)/ dev pages can be created anytime after the X release.
How to keep the default wiki pages in sync?
As some content is only pertinent on t.e.o and not in the packaged docs, downloading new content from t.e.o will lead to repeated merges, so the process described above for 0.12 should be followed.
For example, in the repos:cboos.hg repository:
- repos:cboos.hg:trac-guide-teo contains the snapshots of the raw content of the toplevel pages, as obtained via:
$ cd trunk $ PYTHONPATH=. python contrib/checkwiki.py -d
- repos:cboos.hg:trac-guide-1.0 is the integration branch for the changes from t.e.o; changes that should not been merged in are discarded (once), like the editing caveats, etc.
Once the initial setup is done, the following is needed:
- get a new batch of changes from t.e.o
- inspect the changes, if there's anything that need to be fixed, change it in the wiki, iterate
- commit on
trac-guide-teo - switch to
trac-guide-1.0, merge fromtrunk, merge fromtrac-guide-teo - commit in svn
Note that porting changes from 0.12 to 1.0 happens quite naturally when we port over the changes from branches/0.12-stable to 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.
Attachments (1)
-
trac.hgignore
(124 bytes
) - added by 16 years ago.
.hgignore file I use for mixed svn/hg trac working copies
Download all attachments as: .zip
