Version 2 (modified by 14 years ago) ( diff ) | ,
---|
TracGuide for 0.12
This part of the wiki is dedicated to the preparation of the TracGuide for the 0.12 release.
Pages currently specific to 0.12:
- 0.12/CamelCase
- 0.12/InterMapTxt
- 0.12/InterTrac
- 0.12/InterWiki
- 0.12/PageTemplates
- 0.12/RecentChanges
- 0.12/TitleIndex
- 0.12/TracAccessibility
- 0.12/TracAdmin
- 0.12/TracBackup
- 0.12/TracBrowser
- 0.12/TracCgi
- 0.12/TracChangeset
- 0.12/TracEnvironment
- 0.12/TracFaq
- 0.12/TracFastCgi
- 0.12/TracFineGrainedPermissions
- 0.12/TracGuide
- 0.12/TracImport
- 0.12/TracIni
- 0.12/TracInstall
- 0.12/TracInterfaceCustomization
- 0.12/TracLinks
- 0.12/TracLogging
- 0.12/TracModPython
- 0.12/TracModWSGI
- 0.12/TracNavigation
- 0.12/TracNotification
- 0.12/TracPermissions
- 0.12/TracPlugins
- 0.12/TracQuery
- 0.12/TracReports
- 0.12/TracRepositoryAdmin
- 0.12/TracRevisionLog
- 0.12/TracRoadmap
- 0.12/TracRss
- 0.12/TracSearch
- 0.12/TracStandalone
- 0.12/TracSupport
- 0.12/TracSyntaxColoring
- 0.12/TracTickets
- 0.12/TracTicketsCustomFields
- 0.12/TracTimeline
- 0.12/TracUnicode
- 0.12/TracUpgrade
- 0.12/TracWiki
- 0.12/TracWorkflow
- 0.12/TranslationDe/TracGuide
- 0.12/TranslationDe/TracQuery
- 0.12/TranslationDe/TracTickets
- 0.12/TranslationDe/TracWiki
- 0.12/TranslationDe/WikiFormatting
- 0.12/TranslationFr/TracGuide
- 0.12/TranslationRu/CamelCase
- 0.12/TranslationRu/PageTemplates
- 0.12/TranslationRu/TracAdmin
- 0.12/TranslationRu/TracBrowser
- 0.12/TranslationRu/TracGuide
- 0.12/TranslationRu/TracInstall
- 0.12/TranslationRu/TracLinks
- 0.12/TranslationRu/TracLogging
- 0.12/TranslationRu/TracNotification
- 0.12/TranslationRu/TracOnWindowsIis6
- 0.12/TranslationRu/TracRoadmap
- 0.12/TranslationRu/TracRss
- 0.12/TranslationRu/TracSyntaxColoring
- 0.12/TranslationRu/TracTickets
- 0.12/TranslationRu/TracTimeline
- 0.12/TranslationRu/TracUnicode
- 0.12/TranslationRu/TracUpgrade
- 0.12/TranslationRu/TracWiki
- 0.12/TranslationRu/WikiDeletePage
- 0.12/TranslationRu/WikiFormatting
- 0.12/TranslationRu/WikiMacros
- 0.12/TranslationRu/WikiNewPage
- 0.12/TranslationRu/WikiPageNames
- 0.12/TranslationRu/WikiRestructuredText
- 0.12/WikiDeletePage
- 0.12/WikiFormatting
- 0.12/WikiHtml
- 0.12/WikiMacros
- 0.12/WikiNewPage
- 0.12/WikiPageNames
- 0.12/WikiProcessors
- 0.12/WikiRestructuredText
- 0.12/WikiRestructuredTextLinks
Review Guidelines
- mark.m.mcmahon:
Would you suggest the following:
- Review the diff for each page that was copied (spelling, grammar, technical)
- Review the page as a whole, formatting, etc
- cboos: Indeed, that would be my preferred way.
Spelling and grammar fixes should be done straight ahead, no need to discuss them
of course, the same for formatting fixes I suppose.
Suggestions for documentation changes, additions or clarifications (or simplifications!)
could be done in a variety of ways, just be creative! For example:
- add a
=== Discussion
section at the bottom, with your remarks or additions - add
#!div
in place with some distinctive style, e.g.{{{#!div style="background:#efe" Addition: / Rewrite: / ... }}}
Addition: / Rewrite: / …
- in place italics may not stand out distinctive enough from the original documentation,
you could use
[[span(style=background:#efe, Also mention...)]]
Also mention… - … or much simpler, none of the above, just boldly change the documentation if you think you can make an improvement (we'll notice the change and review the differences anyway)
- add a
- cboos: Indeed, that would be my preferred way.
Spelling and grammar fixes should be done straight ahead, no need to discuss them
of course, the same for formatting fixes I suppose.
Suggestions for documentation changes, additions or clarifications (or simplifications!)
could be done in a variety of ways, just be creative! For example:
- does it make sense to log a bitesize, documentation bug for each doc review task?
- cboos: I don't think so, I think it'll be more effective to collaborate on the document in place
- rblank: I would suggest starting with the pages under 0.12, proofread whole pages (spelling, grammar, consistency, obsolete text) and fix things as you go along. You may want to open a single "Documentation review" ticket to document your progress for others potential reviewers (and get attribution!).
Note:
See TracWiki
for help on using the wiki.