137631 - status workflow diagram

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect, P3)

Description

[John Vandenberg]

A bugzilla status/workflow diagram would be a useful addition to the Bugzilla
documentation.  As well as being a reference for existing Bugzilla users, it
would serve as a simple way of comparing Bugzilla to an existing bug tracking
system, as most proprietary/inhouse systems will have an equivalent diagram.

Comment 1

[John Vandenberg]

Attachment: Graphviz status graph

I am not sure this is completely correct, but it should serve as a guide.

Comment 2

[John Vandenberg]

Attachment: workflow.png - GraphViz output

Comment 3

[GavinS]

I think it is also possible to go from verified -> reopened, yes?

I'm guessing that when customisable resolutions arrive, it will be possible to
auto-generate this workflow diagram??

Comment 4

[John Vandenberg]

Attachment: workflow.pl

Thanks for pointing that out.  This perl script uses the GraphViz perl module
to generate the dot/png file.

I am sure that this will allow the diagram to be updated to reflect custom
status/resolutions.

Comment 5

[Andreas Franke (gone)]

I think 'Reopen' is not ASSIGNED -> ASSIGNED , but instead these two:

NEW -> NEW
ASSIGNED -> NEW

Comment 6

[David D. Kilzer (ddk)]

Reassigning bugs from [e-mail] to
[e-mail].

Comment 7

[Matthew Barnson]

Erm, I'm not exactly sure what to do with this.  Should it just be checked into
the docs area, or am I supposed to use workflow.pl to create a graph to include
with the documentation?

Comment 8

[Alfred Spalt]

The graph in the attachment "workflow.png" is incomplete and has a wrong edge 
from ASSIGNED to ASSIGNED. I drew a complete state diagram for Bugzilla V2.12 
and will attach it at PNG and VSD (if anybody wants to edit it).
Concerning Matthew's question: 
Yes, please include it in the html-documentation of Bugzilla.

Comment 9

[Alfred Spalt]

Attachment: statechart bugzilla as PNG

Comment 10

[Alfred Spalt]

Attachment: statechart bugzilla as VSD (Visio)

Comment 11

[Matthew Barnson]

This is on my radar to put in; I don't have a "workflow" section to the Guide
yet, so there's no great spot to put it that it won't stick out.  I'm thinking
and writing and reorganizing though, it's not forgotten!

Comment 12

[Dave Miller [:justdave]]

Matthew is still going to be around to help out, but Jake is taking over the
day-to-day front-line triage type stuff for Documentation

Comment 13

[Dave Miller [:justdave]]

Jake is leaving for a while (Reserve unit got called up), and we don't have a
new docs owner yet.  Anyone interested in helping out, please add
[e-mail] to your watch list in your email preferences in Bugzilla.

Comment 14

[Max Kanat-Alexander]

Attachment: Another static statechart

Here's another state flow we got on the developer's list. I believe the
original contributor was Arun Kumar. Does he have a Bugzilla account?

I also have a very pretty statechart that I made for my local installation,
complete with explanations, but it's for a modified set of resolutions and
policies than b.m.o uses.

It would be good if we could get the source of this attachment, so that we
could edit it ourselves.

Comment 15

[Gervase Markham [:gerv]]

It's not quite correct - for example, bugs can be filed directly as NEW. But
it's cool to have.

Gerv

Comment 16

[Arun]

Attachment: Visio Source for Attachment #144498

Comment 17

[Arun]

(In reply to comment #14)
> It would be good if we could get the source of this attachment, so that we
> could edit it ourselves.
Let me know if I can help in modifying the source to accomodate the changes you 
are looking for.

Comment 18

[Max Kanat-Alexander]

The greatest problem is that there are *no* Visio viewers or editors for Linux,
that I know of. Is there any compatible format that we could get it in, like an
SVG or something?

Comment 19

[Max Kanat-Alexander]

Oh, Arun wasn't on the CC list. :-) Arun, read my last comment. :-)

Comment 20

[Arun]

(In reply to comment #18)
> The greatest problem is that there are *no* Visio viewers or editors for 
Linux,
> that I know of. Is there any compatible format that we could get it in, like 
an
> SVG or something?
Yeah, I know. I did it on my work PC [don't have linux on it :( ]. And Visio 
doensn't support exporting into SVG.

If it's a problem, I can redo this in Dia (Linux at home :)) using Dia. Just 
let me know.

Comment 21

[Max Kanat-Alexander]

Yeah, let's try to get it in Dia, so that other contributors (most of whom are
using *nix) could edit it in the future. In the mean time, we can put the jpeg
statechart as an image into the docs.

I think it might be really helpful on queryhelp.cgi, too.

Comment 22

[Dave Miller [:justdave]]

Wow, this has been a while...  any progress on getting this in Dia format?

Comment 23

[Jacob Steenhagen]

Attachment: Produced with dia

Dia actually isn't that hard to use... I just installed it today and produced
this image. I have one of those sneaking suspisions that I missed something,
but here's a PNG. Once we're sure it's complete, I'll upload the project file.

Comment 24

[Jacob Steenhagen]

FWIW, I do like the progmatically generated one, too. It will be extra useful if
we ever get around to including custom statuses :).

Comment 25

[Gervase Markham [:gerv]]

That's cool, but for it to be useful perhaps the arrows need descriptive labels?

Gerv

Comment 26

[Jacob Steenhagen]

Attachment: Dia v2: Added descriptive labels.

Comment 27

[Jacob Steenhagen]

Attachment: Dia v3: Noticed the missing RESOLVED -> UNCONFIRMED path

Comment 28

[Jacob Steenhagen]

Attachment: Dia source for attachment 168524

Haven't been any negative comments on this so I'll assume that you're ready for
the Dia XML file (note, I didn't save in compressed format so that it would
make sence for cvs diff).

Comment 29

[Jacob Steenhagen]

Attachment: Documentation Patch

This patch adds the aforementioned image to the docs (as well as a link to the
XML Source).

It requires that attachment 168524 [details] and attachment 168682 [details] be in your "images"
directory.

Comment 30

[Jacob Steenhagen]

Comment on attachment 168686 [details] [diff] [review]
Documentation Patch

>+          <imagedata fileref="../images/bzLifecycle.png" scale="66" />

I feel the need to explain this line. I originally tried it w/out any scale.
When I generated the PDF file, the image was quite a bit bigger than the page,
even though every bit of mental comparison told me that it should be about the
same size as an 8.5x11 sheet of paper and probably a little smaller. It also
looked horrible, which told me that it was being scaled by the PDF engine and
not actually included at 100% scale (which is what the docs seem to imply:
http://www.docbook.org/tdg/en/html/imagedata.html). Anyway, I decided to
consult Google and found a website where they stated that images all seem to be
25% larger when included in a PDF for no apparent reason. Their recomendation
was to scale at 66%, which works great :).

On my local DocBook setup, the PDF generated w/out this patch is 707k and with
it is 740k.

Comment 31

[Shane H. W. Travis]

Two things missing on attachment 168524 [details] -- you forgot LATER and REMIND as 
possible resolutions. Fix that, and r+ on the diagram itself.

I know that this is the 'using' section, but perhaps you could use this 
omission as a springboard for a short comment in the actual documentation 
patch: you mention that the flow is hardcoded, but you could also mention that 
some changes are easier than others (like adding/removing resolutions, a la 
what has been done on bmo). That's a suggestion/nit, though, and will not 
prevent r+ of the patch once the diagram is fixed.

Nice work -- been needed for a long time. Good job everyone who contributed to 
it, and thanks to Jake for bringing it in for a landing!

Comment 32

[Jacob Steenhagen]

Attachment: Dia v4: Add LATER and REMIND resolutions

Bug 193242 is about adding documentation for (among other things) customizing
resolutions. When that is fixed, an <xref/> should be added to this section to
those instructions.

An r= for attachment 168686 [details] [diff] [review] will be considered an r= for this file, too (as
it's a required part of the doc patch).

Comment 33

[Jacob Steenhagen]

Attachment: Dia source for attachment 169032

An r= for attachment 168686 [details] [diff] [review] will also be considered an r= for this file as it
is linked from attachment 1168686 and the source used to generate attachment
169032 [details].

Comment 34

[Shane H. W. Travis]

Comment on attachment 168686 [details] [diff] [review]
Documentation Patch

+      repsentation of this life cycle. If you wish customize this image for

"... if you wish *to* customize..."

The above is trivial and can be fixed on check-in; other than that, the patch
now looks complete and ready to go. 

I would have one concern that you're putting a diagram in the middle of what is
otherwise HTML/text-only documentation. The one other place that we have a
diagram (the database schema) it's in its own appendix. I think that this might
be worthy of its own appendix too, and would ask that you consider putting it
into one... but I don't feel strongly enough about it to deny an r+ to an
otherwise fine (and needed) patch. 

Good job, Jake!

Comment 35

[Jacob Steenhagen]

(In reply to comment #34)
> "... if you wish *to* customize..."

Oops :)

> I would have one concern that you're putting a diagram in the middle of what is
> otherwise HTML/text-only documentation. The one other place that we have a
> diagram (the database schema) it's in its own appendix. I think that this might
> be worthy of its own appendix too, and would ask that you consider putting it
> into one... but I don't feel strongly enough about it to deny an r+ to an
> otherwise fine (and needed) patch. 

Truth be told, I personally have no objection to images being used elsewhere in
the guide where it's appropriate. Besides, if we ever get the guide published as
a book, you need to have a figure or two in the mix ;).

Fixed in tip, 2.18, and 2.16 (even though it's a slightly different place).

RCS file: /cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.png,v
done
Checking in images/bzLifecycle.png;
/cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.png,v  <-- 
bzLifecycle.png
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.xml,v
done
Checking in images/bzLifecycle.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.xml,v  <-- 
bzLifecycle.xml
initial revision: 1.1
done
Checking in xml/using.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/using.xml,v  <--  using.xml
new revision: 1.25; previous revision: 1.24
done



Checking in xml/using.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/using.xml,v  <--  using.xml
new revision: 1.21.2.4; previous revision: 1.21.2.3
done
Checking in images/bzLifecycle.png;
/cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.png,v  <-- 
bzLifecycle.png
new revision: 1.1.2.1; previous revision: 1.1
done
Checking in images/bzLifecycle.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.xml,v  <-- 
bzLifecycle.xml
new revision: 1.1.2.1; previous revision: 1.1
done



Checking in images/bzLifecycle.png;
/cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.png,v  <-- 
bzLifecycle.png
new revision: 1.1.4.1; previous revision: 1.1
done
Checking in images/bzLifecycle.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/images/bzLifecycle.xml,v  <-- 
bzLifecycle.xml
new revision: 1.1.4.1; previous revision: 1.1
done
Checking in xml/using.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/using.xml,v  <--  using.xml
new revision: 1.10.2.9; previous revision: 1.10.2.8
done

Comment 36

[Nicolas VERITE]

Attachment: Colorized PNG version of the Buzilla workflow

The Dia version is a real mess when opened in Inkscape, but I think I can do it, so that this workflow is available in SVG format. Here is the PNG version (colorization is funky).

Comment 37

[Max Kanat-Alexander]

> The Dia version is a real mess when opened in Inkscape, but I think I can do
> it, so that this workflow is available in SVG format. Here is the PNG version
> (colorization is funky).

  Nice! Could you attach this to a new bug?

Comment 38

[Nicolas VERITE]

Attachment: SVG version of a colored lifecycle

Here a SVG version of the colorized Bugzilla lifecycle.

It's been re-designed by Inkscape, Aqua-ified, there is a spelling mistake fix, and some texts have been relocated.

Comment 39

[Nicolas VERITE]

Attachment: PNG version of the SVG version of a colored lifecycle

...and its PNG sister.