X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/57ce8898f6f463e2c08d7efbacc9924326e1d5fb..9e28f4b33feacca4f6c371f3885da7bd946a899b:/doc/tips/issue_tracking.mdwn diff --git a/doc/tips/issue_tracking.mdwn b/doc/tips/issue_tracking.mdwn index c3ae7272b..a39b93656 100644 --- a/doc/tips/issue_tracking.mdwn +++ b/doc/tips/issue_tracking.mdwn @@ -3,8 +3,9 @@ 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 @@ -18,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 @@ -34,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|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, @@ -54,7 +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]] section of ikiwiki's documentation. +[[examples/softwaresite|examples/softwaresite]] section +of ikiwiki's documentation. wiki$ ls Makefile bugs.mdwn doc/ download.mdwn news/ @@ -91,7 +93,7 @@ project's website. You can check the wiki-format text into revision control as part of the software project, and tie it into the build system using the Makefile. -Ikiwiki can also be tied into the `post-commit` hook of your revision +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|setup]] explains in @@ -128,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". @@ -270,4 +272,4 @@ 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 [[bug]] or [[TODO]] pages. +works in practice, visit the [[bugs]] or [[TODO]] pages.