201415 - Remove the Introduction (Chapter 2) chapter

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect, P4)

Description

[Jacob Steenhagen]

The second chapter of the Bugzilla guide, which seems to be the advertising
chapter :), is in need of a little love. Some of the information may be outdated
and some may need to simply be reworded for clarity (or maybe it's perfect?).

Comment 1

[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 2

[Dave Miller [:justdave]]

Preliminarily moving all docs bugs to 2.18, we should make a valiant attempt to
have the docs as up-to-date as possible when 2.18 releases.

Comment 3

[Frédéric Buclin]

Colin, introduction.xml is not included in the documentation, and not even compiled, at least on 3.1.2. Maybe should we remove it from CVS? I didn't check in older releases though.

Comment 4

[Frédéric Buclin]

Bugzilla 2.20 is no longer supported. Retargetting to 2.22.

Comment 5

[Frédéric Buclin]

As I said in comment 3, introduction.xml is no longer compiled since 2.17.7 since a checkin made by gerv (with no bug ID as reference, grrr):

http://bonsai.mozilla.org/cvsview2.cgi?diff_mode=context&whitespace_mode=show&root=/cvsroot&subdir=mozilla/webtools/bugzilla/docs/en/xml&command=DIFF_FRAMESET&file=Bugzilla-Guide.xml&rev2=1.32&rev1=1.31

The missing documentation is still available in 2.16:

http://www.bugzilla.org/docs/2.16/html/introduction.html

So the question is: do we want to keep this introduction and insert the link back in Bugzilla-Guide.xml, or do we want to remove introduction.xml from the CVS repository?

Comment 6

[Max Kanat-Alexander]

Well, if it's just basically advertising at this point, I don't think it needs to be in the manual. bugzilla.org explains fairly well what Bugzilla is. I think you'd know what Bugzilla is if you're reading the manual. So let's remove introduction.xml.

Comment 7

[Frédéric Buclin]

Attachment: patch, v1

Per comment 6 and the discussion on IRC, this file should go away.

Comment 8

[Frédéric Buclin]

Checking in docs/en/xml/Bugzilla-Guide.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/en/xml/Bugzilla-Guide.xml,v  <--  Bugzilla-Guide.xml
new revision: 1.86; previous revision: 1.85
done
Removing docs/en/xml/introduction.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/en/xml/introduction.xml,v  <--  introduction.xml
new revision: delete; previous revision: 1.6
done