]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/todo/Updated_bug_tracking_example.mdwn
Add updated bug tracking example.
[git.ikiwiki.info.git] / doc / todo / Updated_bug_tracking_example.mdwn
1 I've put together an updated bug tracking example.  This example requires some recent
2 patches of mine.  It requires [[todo/tracking_bugs_with_dependencies]], 
3 [[todo/Default_text_for_new_pages]] and the second [[patch]] in
4 [[todo/structured_page_data]] (the data plugin, not the form plugin).
6 You'll then want to add/replace the following files in the software project example.  The
7 heading is the name of the file.  I've commented all the directives.  Oh, and I don't
8 have nice CSS for this yet. I did make sure that if I borrowed
9 [Trac's](http://trac.edgewall.org/) css then it would display as nicely as theirs - the
10 html is there if not the CSS.
12 ### templates/bug.mdwn
14     \[[!datatable class="bugtable" datalist="""
15     [[!data key="Reported by" link=""]]                                 [[!data key="Owned by" link=""]]
16     [[!data key="Depends on"]]
17     """]]
18     
19     ### Description
20     
21     This is a bug that needs solving.
22     
23     #### Steps to reproduce:
24     
25     #### What I expect to happen:
26     
27     #### What actually happens:
28     
29     #### What I have tried to narrow it down:
30     
31 ### bugs.mdwn
33     This is FooBar's bug list. Link bugs to \[[bugs/done]] when done.
34     
35     \[[!inline pages="bugs and ! bugs" feeds=no postformtext="Report a bug:"
36     postform=yes rootpage="./blog" newposttemplate="templates/bug.mdwn"]]
37     
38     \[[!toggle id="all bugs" text="Show all bugs"]]
39     
40     \[[!toggle id="open bugs" text="Show open bugs"]]
41     
42     \[[!toggle id="ready bugs" text="Show ready bugs (open bugs with all dependencies closed)"]]
43     
44     \[[!toggleable id="ready bugs" text="""
45     #### Ready Bugs
46     
47     Open bugs with all dependencies closed.
48     
49     [[!inline pages="define(~open, ./bugs/* and !./bugs/done and !link(done) and !*/Discussion)
50     and ~open and !data_link(Depends on,~open)" actions=yes archive=yes show=0]]
51     """]]
52     
53     \[[!toggleable id="open bugs" text="""
54     #### Open Bugs
55     
56     [[!inline pages="./bugs/* and !./bugs/done and !link(done) 
57     and !*/Discussion" actions=yes archive=yes show=0]]
58     """]]
59     
60     \[[!toggleable id="all bugs" text="""
61     #### All Bugs
62     
63     [[!inline pages="./bugs/* and !./bugs/done and !*/Discussion"
64     actions=yes archive=yes show=0]]
65     """]]
66     
67 ### bugs/needs_more_bugs.mdwn
69     \[[!datatable class="bugtable" datalist="""
70     [[!data key="Reported by" link="John"]]                                     [[!data key="Owned by" link="Frank"]]
71     [[!data key="Depends on" link="bugs/fails_to_frobnicate"]]
72     """]]
73     
74     ### Description
75     
76     FooBar does not have enough bugs, which suggests that it's not a real Free
77     Software project. Please help create more bugs by adding code to FooBar!
78     :-)
79     
80     #### Steps to reproduce:
81     
82     Test frobnicate.
83     
84     #### What I expect to happen:
85     
86     It should fail.
87     
88     #### What actually happens:
89     
90     It works.
91     
92     #### What I have tried to narrow it down:
93     
94     I've added some code, but I'm not sure it was the right code.
96 ### bugs/fails_to_frobnicate.mdwn
98     \[[!datatable class="bugtable" datalist="""
99     [[!data key="Reported by" link="John"]]                                     [[!data key="Owned by" link="Frank"]]
100     [[!data key="Depends on"]]
101     """]]
102     
103     ### Description
104     
105     FooBar, when used with the `--frob` option, fails to properly frobnicate
106     output.
107     
108     > This is fixed in \[[news/version_1.0]]; marking this bug \[[done]].
109     
110     #### Steps to reproduce:
111     
112     Use FooBar with the `--frob` option.
113     
114     #### What I expect to happen:
115     
116     Lots of frobnication.
117     
118     #### What actually happens:
119     
120     Complete lack of frobnication
121     
122     #### What I have tried to narrow it down:
123     
124     Tested on Linux, MacOS and NetBSD.