From e5f66d622072504219a049703389c78a69f0f01c Mon Sep 17 00:00:00 2001 From: "jake%bugzilla.org" <> Date: Tue, 31 Dec 2002 11:05:07 +0000 Subject: Bug 180005 - Bring the FAQ up to date. a=justdave --- docs/sgml/faq.sgml | 192 +++++++++++++++++++++++++++-------------------------- docs/xml/faq.xml | 192 +++++++++++++++++++++++++++-------------------------- 2 files changed, 198 insertions(+), 186 deletions(-) diff --git a/docs/sgml/faq.sgml b/docs/sgml/faq.sgml index d1968d8f8..2c0bbee99 100644 --- a/docs/sgml/faq.sgml +++ b/docs/sgml/faq.sgml @@ -49,6 +49,11 @@ + + http://bugzilla.org/consulting.html + is a list of people and companies who have asked us to list them + as consultants for Bugzilla. + www.collab.net offers Bugzilla as part of their standard offering to large projects. @@ -73,13 +78,12 @@ - There are dozens of major comapanies with public + There are dozens of major companies with public Bugzilla sites to track bugs in their products. A few include: Netscape/AOL Mozilla.org NASA - AtHome Corporation Red Hat Software SuSe Corp The Horde Project @@ -112,7 +116,7 @@ A core team, - led by Dave Miller (justdave@syndicomm.com). + led by Dave Miller (justdave@netscape.com). @@ -147,7 +151,7 @@ - Why doesn't Bugzilla offer this or that feature or compatability + Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software? @@ -178,9 +182,22 @@ - There is DB-independence work afoot. PostgreSQL support is planned - for 2.18, and full DB-independence can't be far further on. - + MySQL was originally chosen because it is free, easy to install, + and was available for the hardware Netscape intended to run it on. + + + There is currently work in progress to make Bugzilla work on + PostgreSQL and Sybase in the default distribution. You can track + the progress of these initiatives in bugs 98304 + and 173130 + respectively. + + + Once both of these are done, adding support for additional + database servers should be trivial. + @@ -270,10 +287,8 @@ - Absolutely! You can track any number of Products (although you - are limited to about 55 or so if - you are using Product-Based Groups), that can each be composed of any - number of Components. + Absolutely! You can track any number of Products that can each be + composed of any number of Components. @@ -303,9 +318,9 @@ Yes - any sort of attachment is allowed, although administrators can configure a maximum size. - There are many specific MIME-types that are pre-defined by Bugzilla, - but you may specify any arbitrary MIME-type you need when you - upload the file. + Bugzilla gives the user the option of either using the MIME-type + supplied by the browser, choosing from a pre-defined list or + manually typing any arbitrary MIME-type. @@ -343,16 +358,16 @@ Yes. Look at - http://bugzilla.mozilla.org/reports.cgi for basic reporting - and graphing facilities. + http://bugzilla.mozilla.org/reports.cgi for samples of what + Bugzilla can do in reporting and graphing. - For more advanced reporting, I recommend hooking up a professional - reporting package, such as Crystal Reports, and use ODBC to access - the MySQL database. You can do a lot through the Query page of - Bugzilla as well, but right now Advanced Reporting is much - better accomplished through third-party utilities that can - interface with the database directly. + If you can not get the reports you want from the included reporting + scripts, it is possible to hook up a professional reporting package + such as Crystal Reports using ODBC. If you choose to do this, + beware that giving direct access to the database does contain some + security implications. Even if you give read-only access to the + bugs database it will bypass the secure bugs features of Bugzilla. @@ -422,26 +437,32 @@ - - Mozilla allows data export through a custom DTD in XML format. - It does not, however, export to specific formats other than the - XML Mozilla DTD. Importing the data into Excel or any other application - is left as an exercise for the reader. - - - If you create import filters to other applications from Mozilla's XML, - please submit your modifications for inclusion in future Bugzilla - distributions. - - - As for data import, any application can send data to Bugzilla through - the HTTP protocol, or through Mozilla's XML API. However, it seems - kind of silly to put another front-end in front of Bugzilla; - it makes more sense to create a simplified bug submission form in - HTML. You can find an excellent example at - - http://www.mozilla.org/quality/help/bugzilla-helper.html - + + Bugzilla can output buglists as HTML (the default), CSV or RDF. + The link for CSV can be found at the bottom of the buglist in HTML + format. This CSV format can easily be imported into MS Excel or + other spread-sheet applications. + + + To use the RDF format of the buglist it is necessary to append a + &ctype=rdf to the URL. RDF + is meant to be machine readable and thus it is assumed that the + URL would be generated progmatically so there is no user visible + link to this format. + + + Currently the only script included with Bugzilla that can import + data is importxml.pl which is intended to be + used for importing the data generated by xml.cgi + in association with bug moving. Any other use is left as an + exercise for the user. + + + There are also scripts included in the contrib/ + directory for using e-mail to import information into Bugzilla, + but these scripts are not currently supported and included for + educational purposes. + @@ -454,10 +475,14 @@ - To a certain extent, yes. 2.16's templates mean that you can localise - the user-facing UI (and several projects are doing exactly that.) However, - error messages and the admin interface are currently not localisable. - This should be achieved by 2.18. + Yes. For more information including available translated templates, + see http://www.bugzilla.org/download.html. + The admin interfaces are still not included in these translated + templates and is therefore still English only. Also, there may be + issues with the charset not being declared. See bug 126226 + for more information. @@ -471,7 +496,7 @@ - Yes. No. No. + Yes. No. Yes (using the CSV format). @@ -668,7 +693,8 @@ The user should be able to set - this in user email preferences (uncheck all boxes.) + this in user email preferences (uncheck all boxes) or you can add + their email address to the data/nomail file. @@ -682,7 +708,7 @@ - Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". @@ -797,10 +823,11 @@ - Red Hat Bugzilla works with Oracle. The current version - from Mozilla.org does not have this capability. Unfortunately, though - you will sacrifice a lot of the really great features available in - Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. + Red Hat's newer version (based on 2.17.1 and soon to be merged into + the main distribution) runs on PostgreSQL. At this time we know of + no recent ports of Bugzilla to Oracle but do intend to support it + in the future (possibly the 2.20 time-frame). @@ -843,25 +870,13 @@ There is no facility in Bugzilla itself to do this. It's also generally not a smart thing to do if you don't know exactly what you're doing. - However, if you understand SQL you can use the mysqladmin utility to - manually insert, delete, and modify table information. Personally, I - use "phpMyAdmin". You have to compile a PHP module with MySQL - support to make it work, but it's very clean and easy to use. - - - - - - - - I try to add myself as a user, but Bugzilla always tells me my password is wrong. - - - - - Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally disabled - the "crypt()" function. This prevented MySQL from storing encrypted passwords. - Upgrade to the "3.23 stable" version of MySQL and you should be good to go. + However, if you understand SQL you can use the mysql + command line utility to manually insert, delete and modify table + information. There are also more intuitive GUI clients available. + Personal favorites of the Bugzilla team are phpMyAdmin and MySQL Control + Center. @@ -877,10 +892,17 @@ Try running MySQL from its binary: "mysqld --skip-grant-tables". This will allow you to completely rule out grant tables as the cause of your - frustration. However, I do not recommend you run it this way on a regular - basis, unless you really want your web site defaced and your machine - cracked. - + frustration. If this Bugzilla is able to connect at this point then + you need to check that you have granted proper permission to the user + password combo defined in localconfig. + + + + Running MySQL with this command line option is very insecure and + should only be done when not connected to the external network + as a troubleshooting step. + + @@ -1095,22 +1117,6 @@ - - - - Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. - - - - - Yup. Just rename it once you download it, or save it under a different - filename. This will not be fixed anytime soon, because it would - cripple some other functionality. - - - - @@ -1139,7 +1145,7 @@ - Gerv and Myk suggest a 2-space endent, with embedded code sections on + Gerv and Myk suggest a 2-space indent, with embedded code sections on their own line, in line with outer tags. Like this: diff --git a/docs/xml/faq.xml b/docs/xml/faq.xml index d1968d8f8..2c0bbee99 100644 --- a/docs/xml/faq.xml +++ b/docs/xml/faq.xml @@ -49,6 +49,11 @@ + + http://bugzilla.org/consulting.html + is a list of people and companies who have asked us to list them + as consultants for Bugzilla. + www.collab.net offers Bugzilla as part of their standard offering to large projects. @@ -73,13 +78,12 @@ - There are dozens of major comapanies with public + There are dozens of major companies with public Bugzilla sites to track bugs in their products. A few include: Netscape/AOL Mozilla.org NASA - AtHome Corporation Red Hat Software SuSe Corp The Horde Project @@ -112,7 +116,7 @@ A core team, - led by Dave Miller (justdave@syndicomm.com). + led by Dave Miller (justdave@netscape.com). @@ -147,7 +151,7 @@ - Why doesn't Bugzilla offer this or that feature or compatability + Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software? @@ -178,9 +182,22 @@ - There is DB-independence work afoot. PostgreSQL support is planned - for 2.18, and full DB-independence can't be far further on. - + MySQL was originally chosen because it is free, easy to install, + and was available for the hardware Netscape intended to run it on. + + + There is currently work in progress to make Bugzilla work on + PostgreSQL and Sybase in the default distribution. You can track + the progress of these initiatives in bugs 98304 + and 173130 + respectively. + + + Once both of these are done, adding support for additional + database servers should be trivial. + @@ -270,10 +287,8 @@ - Absolutely! You can track any number of Products (although you - are limited to about 55 or so if - you are using Product-Based Groups), that can each be composed of any - number of Components. + Absolutely! You can track any number of Products that can each be + composed of any number of Components. @@ -303,9 +318,9 @@ Yes - any sort of attachment is allowed, although administrators can configure a maximum size. - There are many specific MIME-types that are pre-defined by Bugzilla, - but you may specify any arbitrary MIME-type you need when you - upload the file. + Bugzilla gives the user the option of either using the MIME-type + supplied by the browser, choosing from a pre-defined list or + manually typing any arbitrary MIME-type. @@ -343,16 +358,16 @@ Yes. Look at - http://bugzilla.mozilla.org/reports.cgi for basic reporting - and graphing facilities. + http://bugzilla.mozilla.org/reports.cgi for samples of what + Bugzilla can do in reporting and graphing. - For more advanced reporting, I recommend hooking up a professional - reporting package, such as Crystal Reports, and use ODBC to access - the MySQL database. You can do a lot through the Query page of - Bugzilla as well, but right now Advanced Reporting is much - better accomplished through third-party utilities that can - interface with the database directly. + If you can not get the reports you want from the included reporting + scripts, it is possible to hook up a professional reporting package + such as Crystal Reports using ODBC. If you choose to do this, + beware that giving direct access to the database does contain some + security implications. Even if you give read-only access to the + bugs database it will bypass the secure bugs features of Bugzilla. @@ -422,26 +437,32 @@ - - Mozilla allows data export through a custom DTD in XML format. - It does not, however, export to specific formats other than the - XML Mozilla DTD. Importing the data into Excel or any other application - is left as an exercise for the reader. - - - If you create import filters to other applications from Mozilla's XML, - please submit your modifications for inclusion in future Bugzilla - distributions. - - - As for data import, any application can send data to Bugzilla through - the HTTP protocol, or through Mozilla's XML API. However, it seems - kind of silly to put another front-end in front of Bugzilla; - it makes more sense to create a simplified bug submission form in - HTML. You can find an excellent example at - - http://www.mozilla.org/quality/help/bugzilla-helper.html - + + Bugzilla can output buglists as HTML (the default), CSV or RDF. + The link for CSV can be found at the bottom of the buglist in HTML + format. This CSV format can easily be imported into MS Excel or + other spread-sheet applications. + + + To use the RDF format of the buglist it is necessary to append a + &ctype=rdf to the URL. RDF + is meant to be machine readable and thus it is assumed that the + URL would be generated progmatically so there is no user visible + link to this format. + + + Currently the only script included with Bugzilla that can import + data is importxml.pl which is intended to be + used for importing the data generated by xml.cgi + in association with bug moving. Any other use is left as an + exercise for the user. + + + There are also scripts included in the contrib/ + directory for using e-mail to import information into Bugzilla, + but these scripts are not currently supported and included for + educational purposes. + @@ -454,10 +475,14 @@ - To a certain extent, yes. 2.16's templates mean that you can localise - the user-facing UI (and several projects are doing exactly that.) However, - error messages and the admin interface are currently not localisable. - This should be achieved by 2.18. + Yes. For more information including available translated templates, + see http://www.bugzilla.org/download.html. + The admin interfaces are still not included in these translated + templates and is therefore still English only. Also, there may be + issues with the charset not being declared. See bug 126226 + for more information. @@ -471,7 +496,7 @@ - Yes. No. No. + Yes. No. Yes (using the CSV format). @@ -668,7 +693,8 @@ The user should be able to set - this in user email preferences (uncheck all boxes.) + this in user email preferences (uncheck all boxes) or you can add + their email address to the data/nomail file. @@ -682,7 +708,7 @@ - Edit the "changedmail" Param. Replace "To:" with "X-Real-To:", + Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:", replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>". @@ -797,10 +823,11 @@ - Red Hat Bugzilla works with Oracle. The current version - from Mozilla.org does not have this capability. Unfortunately, though - you will sacrifice a lot of the really great features available in - Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version. + Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle. + Red Hat's newer version (based on 2.17.1 and soon to be merged into + the main distribution) runs on PostgreSQL. At this time we know of + no recent ports of Bugzilla to Oracle but do intend to support it + in the future (possibly the 2.20 time-frame). @@ -843,25 +870,13 @@ There is no facility in Bugzilla itself to do this. It's also generally not a smart thing to do if you don't know exactly what you're doing. - However, if you understand SQL you can use the mysqladmin utility to - manually insert, delete, and modify table information. Personally, I - use "phpMyAdmin". You have to compile a PHP module with MySQL - support to make it work, but it's very clean and easy to use. - - - - - - - - I try to add myself as a user, but Bugzilla always tells me my password is wrong. - - - - - Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally disabled - the "crypt()" function. This prevented MySQL from storing encrypted passwords. - Upgrade to the "3.23 stable" version of MySQL and you should be good to go. + However, if you understand SQL you can use the mysql + command line utility to manually insert, delete and modify table + information. There are also more intuitive GUI clients available. + Personal favorites of the Bugzilla team are phpMyAdmin and MySQL Control + Center. @@ -877,10 +892,17 @@ Try running MySQL from its binary: "mysqld --skip-grant-tables". This will allow you to completely rule out grant tables as the cause of your - frustration. However, I do not recommend you run it this way on a regular - basis, unless you really want your web site defaced and your machine - cracked. - + frustration. If this Bugzilla is able to connect at this point then + you need to check that you have granted proper permission to the user + password combo defined in localconfig. + + + + Running MySQL with this command line option is very insecure and + should only be done when not connected to the external network + as a troubleshooting step. + + @@ -1095,22 +1117,6 @@ - - - - Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. - - - - - Yup. Just rename it once you download it, or save it under a different - filename. This will not be fixed anytime soon, because it would - cripple some other functionality. - - - - @@ -1139,7 +1145,7 @@ - Gerv and Myk suggest a 2-space endent, with embedded code sections on + Gerv and Myk suggest a 2-space indent, with embedded code sections on their own line, in line with outer tags. Like this: -- cgit v1.2.3-24-g4f1b