Edgewall Software

Changes between Version 42 and Version 43 of TracProject/DefaultWikiPages


Ignore:
Timestamp:
Feb 3, 2015, 8:23:29 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracProject/DefaultWikiPages

    v42 v43  
    1 = Wiki pages to be included in a release =
     1= Wiki pages to be included in a release
    22[[PageOutline(2-3)]]
    3 == Review
    4 This page is used to keep track of the informal review process of the default pages, which happens every once in a while, usually shortly before a new major release.
     3
     4Every 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.
    55
    66See also the discussion in [[0.12#ReviewGuidelines]].
    77
    8 === Page list
    9 ''This list only provided for convenience. See [source:/trunk/contrib/checkwiki.py#latest checkwiki.py] 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.''
     8== Page list
    109
    11 The following table lists the pages that will be included in the next [milestone:1.0] release, and the name of the person who proof-read and possibly updated/corrected that page.
     10''This list is provided for convenience. See [source:/trunk/contrib/checkwiki.py#latest checkwiki.py] 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.''
     11
     12The 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.
    1213
    1314||= Page ||= Proof-read ||= Comments ||
     
    7071|| WikiStart                  || || ||
    7172
    72 
    73 === Status ===
    74 Next review will be for the [milestone:1.0] release (in beta).
    75 
    76 
    7773== Life-cycle of the default wiki pages #lifecycle
    7874
     
    8379Likewise, 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.
    8480
     81== Life-cycle of the wiki pages for Trac 0.12 (LTS)
    8582
    86 === Life-cycle of the wiki pages for Trac 0.12 (LTS)
     83The 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.
    8784
    88 The TracGuide pages for [[0.12/]] are not likely to change much, but just in case...
    89 
    90 Their content is usually matching the one which 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.
    91 
    92 === How to maintain the 0.12 wiki pages in sync? === #sync012
     85== How to keep the Trac 0.12 wiki pages in sync? == #sync012
    9386
    9487We use a secondary DVCS for doing the sync, edit and merge.
     
    10194 - 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 [milestone:0.12.6]), the static content replacing macro expansions, etc.
    10295
    103 Once the initial setup is done, all what is needed is usually:
     96Once the initial setup is done, the following is needed:
    10497 - get a new batch of changes from t.e.o
    10598 - inspect the changes, if there's anything that need to be fixed, change it in the wiki, iterate
     
    108101 - commit in svn
    109102
    110 === Migrating to a new major release
     103== Migrating to a new major release
    111104
    112 When the time of a new major release `X` is getting near (usually at the time of the beta), the toplevel pages are copied to `(X-1)/...` as a backup.
     105When 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.
    113106Some 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 .
    114107
     
    121114The `(X+1)/` dev pages can be created anytime after the `X` release.
    122115
     116== How to keep the default wiki pages in sync? == #sync
    123117
    124 === How to maintain the default wiki pages in sync? === #sync
    125 
    126 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 merge, so we need a system that can handle them efficiently.
    127 
    128 We do that pretty much the same way we already described above for [#sync012 0.12].
     118As 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 [#sync012 0.12] should be followed.
    129119
    130120For example, in the repos:cboos.hg repository:
     
    136126 - 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.
    137127
    138 Once the initial setup is done, all what is needed is usually:
     128Once the initial setup is done, the following is needed:
    139129 - get a new batch of changes from t.e.o
    140130 - inspect the changes, if there's anything that need to be fixed, change it in the wiki, iterate