diff options
Diffstat (limited to 'docs/html/programadmin.html')
-rw-r--r-- | docs/html/programadmin.html | 279 |
1 files changed, 140 insertions, 139 deletions
diff --git a/docs/html/programadmin.html b/docs/html/programadmin.html index ea2bcbcfc..b4e3bca3d 100644 --- a/docs/html/programadmin.html +++ b/docs/html/programadmin.html @@ -20,7 +20,7 @@ REL="NEXT" TITLE="Bugzilla Security" HREF="security.html"></HEAD ><BODY -CLASS="SECTION" +CLASS="section" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" @@ -67,11 +67,11 @@ HREF="security.html" ALIGN="LEFT" WIDTH="100%"></DIV ><DIV -CLASS="SECTION" +CLASS="section" ><H1 -CLASS="SECTION" +CLASS="section" ><A -NAME="PROGRAMADMIN" +NAME="programadmin" >4.3. Product, Component, Milestone, and Version Administration</A ></H1 @@ -99,11 +99,11 @@ VALIGN="TOP" ></TR ></TABLE ><DIV -CLASS="SECTION" +CLASS="section" ><H2 -CLASS="SECTION" +CLASS="section" ><A -NAME="PRODUCTS" +NAME="products" >4.3.1. Products</A ></H2 ><FONT @@ -111,10 +111,10 @@ COLOR="RED" >Formerly, and in some spots still, called "Programs"</FONT ><P -> <A -HREF="glossary.html#GLOSS_PRODUCT" +> <A +HREF="glossary.html#gloss-product" ><I -CLASS="GLOSSTERM" +CLASS="glossterm" >Products</I ></A > are @@ -124,7 +124,7 @@ CLASS="GLOSSTERM" products (website, meetings...) </P ><P -> A Product (formerly called "Program", and still referred to +> A Product (formerly called "Program", and still referred to that way in some portions of the source code) controls some very important functions. The number of "votes" available for users to vote for the most important bugs is set per-product, @@ -141,15 +141,15 @@ CLASS="GLOSSTERM" TYPE="1" ><LI ><P -> Select "components" from the yellow footer +> Select "components" from the yellow footer </P ><DIV -CLASS="TIP" +CLASS="tip" ><P ></P ><TABLE -CLASS="TIP" -WIDTH="90%" +CLASS="tip" +WIDTH="100%" BORDER="0" ><TR ><TD @@ -164,7 +164,7 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> It may seem counterintuitive to click "components" when +> It may seem counterintuitive to click "components" when you want to edit the properties associated with Products. This is one of a long list of things we want in Bugzilla 3.0... @@ -176,22 +176,22 @@ VALIGN="TOP" ></LI ><LI ><P -> Select the "Add" link to the right of "Add a new product". +> Select the "Add" link to the right of "Add a new product". </P ></LI ><LI ><P -> Enter the name of the product and a description. The +> Enter the name of the product and a description. The Description field is free-form. </P ></LI ></OL ><DIV -CLASS="TIP" +CLASS="tip" ><P ></P ><TABLE -CLASS="TIP" +CLASS="tip" WIDTH="100%" BORDER="0" ><TR @@ -207,7 +207,7 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Don't worry about the "Closed for bug entry", "Maximum Votes +> Don't worry about the "Closed for bug entry", "Maximum Votes per person", "Maximum votes a person can put on a single bug", "Number of votes a bug in this Product needs to automatically get out of the UNCOMFIRMED state", and @@ -219,34 +219,34 @@ VALIGN="TOP" ></DIV ></DIV ><DIV -CLASS="SECTION" +CLASS="section" ><H2 -CLASS="SECTION" +CLASS="section" ><A -NAME="COMPONENTS" +NAME="components" >4.3.2. Components</A ></H2 ><P -> Components are subsections of a Product. +> Components are subsections of a Product. <DIV -CLASS="EXAMPLE" +CLASS="example" ><A -NAME="AEN1461" +NAME="AEN1470" ></A ><P ><B >Example 4-1. Creating some Components</B ></P ><DIV -CLASS="INFORMALEXAMPLE" +CLASS="informalexample" ><A -NAME="AEN1463" +NAME="AEN1472" ></A ><P ></P ><P -> The computer game you are designing may have a "UI" +> The computer game you are designing may have a "UI" component, an "API" component, a "Sound System" component, and a "Plugins" component, each overseen by a different programmer. It often makes sense to divide @@ -272,7 +272,7 @@ NAME="AEN1463" to the Component. </P ><P -> To create a new Component: +> To create a new Component: </P ><P ></P @@ -280,31 +280,31 @@ NAME="AEN1463" TYPE="1" ><LI ><P -> Select the "Edit components" link from the "Edit product" +> Select the "Edit components" link from the "Edit product" page </P ></LI ><LI ><P -> Select the "Add" link to the right of the "Add a new +> Select the "Add" link to the right of the "Add a new component" text on the "Select Component" page. </P ></LI ><LI ><P -> Fill out the "Component" field, a short "Description", and +> Fill out the "Component" field, a short "Description", and the "Initial Owner". The Component and Description fields are free-form; the "Initial Owner" field must be that of a user ID already existing in the database. If the initial owner does not exist, Bugzilla will refuse to create the component. <DIV -CLASS="TIP" +CLASS="tip" ><P ></P ><TABLE -CLASS="TIP" -WIDTH="90%" +CLASS="tip" +WIDTH="100%" BORDER="0" ><TR ><TD @@ -319,7 +319,7 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Is your "Default Owner" a user who is not yet in the +> Is your "Default Owner" a user who is not yet in the database? No problem. <P ></P @@ -327,19 +327,19 @@ VALIGN="TOP" TYPE="a" ><LI ><P -> Select the "Log out" link on the footer of the +> Select the "Log out" link on the footer of the page. </P ></LI ><LI ><P -> Select the "New Account" link on the footer of +> Select the "New Account" link on the footer of the "Relogin" page </P ></LI ><LI ><P -> Type in the email address of the default owner +> Type in the email address of the default owner you want to create in the "E-mail address" field, and her full name in the "Real name" field, then select the "Submit Query" button. @@ -347,7 +347,7 @@ TYPE="a" ></LI ><LI ><P -> Now select "Log in" again, type in your login +> Now select "Log in" again, type in your login information, and you can modify the product to use the Default Owner information you require. </P @@ -364,7 +364,7 @@ TYPE="a" ></LI ><LI ><P -> Either Edit more components or return to the Bugzilla +> Either Edit more components or return to the Bugzilla Query Page. To return to the Product you were editing, you must select the Components link as before. </P @@ -372,36 +372,36 @@ TYPE="a" ></OL ></DIV ><DIV -CLASS="SECTION" +CLASS="section" ><H2 -CLASS="SECTION" +CLASS="section" ><A -NAME="VERSIONS" +NAME="versions" >4.3.3. Versions</A ></H2 ><P -> Versions are the revisions of the product, such as "Flinders +> Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", and "Flinders 2000". Using Versions helps you isolate code changes and are an aid in reporting. <DIV -CLASS="EXAMPLE" +CLASS="example" ><A -NAME="AEN1490" +NAME="AEN1499" ></A ><P ><B >Example 4-2. Common Use of Versions</B ></P ><DIV -CLASS="INFORMALEXAMPLE" +CLASS="informalexample" ><A -NAME="AEN1492" +NAME="AEN1501" ></A ><P ></P ><P -> A user reports a bug against Version "Beta 2.0" of your +> A user reports a bug against Version "Beta 2.0" of your product. The current Version of your software is "Release Candidate 1", and no longer has the bug. This will help you triage and classify bugs according to @@ -416,23 +416,23 @@ NAME="AEN1492" ></DIV > <DIV -CLASS="EXAMPLE" +CLASS="example" ><A -NAME="AEN1494" +NAME="AEN1503" ></A ><P ><B >Example 4-3. A Different Use of Versions</B ></P ><DIV -CLASS="INFORMALEXAMPLE" +CLASS="informalexample" ><A -NAME="AEN1496" +NAME="AEN1505" ></A ><P ></P ><P -> This field has been used to good effect by an online +> This field has been used to good effect by an online service provider in a slightly different way. They had three versions of the product: "Production", "QA", and "Dev". Although it may be the same product, a bug in @@ -450,7 +450,7 @@ NAME="AEN1496" > </P ><P -> To create and edit Versions: +> To create and edit Versions: </P ><P ></P @@ -458,32 +458,32 @@ NAME="AEN1496" TYPE="1" ><LI ><P -> From the "Edit product" screen, select "Edit Versions" +> From the "Edit product" screen, select "Edit Versions" </P ></LI ><LI ><P -> You will notice that the product already has the default +> You will notice that the product already has the default version "undefined". If your product doesn't use version numbers, you may want to leave this as it is or edit it so that it is "---". You can then go back to the edit versions page and add new versions to your product. </P ><P -> Otherwise, click the "Add" button to the right of the "Add +> Otherwise, click the "Add" button to the right of the "Add a new version" text. </P ></LI ><LI ><P -> Enter the name of the Version. This can be free-form +> Enter the name of the Version. This can be free-form characters up to the limit of the text box. Then select the "Add" button. </P ></LI ><LI ><P -> At this point you can select "Edit" to edit more Versions, +> At this point you can select "Edit" to edit more Versions, or return to the "Query" page, from which you can navigate back to the product through the "components" link at the foot of the Query page. @@ -492,26 +492,26 @@ TYPE="1" ></OL ></DIV ><DIV -CLASS="SECTION" +CLASS="section" ><H2 -CLASS="SECTION" +CLASS="section" ><A -NAME="MILESTONES" +NAME="milestones" >4.3.4. Milestones</A ></H2 ><P -> Milestones are "targets" that you plan to get a bug fixed by. +> Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a bug that you plan to fix for 2.8, this would have a milestone of 2.8. </P ><DIV -CLASS="NOTE" +CLASS="note" ><P ></P ><TABLE -CLASS="NOTE" +CLASS="note" WIDTH="100%" BORDER="0" ><TR @@ -527,7 +527,7 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Milestone options will only appear for a Product if you +> Milestone options will only appear for a Product if you turned the "usetargetmilestone" field in the "Edit Parameters" screen "On". </P @@ -536,7 +536,7 @@ VALIGN="TOP" ></TABLE ></DIV ><P -> To create new Milestones, set Default Milestones, and set +> To create new Milestones, set Default Milestones, and set Milestone URL: </P ><P @@ -545,40 +545,40 @@ VALIGN="TOP" TYPE="1" ><LI ><P -> Select "edit milestones" +> Select "edit milestones" </P ></LI ><LI ><P -> Select "Add" to the right of the "Add a new milestone" +> Select "Add" to the right of the "Add a new milestone" text </P ></LI ><LI ><P -> Enter the name of the Milestone in the "Milestone" field. +> Enter the name of the Milestone in the "Milestone" field. You can optionally set the "Sortkey", which is a positive or negative number (-255 to 255) that defines where in the list this particular milestone appears. Select "Add". </P ><DIV -CLASS="EXAMPLE" +CLASS="example" ><A -NAME="AEN1522" +NAME="AEN1531" ></A ><P ><B >Example 4-4. Using SortKey with Target Milestone</B ></P ><DIV -CLASS="INFORMALEXAMPLE" +CLASS="informalexample" ><A -NAME="AEN1524" +NAME="AEN1533" ></A ><P ></P ><P -> Let's say you create a target milestone called +> Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0". Later, you realize that you will have a public beta, called "Beta1". You can create a Milestone called "Beta1", @@ -593,17 +593,17 @@ NAME="AEN1524" ></LI ><LI ><P -> If you want to add more milestones, select the "Edit" +> If you want to add more milestones, select the "Edit" link. If you don't, well shoot, you have to go back to the "query" page and select "components" again, and make your way back to the Product you were editing. <DIV -CLASS="NOTE" +CLASS="note" ><P ></P ><TABLE -CLASS="NOTE" -WIDTH="90%" +CLASS="note" +WIDTH="100%" BORDER="0" ><TR ><TD @@ -618,7 +618,7 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> This is another in the list of unusual user interface +> This is another in the list of unusual user interface decisions that we'd like to get cleaned up. Shouldn't there be a link to the effect of "edit the Product I was editing when I ended up here"? In any case, @@ -635,21 +635,21 @@ VALIGN="TOP" ></LI ><LI ><P -> From the Edit product screen again (once you've made your +> From the Edit product screen again (once you've made your way back), enter the URL for a description of what your milestones are for this product in the "Milestone URL" field. It should be of the format "http://www.foo.com/bugzilla/product_milestones.html" </P ><P -> Some common uses of this field include product +> Some common uses of this field include product descriptions, product roadmaps, and of course a simple description of the meaning of each milestone. </P ></LI ><LI ><P -> If you're using Target Milestones, the "Default Milestone" +> If you're using Target Milestones, the "Default Milestone" field must have some kind of entry. If you really don't care if people set coherent Target Milestones, simply leave this at the default, "---". However, controlling @@ -662,15 +662,15 @@ VALIGN="TOP" ></OL ></DIV ><DIV -CLASS="SECTION" +CLASS="section" ><H2 -CLASS="SECTION" +CLASS="section" ><A -NAME="VOTING" +NAME="voting" >4.3.5. Voting</A ></H2 ><P -> The concept of "voting" is a poorly understood, yet powerful +> The concept of "voting" is a poorly understood, yet powerful feature for the management of open-source projects. Each user is assigned so many Votes per product, which they can freely reassign (or assign multiple votes to a single bug). This @@ -681,7 +681,7 @@ NAME="VOTING" attention so they don't sit for a long time awaiting triage. </P ><P -> The daunting challenge of Votes is deciding where you draw the +> The daunting challenge of Votes is deciding where you draw the line for a "vocal majority". If you only have a user base of 100 users, setting a low threshold for bugs to move from UNCONFIRMED to NEW makes sense. As the Bugzilla user base @@ -698,19 +698,19 @@ NAME="VOTING" TYPE="1" ><LI ><P -> Navigate to the "Edit product" screen for the Product you +> Navigate to the "Edit product" screen for the Product you wish to modify </P ></LI ><LI ><P -> Set "Maximum Votes per person" to your calculated value. +> Set "Maximum Votes per person" to your calculated value. Setting this field to "0" disables voting. </P ></LI ><LI ><P -> Set "Maximum Votes a person can put on a single bug" to +> Set "Maximum Votes a person can put on a single bug" to your calculated value. It should probably be some number lower than the "Maximum votes per person". Setting this field to "0" disables voting, but leaves the voting @@ -719,7 +719,7 @@ TYPE="1" ></LI ><LI ><P -> Set "Number of votes a bug in this product needs to +> Set "Number of votes a bug in this product needs to automatically get out of the UNCONFIRMED state" to your calculated number. Setting this field to "0" disables the automatic move of bugs from UNCONFIRMED to NEW. Some @@ -727,12 +727,12 @@ TYPE="1" Votes if your Bugzilla user base is unable to affect which bugs appear on Development radar? <DIV -CLASS="TIP" +CLASS="tip" ><P ></P ><TABLE -CLASS="TIP" -WIDTH="90%" +CLASS="tip" +WIDTH="100%" BORDER="0" ><TR ><TD @@ -747,7 +747,7 @@ ALT="Tip"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> You should probably set this number to higher than a +> You should probably set this number to higher than a small coalition of Bugzilla users can influence it. Most sites use this as a "referendum" mechanism -- if users are able to vote a bug out of UNCONFIRMED, it is @@ -764,44 +764,44 @@ VALIGN="TOP" ></LI ><LI ><P -> Once you have adjusted the values to your preference, +> Once you have adjusted the values to your preference, select the "Update" button. </P ></LI ></OL ></DIV ><DIV -CLASS="SECTION" +CLASS="section" ><H2 -CLASS="SECTION" +CLASS="section" ><A -NAME="GROUPS" +NAME="groups" >4.3.6. Groups and Group Security</A ></H2 ><P -> Groups can be very useful in bugzilla, because they allow +> Groups can be very useful in bugzilla, because they allow users to isolate bugs or products that should only be seen by certain people. Groups can also be a complicated minefield of interdependencies and weirdness if mismanaged. <DIV -CLASS="EXAMPLE" +CLASS="example" ><A -NAME="AEN1558" +NAME="AEN1567" ></A ><P ><B >Example 4-5. When to Use Group Security</B ></P ><DIV -CLASS="INFORMALEXAMPLE" +CLASS="informalexample" ><A -NAME="AEN1560" +NAME="AEN1569" ></A ><P ></P ><P -> Many Bugzilla sites isolate "Security-related" bugs from +> Many Bugzilla sites isolate "Security-related" bugs from all other bugs. This way, they can have a fix ready before the security vulnerability is announced to the world. You can create a "Security" product which, by @@ -825,11 +825,11 @@ NAME="AEN1560" into two categories: Generic and Product-Based. </P ><DIV -CLASS="NOTE" +CLASS="note" ><P ></P ><TABLE -CLASS="NOTE" +CLASS="note" WIDTH="100%" BORDER="0" ><TR @@ -845,7 +845,7 @@ ALT="Note"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Groups in Bugzilla are a complicated beast that evolved out +> Groups in Bugzilla are a complicated beast that evolved out of very simple user permission bitmasks, apparently itself derived from common concepts in UNIX access controls. A "bitmask" is a fixed-length number whose value can describe @@ -863,7 +863,7 @@ VALIGN="TOP" next 32, etc. </P ><P -> Similarly, Bugzilla offers a bitmask to define group +> Similarly, Bugzilla offers a bitmask to define group permissions, with an internal limit of 64. Several are already occupied by built-in permissions. The way around this limitation is to avoid assigning groups to products if @@ -879,7 +879,7 @@ VALIGN="TOP" ></TABLE ></DIV ><P -> To enable Generic Group Security ("usebuggroups"): +> To enable Generic Group Security ("usebuggroups"): </P ><P ></P @@ -887,47 +887,47 @@ VALIGN="TOP" TYPE="1" ><LI ><P -> Turn "On" "usebuggroups" in the "Edit Parameters" screen. +> Turn "On" "usebuggroups" in the "Edit Parameters" screen. </P ></LI ><LI ><P -> You will generally have no groups set up. Select the +> You will generally have no groups set up. Select the "groups" link in the footer. </P ></LI ><LI ><P -> Take a moment to understand the instructions on the "Edit +> Take a moment to understand the instructions on the "Edit Groups" screen. Once you feel confident you understand what is expected of you, select the "Add Group" link. </P ></LI ><LI ><P -> Fill out the "New Name" (remember, no spaces!), "New +> Fill out the "New Name" (remember, no spaces!), "New Description", and "New User RegExp" fields. "New User RegExp" allows you to automatically place all users who fulfill the Regular Expression into the new group. <DIV -CLASS="EXAMPLE" +CLASS="example" ><A -NAME="AEN1575" +NAME="AEN1584" ></A ><P ><B >Example 4-6. Creating a New Group</B ></P ><DIV -CLASS="INFORMALEXAMPLE" +CLASS="informalexample" ><A -NAME="AEN1577" +NAME="AEN1586" ></A ><P ></P ><P -> I created a group called DefaultGroup with a +> I created a group called DefaultGroup with a description of <SPAN CLASS="QUOTE" >"This is simply a group to play @@ -950,14 +950,14 @@ CLASS="QUOTE" ></LI ></OL ><P -> To enable Product-Based Group Security (usebuggroupsentry): +> To enable Product-Based Group Security (usebuggroupsentry): </P ><DIV -CLASS="WARNING" +CLASS="warning" ><P ></P ><TABLE -CLASS="WARNING" +CLASS="warning" WIDTH="100%" BORDER="0" ><TR @@ -973,7 +973,7 @@ ALT="Warning"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> Don't forget that you only have 64 groups masks available, +> Don't forget that you only have 64 groups masks available, total, for your installation of Bugzilla! If you plan on having more than 50 products in your individual Bugzilla installation, and require group security for your products, @@ -991,16 +991,16 @@ VALIGN="TOP" TYPE="1" ><LI ><P -> Turn "On" "usebuggroups" and "usebuggroupsentry" in the +> Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit Parameters" screen. </P ><DIV -CLASS="WARNING" +CLASS="warning" ><P ></P ><TABLE -CLASS="WARNING" -WIDTH="90%" +CLASS="warning" +WIDTH="100%" BORDER="0" ><TR ><TD @@ -1015,7 +1015,7 @@ ALT="Warning"></TD ALIGN="LEFT" VALIGN="TOP" ><P -> "usebuggroupsentry" has the capacity to prevent the +> "usebuggroupsentry" has the capacity to prevent the administrative user from directly altering bugs because of conflicting group permissions. If you plan on using "usebuggroupsentry", you should plan on restricting @@ -1031,7 +1031,7 @@ VALIGN="TOP" ></LI ><LI ><P -> You will generally have no Groups set up, unless you +> You will generally have no Groups set up, unless you enabled "usebuggroupsentry" prior to creating any Products. To create "Generic Group Security" groups, follow the instructions given above. To create @@ -1044,19 +1044,20 @@ VALIGN="TOP" ></LI ></OL ><P -> You may find this example illustrative for how bug groups work. +> You may find this example illustrative for how bug groups work. <DIV -CLASS="EXAMPLE" +CLASS="example" ><A -NAME="AEN1592" +NAME="AEN1601" ></A ><P ><B >Example 4-7. Bugzilla Groups</B ></P ><P -CLASS="LITERALLAYOUT" ->Bugzilla Groups example<br> +CLASS="literallayout" +><br> +Bugzilla Groups example<br> -----------------------<br> <br> For this example, let us suppose we have four groups, call them<br> |