X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/e2dddb9db5246274e409ddfc06c9261d489d7701..92fbaf377ed5c707a2e8ac13de4126930cb2058b:/doc/tips/issue_tracking.mdwn diff --git a/doc/tips/issue_tracking.mdwn b/doc/tips/issue_tracking.mdwn index 5167c1384..8f08bc692 100644 --- a/doc/tips/issue_tracking.mdwn +++ b/doc/tips/issue_tracking.mdwn @@ -3,16 +3,15 @@ By Joey Hess, LinuxWorld.com [[template id=note text=""" -First published on [LinuxWorld.com](http:://www.linuxworld.com/), a -publication of Network World Inc., 118 Turnpike Rd., Southboro, MA 01772. +[First published](http://www.linuxworld.com/news/2007/040607-integrated-issue-tracking-ikiwiki.html) +on [LinuxWorld.com](http:://www.linuxworld.com/), a publication of Network +World Inc., 118 Turnpike Rd., Southboro, MA 01772. """]] -Wikis are not just for encyclopedias and websites -anymore. You can use [Ikiwiki](http://ikiwiki.info) -in combination with your revision control system to -handle issue tracking, news feeds, and other needs of -a software project. The wiki can make your bug reports -as much a part of your software project as its code, +Wikis are not just for encyclopedias and websites anymore. You can use +Ikiwiki in combination with your revision control system to handle issue +tracking, news feeds, and other needs of a software project. The wiki can +make your bug reports as much a part of your software project as its code, with interesting results. Ikiwiki is a wiki engine with a twist. It's best @@ -20,7 +19,7 @@ described by the term "wiki compiler". Just as a typical software project consists of source code that is stored in revision control and compiled with `make` and `gcc`, an ikiwiki-based wiki is stored as -human editable source in a revision control system, +human-editable source in a revision control system, and built into HTML using ikiwiki. Ikiwiki uses your revision control system to track @@ -36,13 +35,13 @@ In the rare cases where automatic merging fails because of concurrent edits to the same part of a page, regular commit conflict markers are shown in the file to let you resolve the conflict, as you -would for conflicting edit in source code. +would for conflicting edits in source code. Ikiwiki is a full-featured wiki that you can use for a variety of purposes, from traditional wikis to weblogs, podcasting, or even aggregating other sites' RSS feeds into a Planet page. While people -are [using](http://ikiwiki.info/ikiwikiusers.html) +are [[using|ikiwikiusers]] Ikiwiki for purposes ranging from genealogy research to shoe accessory sales, one thing it's especially well suited for is collaborative software development, @@ -56,8 +55,8 @@ The simplest way to use ikiwiki is to build static HTML files from source wiki files. This example builds a wiki for an imaginary software project. The wiki source files used in this example are available in the -[examples/softwaresite](http://ikiwiki.info/examples/softwaresite.html) -section of ikiwiki's documentation. +[[examples/softwaresite|examples/softwaresite]] section +of ikiwiki's documentation. wiki$ ls Makefile bugs.mdwn doc/ download.mdwn news/ @@ -97,7 +96,7 @@ and tie it into the build system using the Makefile. Ikiwiki can also be tied into the `post-commit` hook of your revision control system, so that whenever a developer commits a change to a wiki page in revision control, the project's web site is automatically updated. -The [ikiwiki tutorial](http://ikiwiki.info/setup.html) explains in +The [[ikiwiki_tutorial|setup]] explains in detail how to set this up using the Subversion, Git, TLA, and Mercurial revision control systems. @@ -131,8 +130,8 @@ While directories are useful for broad hierarchical grouping, tags are better for categorizing issues as bugs, wishlist items, security issues, patches, or whatever other categories are useful. Bugs can -be tagged "moreinfo", "done" "unreproducible", -or "moreinfo", etc, to document different stages of +be tagged "moreinfo", "done", "unreproducible", +etc, to document different stages of their lifecycle. A developer can take ownership of a bug by tagging it with something like "owner/Joey". @@ -154,23 +153,23 @@ be inlined into a given page. A few examples: * A typical list of all open bugs, with their full text, and a form to post new bugs. - \[[inline pages="bugs/* and !link(done) and !*/Discussion" actions=yes postform=yes show=0]] + \[[inline pages="bugs/* and !link(done) and !*/Discussion" actions=yes postform=yes show=0]] * Index of the 30 most recently fixed bugs. - \[[inline pages="bugs/* and link(done) and !*/Discussion" sort=mtime show=30 archive=yes]] + \[[inline pages="bugs/* and link(done) and !*/Discussion" sort=mtime show=30 archive=yes]] * Index of the 10 most recently active bugs. - \[[inline pages="bugs/* and !link(done) and !*/Discussion" sort=mtime show=10]] + \[[inline pages="bugs/* and !link(done) and !*/Discussion" sort=mtime show=10]] * Open security issues. - \[[inline pages="bugs/* and link(security) and !link(done) and !*/Discussion"]] + \[[inline pages="bugs/* and link(security) and !link(done) and !*/Discussion"]] * Full text of bugs assigned to Joey. - \[[inline pages="bugs/* and link(owner/Joey) and !link(done) and !*/Discussion" show=0]] + \[[inline pages="bugs/* and link(owner/Joey) and !link(done) and !*/Discussion" show=0]] It may seem strange to consider using a wiki for issue tracking when there are several dedicated bug tracking systems, like Bugzilla, that handle all @@ -272,8 +271,5 @@ their own version of the website, use it to track bugs for that branch, and when the branch is ready, all these changes can be merged back into the mainline of the project. -Ikiwiki powers its own bug tracking -system. To see how wiki bug tracking -works in practice, visit the [ikiwiki bugs -page](http://ikiwiki.info/bugs.html) or the project -[TODO list](http://ikiwiki.info/todo.html). +Ikiwiki powers its own bug tracking system. To see how wiki bug tracking +works in practice, visit the [[bugs]] or [[TODO]] pages.