fix
[ikiwiki.git] / doc / tips / issue_tracking.mdwn
1 [[meta title="Integrated issue tracking with Ikiwiki"]]
2
3 By Joey Hess, LinuxWorld.com
4
5 [[template id=note text="""
6 First published on [LinuxWorld.com](http:://www.linuxworld.com/), a
7 publication of Network World Inc., 118 Turnpike Rd., Southboro, MA 01772.
8 """]]
9
10 Wikis are not just for encyclopedias and websites anymore. You can use
11 Ikiwiki in combination with your revision control system to handle issue
12 tracking, news feeds, and other needs of a software project. The wiki can
13 make your bug reports as much a part of your software project as its code,
14 with interesting results.
15
16 Ikiwiki is a wiki engine with a twist.  It's best
17 described by the term "wiki compiler". Just as a
18 typical software project consists of source code
19 that is stored in revision control and compiled with
20 `make` and `gcc`, an ikiwiki-based wiki is stored as
21 human editable source in a revision control system,
22 and built into HTML using ikiwiki.
23
24 Ikiwiki uses your revision control system to track
25 changes and handle tasks such as rolling back changes and
26 merging edits.  Because it takes advantage of revision
27 control, there are no annoying warnings about other
28 people editing a file, or finding yourself locked
29 out of a file because someone else started editing it
30 and left.  Instead, the other person's changes will
31 be automatically merged with yours when you commit.
32
33 In the rare cases where automatic merging fails
34 because of concurrent edits to the same part of a
35 page, regular commit conflict markers are shown in
36 the file to let you resolve the conflict, as you
37 would for conflicting edit in source code.
38
39 Ikiwiki is a full-featured wiki that you can use
40 for a variety of purposes, from traditional wikis
41 to weblogs, podcasting, or even aggregating other
42 sites' RSS feeds into a Planet page. While people
43 are [[using|ikiwikiusers.html]]
44 Ikiwiki for purposes ranging from genealogy research
45 to shoe accessory sales, one thing it's especially
46 well suited for is collaborative software development,
47 including announcements, documentation, managing a
48 software project's web site, and even acting as an
49 issue tracking system.
50
51 ## Building a project wiki with ikiwiki
52
53 The simplest way to use ikiwiki is to build static
54 HTML files from source wiki files. This example builds
55 a wiki for an imaginary software project.  The wiki
56 source files used in this example are available in the
57 [[examples/softwaresite]] section of ikiwiki's documentation.
58
59         wiki$ ls
60         Makefile  bugs.mdwn     doc/      download.mdwn  news/
61         bugs/     contact.mdwn  doc.mdwn  index.mdwn     news.mdwn
62         wiki$ make
63         ikiwiki `pwd` html --wikiname FooBar --plugin=goodstuff \
64                 --exclude=html --exclude=Makefile
65         wiki$ w3m -dump html/doc/faq.html
66         FooBar/ doc/ faq
67         
68         FooBar frequently asked questions.
69
70         1. Is this a real program?
71         2. Really?
72
73         _Is this a real program?_
74
75         No, it's just an example.
76
77         _Really?_
78
79         Yes, really.
80
81         Links: contact doc
82         Last edited Wed Nov 22 09:58:35 2006
83
84 If all you need is a simple static set of pages
85 that can be put up on a web site, or shipped with
86 a software package, this is a good starting point.
87 The examples included with ikiwiki include pages for
88 a news feed for the project (with RSS), an issue
89 tracker, and other pages users expect to see on a
90 project's website. You can check the wiki-format text
91 into revision control as part of the software project,
92 and tie it into the build system using the Makefile.
93
94 Ikiwiki can also be tied into the `post-commit` hook of your revision
95 control system, so that whenever a developer commits a change to a wiki
96 page in revision control, the project's web site is automatically updated.
97 The [[ikiwiki_tutorial|setup]] explains in
98 detail how to set this up using the Subversion, Git, TLA, and Mercurial
99 revision control systems.
100
101 The tutorial also explains how to configure ikiwiki so that users can edit
102 pages using a web interface, with their changes committed back into revision
103 control. After all, one of the benefits of keeping a project's docs in a wiki
104 is to make it easy for users to improve them, so that busy software developers
105 don't have to. And if the wiki is being used for issue tracking, this will
106 let users post and follow up on bug reports.
107
108 ## Using a wiki for issue tracking?
109
110 You might be wondering exactly how a wiki can be used as an issue tracking
111 system. Three key parts of ikiwiki come together to create an issue tracker:
112 pages, tags, and inlining.
113
114 Each issue is described on a separate page in the
115 wiki. There can also be an associated Discussion page,
116 as well as other related subpages that can be used
117 to hold files used to reproduce the bug, or patches,
118 or other related files. Since each issue is a page,
119 standard wiki links can be used to link related
120 issues, or link issues with other pages in the wiki.
121 Each issue has its own unique URL. Since ikiwiki
122 supports subdirectories, it's usual to keep all the
123 bugs in a `bugs/` subdirectory. You might prefer
124 to separate bugs and todo items, with todo items in
125 their own 'todo/' subdirectory.
126
127 While directories are useful for broad hierarchical
128 grouping, tags are better for categorizing issues
129 as bugs, wishlist items, security issues, patches,
130 or whatever other categories are useful. Bugs can
131 be tagged "moreinfo", "done" "unreproducible",
132 or "moreinfo", etc, to document different stages of
133 their lifecycle. A developer can take ownership of a
134 bug by tagging it with something like "owner/Joey".
135
136 To tag a wiki page, edit it and add text such as "\[[tag done]]". Note that
137 adding a wiki link to "\[[done]]" will have the same categorisation effect
138 as a tag, but the link will show up in the body of the page, which is a
139 nice effect if used in a sentence such as "This was \[[done]] in version
140 1.1.". Another way to close a bug is to move it out of the `bugs/`
141 subdirectory, though this would prevent it from showing up in a list of
142 closed bugs.
143
144 Inlining is how ikiwiki pulls individual issue pages together into
145 something larger, be it a page listing recently opened bugs (with a form to
146 let a user easily post a new bug), or a page listing recently closed bugs,
147 or an index of all bugs, or all wishlist items, or RSS feeds for any of
148 these. A flexible syntax is used for specifying what kind of pages should
149 be inlined into a given page. A few examples:
150
151 * A typical list of all open bugs, with their full text, and a form to post new
152   bugs.
153
154         \[[inline pages="bugs/* and !link(done) and !*/Discussion" actions=yes postform=yes show=0]]
155
156 * Index of the 30 most recently fixed bugs.
157
158         \[[inline pages="bugs/* and link(done) and !*/Discussion" sort=mtime show=30 archive=yes]]
159
160 * Index of the 10 most recently active bugs.
161
162         \[[inline pages="bugs/* and !link(done) and !*/Discussion" sort=mtime show=10]]
163
164 * Open security issues.
165
166         \[[inline pages="bugs/* and link(security) and !link(done) and !*/Discussion"]]
167
168 * Full text of bugs assigned to Joey.
169
170         \[[inline pages="bugs/* and link(owner/Joey) and !link(done) and !*/Discussion" show=0]]
171
172 It may seem strange to consider using a wiki for issue tracking when there
173 are several dedicated bug tracking systems, like Bugzilla, that handle all
174 aspects of it already. The weakest part of using ikiwiki for issue
175 tracking, and certainly the place where a dedicated bug tracker like
176 Bugzilla shines in comparison, is storing and querying structured data
177 about bugs. Ikiwiki has little structured data except for page filenames
178 and tags, so if you need lots of queryable data such as what versions a bug
179 affects and what version it was fixed in, ikiwiki may not be a good fit for
180 your issue tracking. 
181
182 On the other hand, by using a wiki for issue
183 tracking, there is one less system for users and
184 developers to learn, and all the flexibility of a
185 wiki to take advantage of. Ikiwiki even supports
186 [OpenID](http://openid.net/), so it's easy for users
187 to use it for filing bugs without going through an
188 annoying registration process.
189
190 Developers who work offline, or at the other end of a
191 slow connection, might appreciate having a full copy
192 of the project bug tracking system, too.
193
194
195 ## Benefits
196
197 Realistically, there are plusses and minuses to letting users edit a
198 software project's documentation in a wiki. Like any wiki, to be
199 successful, some review is needed of the changes users make. In some cases
200 it will be easiest to limit the pages that users are allowed to edit.
201 Still, keeping the wiki open for user edits will probably turn up some
202 passionate users who prove very useful at filling in holes in the
203 documentation and cleaning up the site.
204
205 Programmers are supposed to be bad at writing documentation, and putting a
206 project's docs into a wiki might not solve that. But it can make it a
207 little bit easier. Consider a programmer who's just coded up a new feature.
208 He can commit that to a development branch in revision control, and then go
209 update the docs on the web site to document it. But the feature isn't
210 available in a released version yet, so it's probably easier to skip
211 updating the website. Maybe once it's released, the web site will be
212 updated to mention the feature, but maybe (probably) not.
213
214 Now consider what happens if instead the web site is a wiki that has its
215 source included in the project's revision control system. The programmer
216 codes up the feature, and can easily update the docs in the wiki to match.
217 When he commits his changes to a development branch, the docs are committed
218 too. Later, when that change is merged to the release branch, the doc
219 changes are also merged, and automatically go live on the web site.
220 Updating the documentation to reflect each change made and publishing it on
221 the website has become a standard part of the programmer's workflow.
222
223 But this still requires programmers to write documentation, so maybe it
224 still won't work. Let's go back a step. Before the programmer wrote that
225 feature, he probably got some requests for it, and maybe he developed those
226 into a specification for how the feature should work. Since ikiwiki can be
227 used as an issue tracker, the requests were made using it, and were
228 collaboratively edited on the wiki, to develop the specification. Once the
229 feature is implemented, that issue can be closed. What better way to close
230 it than to move it out of the issue tracking system, and into the project's
231 documentation?  In Subversion:
232
233         svn mv wiki/bugs/new_feature.mdwn wiki/doc/
234
235 If the spec is written well enough to be useful for end user documentation,
236 the programmer doesn't have to write a lot of docs after all; that was done
237 when the feature was designed. By using ikiwiki for issue tracking, plus
238 editing the spec, plus documentation, plus the website, each of these steps
239 has built on the other and the programmer has had to do less busywork.
240
241 A different example of how ikiwiki can tie
242 things together is how a security hole might be
243 handled. First it's discovered, and a bug filed about
244 it. When it's fixed, the commit that fixes the bug
245 can include a change to the bug's page, marking it
246 as done. Since it's a security hole, the project
247 needs to make an announcement right away so users
248 will know they need to upgrade. This announcement
249 can be added to the wiki's news feed, and committed
250 along with the fix, and the announcement can use a
251 regular wiki link to link to the bug that describes
252 the security hole in detail. If the security hole
253 also affects an older version of the software, the
254 fix, along with the wiki documentation for that fix,
255 can be merged into the branch for the older version.
256
257 Another benefit of keeping the bug tracking system in revision control with
258 the wiki is that it allows for disconnected development. So there's no need
259 to be online to review the project's bug list, and there's no need to
260 remember to close fixed bugs once you're back online.
261
262 For fans of distributed revision control, ikiwiki opens even more
263 possibilities. With a project's website and issue tracker kept in
264 distributed revision control with the project, these become distributed as
265 well, rather than centralized appendixes to the project. Developers can
266 pass around changesets that not only fix bugs, but mark them as done. If
267 large changes are being made in someone's branch, they can choose to put up
268 their own version of the website, use it to track bugs for that branch, and
269 when the branch is ready, all these changes can be merged back into the
270 mainline of the project.
271
272 Ikiwiki powers its own bug tracking system.  To see how wiki bug tracking
273 works in practice, visit the [[bugs]] or [[TODO]] pages.