338439 - FAQ answers could do with some updating

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[c1541]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.8.0.3) Gecko/20060426 Firefox/1.5.0.3
Build Identifier: Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.8.0.3) Gecko/20060426 Firefox/1.5.0.3

A.1.7.  Why MySQL? I'm interested in seeing Bugzilla run on PostgreSQL/Sybase/Oracle/Msql/MSSQL.

QUICK CHANGE:
There is currently work in progress to make Bugzilla work on PostgreSQL; track the progress of this initiative in bug 98304. 
TO:
From version 2.20 onwards, Bugzilla also works with PostgreSQL.


*could probably do with a more detailed change though*



A.2.9.  Are there any backup features provided?

REPLACE:
MySQL, the database back-end for Bugzilla, allows hot-backup of data. You can find strategies for dealing with backup considerations at http://www.mysql.com/doc/B/a/Backup.html. 
WITH:
You should use the backup options that were supplied with your database platform.
Documentation for dealing with backups in MySQL are at http://www.mysql.com/doc/B/a/Backup.html and for PostgreSQL are at http://www.postgresql.org/docs/8.0/static/backup.html.



A.3.2.  Can users be on the system while a backup is in progress?

REPLACE:
Yes, but commits to the database must wait until the tables are unlocked. Bugzilla databases are typically very small, and backups routinely take less than a minute. If your database is larger, you may want to look into alternate backup techniques, such as database replication, or backing up from a read-only mirror. (Read up on these in the MySQL docs on the MySQL site.) 
WITH:
Refer to your database platform documentation for details on how to do hot backups.
Documentation for dealing with backups in MySQL are at http://www.mysql.com/doc/B/a/Backup.html and for PostgreSQL are at http://www.postgresql.org/docs/8.0/static/backup.html.



A.3.5.  How do I move a Bugzilla installation from one machine to another?

May want to either add notes for PostgresSQL backups & restores or remove the mySQL notes & just refer users to the database documentation as in A.2.9 & A.3.2


Reproducible: Always

Comment 1

[Max Kanat-Alexander]

You know, actually, RSZ moved the whole FAQ to the Wiki, and I think that might be a good place for it to live permanently.

What do people say about removing the FAQ from the normal docs entirely, and only linking to the Wiki?

Comment 2

[Frédéric Buclin]

(In reply to comment #1)
> What do people say about removing the FAQ from the normal docs entirely, and
> only linking to the Wiki?

I'm against it.

Comment 3

[Colin Ogilvie [:cso]]

I'm against it too.

Comment 4

[Frédéric Buclin]

At least the A.1.7 section needs to be updated.

Comment 5

[Frédéric Buclin]

Colin, vladd, it's a shame to have Q and A such as what is /usr/bin/bonsaitools/perl which no longer exists since Bugzilla 2.16 as well as saying we don't support PostgreSQL, etc... (the examples are numerous). Could one of you take some tens of minutes to update them? Many thanks!

Comment 6

[Jeffrey Hulten]

Attachment: Updates to the FAQs.

Comment 7

[victory <[e-mail]>]

s|http://bugzilla.mozilla.org|https://bugzilla.mozilla.org|g;
B-)

Comment 8

[Jeffrey Hulten]

Attachment: Changed all http to https for bmo

Comment 9

[Colin Ogilvie [:cso]]

Comment on attachment 231716 [details] [diff] [review]
Changed all http to https for bmo

I've visually glanced at this (will run it through the generator later) and it looks ok. 

One nit I have is that MySQL Control Centre doesn't exist anymore (the page diverts you elsewhere)...

Comment 10

[Frédéric Buclin]

Comment on attachment 231716 [details] [diff] [review]
Changed all http to https for bmo

>@@ -167,11 +167,7 @@
>           <para>
>             MySQL was originally chosen because it is free, easy to install,
>             and was available for the hardware Netscape intended to run it on.
>+          	PostgreSQL support has been added to Bugzilla as of version 2.20.
>           </para>

Why this indentation?


>@@ -181,21 +177,19 @@
>           <para>
>             Red Hat once ran a version of Bugzilla that worked on Oracle, 
>             but that was long, long ago; that version (Bugzilla 2.8) is
>             now obsolete, insecure, and totally unsupported. Red Hat's
>+            current Bugzilla (based on Bugzilla 2.17.1) uses PostgreSQL.
>+            At this time we know of no recent ports of Bugzilla to Oracle. 
>+            (In our honest opinion, Bugzilla doesn't need what Oracle offers.)
>           </para>

The comment in parens should be removed. It's not the right place to say that you don't like Oracle, especially because we might have Oracle support for 3.0.

Moreover, RH now uses Bugzilla 2.18, not 2.17.1.


>@@ -211,15 +205,13 @@
>           <para>
>             Bugzilla used to have the path to perl on the shebang line set
>+            to <filename>/usr/bonsaitools/bin/perl</filename>. This location 
>+            was abandoned for the 2.18 release in favor of the more sensible 
>+            <filename>/usr/bin/perl</filename>. If you installed an older 
>+            version of Bugzilla and created the symlink we suggested, you can 
>+            remove it now (provided that you don't have anything else, such as 
>+            Bonsai, using it and you don't intend to reinstall an older version 
>+            of Bugzilla).
>           </para>

None of our supported branches uses /usr/bonsaitools/bin/perl. We should remove this section completely.

Comment 11

[Max Kanat-Alexander]

I'd definitely like to see this get fixed, but I'd still release 3.0 if it wasn't, so it's not a blocker.

Comment 12

[Frédéric Buclin]

Any progress on this one? Some questions and/or answers are really obsolete.

Comment 13

[Sam Folk-Williams]

I'll take this and work on it this week...

-Sam

Comment 14

[Sam Folk-Williams]

Attachment: updated FAQ patch

I'm attaching the first go at an updated patch. This patch takes the previous patch, updates a few things that have changed since that patch was done, and incorporates the comments given on that patch. In addition, I updated the bit about SELinux and some other odds and ends.

Note i haven't had time to go through the entire FAQ and I suspect there is more, but taking this one step at a time let's review this...

Comment 15

[Colin Ogilvie [:cso]]

Comment on attachment 280046 [details] [diff] [review]
updated FAQ patch

As a quick glance over it, there are lots of links that appear to be changing to https:// ones for no reason...

Nothing major appears to jump out at me, but I'll need to have a more thorough look later.

Comment 16

[Sam Folk-Williams]

Attachment: removing excess https links

I believe the idea is for any link that can be https it should be. But, yeah the global find and replace was too much. Took away all those not pointing to bugzilla.org or bugzilla.mozilla.org (which all should work).

Comment 17

[Frédéric Buclin]

Comment on attachment 280059 [details] [diff] [review]
removing excess https links

>-        <question id="faq-mod-perl">
>-          <para>
>-            Does bugzilla run under <filename>mod_perl</filename>?
>-          </para>
>-        </question>

This part has already been removed in bug 394953.

Comment 18

[Sam Folk-Williams]

Attachment: removed duplicate patch

Oops - forgot to sync my cvs tree. Thanks.

Comment 19

[Colin Ogilvie [:cso]]

Comment on attachment 280066 [details] [diff] [review]
removed duplicate patch

Don't https:// links to pages that don't require it - it just causes extra load on the server.

The only thing that I can think that should be https:// is links to bugzilla.mozilla.org - not to static content.

Comment 20

[Sam Folk-Williams]

Attachment: removed more https

OK got it - removed more https...

Comment 21

[Frédéric Buclin]

Comment on attachment 280074 [details] [diff] [review]
removed more https

>+            As of Bugzilla 2.22, complete for stable support for PostgreSQL 
>+            is included.

Is this sentence really correct?


>             There is no GUI for adding fields to Bugzilla at this
>             time. You can follow development of this feature in 
>-            <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=91037">bug 91037</ulink>
>+            <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=91037">bug 91037</ulink>.
>+            Full support for custom fields is slated for Bugzilla 3.0.

Custom fields have been implemented in 3.0, and we have an admin page to manage them, so there is a GUI too.


>-            See the <ulink url="http://dev.mysql.com/doc/mysql/en/mysqldump.html">
>-            mysqldump documentation</ulink> for more information on 

>+            Vendor documentation for backing up a MySQL database can be found at 
>+            <ulink url="http://www.mysql.com/doc/B/a/Backup.html"/>. 

Why this URL change?


>+      <!-- Should we really even answer this question? I'm commenting this out
>+           pending discussion. Seems like we should just delete it.

What's the problem here?

Comment 22

[Sam Folk-Williams]

Attachment: putting in LpSolit's recommendations

adding suggestions

Comment 23

[Frédéric Buclin]

Comment on attachment 280084 [details] [diff] [review]
putting in LpSolit's recommendations 

>+            What databases does Bugzilla run on?.

Remove the trailing dot.


>-
>+-->

This should go away (at the end of the mysql security question).


Everything else looks good. r=LpSolit. Colin, do you want to look at it too? Note that this patch should only land on trunk and 3.0 as some answers are specific to 3.0+. I don't think 2.22 needs to get a backport, unless you really want to provide one.

Comment 24

[Colin Ogilvie [:cso]]

Comment on attachment 280084 [details] [diff] [review]
putting in LpSolit's recommendations 

>+            Reference your database vendors documentation for information on 
>+            backing up and restore your Bugzilla database on a different server.


In addition to the previous comments for LpSolit, this bit doesn't make sense.

Should probably be:

Reference your database vendor's documentation for information on backing up and restoring your Bugzilla database on to a different server.

Comment 25

[Colin Ogilvie [:cso]]

Trunk:

Checking in xml/faq.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/faq.xml,v  <--  faq.xml
new revision: 1.51; previous revision: 1.50
done

3.0:

Checking in xml/faq.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/faq.xml,v  <--  faq.xml
new revision: 1.46.2.5; previous revision: 1.46.2.4
done

Comment 26

[Colin Ogilvie [:cso]]

Bustage fix:


Checking in xml/faq.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/faq.xml,v  <--  faq.xml
new revision: 1.46.2.6; previous revision: 1.46.2.5
done
Checking in docs/xml/faq.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/faq.xml,v  <--  faq.xml
new revision: 1.52; previous revision: 1.51
done