Prepare documentation for 0.11

[Christian Boos]

First, we should backup the existing Trac* pages belonging to the TracGuide, into a 0.10/ hierarchy. E.g. TracGuide → 0.10/TracGuide.

Current state:

• 0.10/TracAdmin
• 0.10/TracGuide
• 0.10/TracIni
• 0.10/TracInstall
• 0.10/TracInterfaceCustomization
• 0.10/TracOnWindows
• 0.10/TracPermissions
• 0.10/TracPlugins
• 0.10/TracUpgrade
• 0.10/WikiMacros

Then, we should update the TracGuide for 0.11.For that, we should start with a page using the 0.11/ prefix. When satisfied with the result and the 0.11 release getting nearer, we should copy their content to their corresponding default page.

Current state:

• 0.11/TracAdmin
• 0.11/TracBrowser
• 0.11/TracEnvironment
• 0.11/TracGuide
• 0.11/TracImport
• 0.11/TracIni
• 0.11/TracInstall
• 0.11/TracInterfaceCustomization
• 0.11/TracLinks
• 0.11/TracMacros
• 0.11/TracNotification
• 0.11/TracOnUbuntu
• 0.11/TracPermissions
• 0.11/TracQuery
• 0.11/TracReports
• 0.11/TracRoadmap
• 0.11/TracStandalone
• 0.11/TracSyntaxColoring
• 0.11/TracTimeline
• 0.11/TracUpgrade
• 0.11/TracWiki
• 0.11/TracWorkflow
• 0.11/WikiDeletePage
• 0.11/WikiFormatting
• 0.11/WikiHtml
• 0.11/WikiMacros
• 0.11/WikiNewPage
• 0.11/WikiPageNames
• 0.11/WikiProcessors

[anonymous]

[[TracGuideToc]]

is not correct in e.g. in wiki:0.10/TracIni

[martin.marcher@…]

Please see

• ticket:5274
• wiki:Trac0.11 wiki:0.11 (TitleIndex for the docs is there)

[ThurnerRupert]

added further documents to wiki:0.11, see also wiki/0.11/TracGuide.

[ThurnerRupert]

wiki:0.11/TracGuide that is …

[Christian Boos]

#6186 marked as duplicate.

There were a few discussions about this topic on either trac-dev or on trac-users. If I recall correctly:

• the 0.9/*, 0.10/* and 0.11/* pages should contain version specific documentations
• the toplevel pages should contain the main contributed docs, which usually cover the range of currently in use versions

Therefore, before the 0.11 release, we should "branch" the Wiki into the 0.11/ pages, eventually merge it with the documentation already in place and finally "prune" the non-relevant content.

Then, we push all these pages into the trac/wiki/default-pages.

[ilias@…]

Replying to cboos:

#6186 marked as duplicate.

There were a few discussions about this topic on either trac-dev or on trac-users. If I recall correctly:

• the 0.9/*, 0.10/* and 0.11/* pages should contain version specific documentations

ok, this would mean, that e.g.

wiki:0.11/TracInterfaceCustomization

should not contain documentation subjecting 0.9 ?

• the toplevel pages should contain the main contributed docs, which usually cover the range of currently in use versions

e.g. wiki:0.11 contains the list of pages specific to 0.11

Therefore, before the 0.11 release, we should "branch" the Wiki into the 0.11/ pages, eventually merge it with the documentation already in place and finally "prune" the non-relevant content.

Then, we push all these pages into the trac/wiki/default-pages.

if I understand right, the pages listed in wiki:0.11 (e.g. wiki:0.11/TracInterfaceCustomization) will go finally into the repository 0.11 (wiki default pages)

all this sounds ok.

but doesn't this mean, that the following part from wiki:0.11/TracInterfaceCustomization should be removed?

 Note: in projects created with a Trac version prior to 0.9 you will need
 to create this folder.

[ilias@…]

I've found ​this thread here, but cannot understand.

Possibly one should write the process down in the wiki, thus I know how to proceed to cleanup the 0.11 documentation.

• do I file tickets, and the team changes in the repo?
• or do I edit the onlie 0.11/ docu?

see additionally #6181 for a concrete example.

[Christian Boos]

Critical part of the documentation to update ASAP: wiki:TracDev/ApiChanges/0.11

[Christian Boos]

Changed prefix from Trac0.x/ to 0.x/