Edgewall Software

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

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.

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 SandBox and WikiStart pages are not synched with SandBox and WikiStart and therefore do not appear in the list.

Page Proof-read Comments
CamelCase
InterMapTxt
InterTrac
InterWiki
PageTemplates
RecentChanges
TicketQuery
TitleIndex
TracAccessibility
TracAdmin
TracBackup
TracBatchModify
TracBrowser
TracCgi
TracChangeLog
TracChangeset
TracEnvironment
TracFastCgi
TracFineGrainedPermissions
TracGuide
TracImport
TracIni
TracInstall
TracInterfaceCustomization
TracLinks
TracLogging
TracModPython
TracModWSGI
TracNavigation
TracNotification
TracPermissions
TracPlugins
TracQuery
TracReports
TracRepositoryAdmin
TracRevisionLog
TracRoadmap
TracRss
TracSearch
TracStandalone
TracSupport
TracSyntaxColoring
TracTickets
TracTicketsCustomFields
TracTimeline
TracUnicode
TracUpgrade
TracWiki
TracWorkflow
WikiDeletePage
WikiFormatting
WikiHtml
WikiMacros
WikiNewPage
WikiPageNames
WikiProcessors
WikiRestructuredText
WikiRestructuredTextLinks

Life-cycle of the default wiki pages

A "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/.

The 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).

Likewise, 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.

Life-cycle of the wiki pages for Trac 0.12 (LTS), and Trac 1.0

The 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.

How to keep the default wiki pages in the repository in sync with t.e.o?

  • Get the latest changes from the t.e.o wiki:
    $ cd branches/1.2-stable
    $ PYTHONPATH=. contrib/checkwiki.py -d
    
  • Inspect the changes. If there's anything that need to be fixed, change it in the t.e.o wiki and download the content again. The checkwiki script outputs a highlighted list of missing links.
  • Commit in svn.

Note 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 trac-guide Git repository and some scripts on t.e.o. Likewise, 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.

Migrating to a new major release

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 trunk. See RoadMap for details.

At 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).

Before upgrading the default Trac pages to version X, we must copy these top-level pages to the Wiki hierarchy (X-2)/... as a backup.

The upgrade to version X can then be done by copying the pages from the development hierarchy (X-1)/... to the top-level.

We have some scripting to assist with both these operations on the t.e.o. server (see HowToTracGuide in the admin wiki).

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 .

After the upgrade of the top-level pages, the (X-1)/ pages won't be touched anymore and can therefore be made read-only.

The (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.

Last modified 4 months ago Last modified on Jun 6, 2017, 12:54:37 AM

Attachments (1)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.