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