diff options
Diffstat (limited to 'docs/en')
| -rw-r--r-- | docs/en/rst/about/index.rst | 15 | ||||
| -rw-r--r-- | docs/en/rst/administering/extensions.rst | 2 | ||||
| -rw-r--r-- | docs/en/rst/administering/keywords.rst | 2 | ||||
| -rw-r--r-- | docs/en/rst/administering/parameters.rst | 10 | ||||
| -rw-r--r-- | docs/en/rst/api/core/v1/bug.rst | 9 | ||||
| -rw-r--r-- | docs/en/rst/api/core/v1/bugzilla.rst | 4 | ||||
| -rw-r--r-- | docs/en/rst/api/core/v1/product.rst | 4 | ||||
| -rw-r--r-- | docs/en/rst/integrating/extensions.rst | 10 | ||||
| -rw-r--r-- | docs/en/rst/integrating/faq.rst | 4 | ||||
| -rw-r--r-- | docs/en/rst/integrating/languages.rst | 2 | ||||
| -rw-r--r-- | docs/en/rst/integrating/skins.rst | 2 | ||||
| -rw-r--r-- | docs/en/rst/integrating/templates.rst | 10 | ||||
| -rw-r--r-- | docs/en/rst/using/creating-an-account.rst | 4 | ||||
| -rw-r--r-- | docs/en/rst/using/extensions.rst | 2 | ||||
| -rw-r--r-- | docs/en/rst/using/filing.rst | 13 | ||||
| -rw-r--r-- | docs/en/rst/using/finding.rst | 4 | ||||
| -rw-r--r-- | docs/en/rst/using/understanding.rst | 2 |
17 files changed, 54 insertions, 45 deletions
diff --git a/docs/en/rst/about/index.rst b/docs/en/rst/about/index.rst index cdcea4d15..82e6830a0 100644 --- a/docs/en/rst/about/index.rst +++ b/docs/en/rst/about/index.rst @@ -17,11 +17,16 @@ The most current version of this document can always be found on the Evaluating Bugzilla ################### -If you want to try out Bugzilla to see if it meets your needs, you can do so -on `Landfill <https://landfill.bugzilla.org/bugzilla-4.4-branch/>`_, our test -server. The `Bugzilla FAQ <https://wiki.mozilla.org/Bugzilla:FAQ>`_ may also -be helpful, as it answers a number of questions people sometimes have about -whether Bugzilla is for them. +If you want to try out Bugzilla to see if it meets your needs, you can do so on +`Mozilla’s Bugzilla (BMO) test server <https://bugzilla-dev.allizom.org/>`_, +though it comes with various Mozilla-specific customizations. The easiest way to +explore the admin tools and more is `running a minimum local copy of BMO +<https://github.com/mozilla-bteam/bmo/blob/master/README.rst>`_ using Vagrant or +Docker. We are not offering any online vanilla test environment at this time. + +The `Bugzilla FAQ <https://wiki.mozilla.org/Bugzilla:FAQ>`_ may also be helpful, +as it answers a number of questions people sometimes have about whether Bugzilla +is for them. .. _getting-help: diff --git a/docs/en/rst/administering/extensions.rst b/docs/en/rst/administering/extensions.rst index 2c54b8463..62c7ec03d 100644 --- a/docs/en/rst/administering/extensions.rst +++ b/docs/en/rst/administering/extensions.rst @@ -14,5 +14,5 @@ last time you compiled the documentation): .. toctree:: :maxdepth: 1 :glob: - + ../extensions/*/index-admin diff --git a/docs/en/rst/administering/keywords.rst b/docs/en/rst/administering/keywords.rst index 245bcbe4c..2582c29e4 100644 --- a/docs/en/rst/administering/keywords.rst +++ b/docs/en/rst/administering/keywords.rst @@ -7,7 +7,7 @@ The administrator can define keywords which can be used to tag and categorise bugs. For example, the keyword "regression" is commonly used. A company might have a policy stating all regressions must be fixed by the next release—this keyword can make tracking those -bugs much easier. Keywords are global, rather than per product. +bugs much easier. Keywords are global, rather than per product. Keywords can be created, edited, or deleted by clicking the "Keywords" link in the admin page. There are two fields for each keyword—the keyword diff --git a/docs/en/rst/administering/parameters.rst b/docs/en/rst/administering/parameters.rst index 0492e0070..1b657ff3c 100644 --- a/docs/en/rst/administering/parameters.rst +++ b/docs/en/rst/administering/parameters.rst @@ -29,12 +29,10 @@ utf8 you must re-run :file:`checksetup.pl` immediately afterward. announcehtml - Any text in this field will be displayed at the top of every HTML - page in this Bugzilla installation. The text is not wrapped in any - tags. For best results, wrap the text in a ``<div>`` - tag. Any style attributes from the CSS can be applied. For example, - to make the text green inside of a red box, add ``id=message`` - to the ``<div>`` tag. + Any text in this field will be displayed at the top of every HTML page in + this Bugzilla installation. The text is not wrapped in any tags. For best + results, wrap the text in a ``<p>`` tag. Any style attributes from the CSS + can be applied. ``<p class="warning">`` makes the text red. upgrade_notification Enable or disable a notification on the homepage of this Bugzilla diff --git a/docs/en/rst/api/core/v1/bug.rst b/docs/en/rst/api/core/v1/bug.rst index 53f637a67..bab2cd0e8 100644 --- a/docs/en/rst/api/core/v1/bug.rst +++ b/docs/en/rst/api/core/v1/bug.rst @@ -102,6 +102,7 @@ name type description "is_creator_accessible": true, "whiteboard": "", "dupe_of": null, + "duplicates": [], "target_milestone": "---", "cf_mulitple_select": [], "component": "SaltSprinkler", @@ -163,6 +164,8 @@ depends_on array The IDs of bugs that this bug "depends on". dupe_of int The bug ID of the bug that this bug is a duplicate of. If this bug isn't a duplicate of any bug, this will be null. +duplicates array The ids of bugs that are marked as duplicate of + this bug. estimated_time double The number of hours that it was estimated that this bug would take. If you are not in the time-tracking group, this field will not be @@ -479,9 +482,9 @@ limit int Limit the number of results returned. If the limit set by the administrator, then the maximum limit will be used instead. If you set the limit equal to zero, then all matching results will be returned instead. -longdescs.count int The number of comments a bug has. The bug's description +longdescs.count int The number of comments a bug has. The bug's description is the first comment. For example, to find bugs which someone - has commented on after they have been filed, search on + has commented on after they have been filed, search on ``longdescs.count`` *greater than* 1. offset int Used in conjunction with the ``limit`` argument, ``offset`` defines the starting position for the @@ -1202,4 +1205,4 @@ attachment_id int The ID of the attachment that was changed. This only appears if the change was to an attachment, otherwise ``attachment_id`` will not be present in this object. -============= ====== ==========================================================
\ No newline at end of file +============= ====== ========================================================== diff --git a/docs/en/rst/api/core/v1/bugzilla.rst b/docs/en/rst/api/core/v1/bugzilla.rst index e43472c30..220ee5fc5 100644 --- a/docs/en/rst/api/core/v1/bugzilla.rst +++ b/docs/en/rst/api/core/v1/bugzilla.rst @@ -312,7 +312,7 @@ Reports the status of the job queue. GET /rest/jobqueue_status -This method requires an authenticated user. +This method requires an authenticated user. **Response** @@ -328,4 +328,4 @@ name type description =============== ======= ==================================================== total integer The total number of jobs in the job queue. errors integer The number of errors produced by jobs in the queue. -=============== ======= ====================================================
\ No newline at end of file +=============== ======= ==================================================== diff --git a/docs/en/rst/api/core/v1/product.rst b/docs/en/rst/api/core/v1/product.rst index 4819bbbbe..a1f5bd3c8 100644 --- a/docs/en/rst/api/core/v1/product.rst +++ b/docs/en/rst/api/core/v1/product.rst @@ -142,6 +142,7 @@ type string The group of products to return. Valid values are ] }, "default_qa_contact": "", + "triage_owner": "", "description": "This is a test component." } ], @@ -215,6 +216,9 @@ default_assigned_to string The login name of the user to whom new bugs default_qa_contact string The login name of the user who will be set as the QA Contact for new bugs by default. Empty string if the QA contact is not defined. +triage_owner string The login name of the user who is named as the + Triage Owner of the component. Empty string if the + Triage Owner is not defined. sort_key int Components, when displayed in a list, are sorted first by this integer and then secondly by their name. diff --git a/docs/en/rst/integrating/extensions.rst b/docs/en/rst/integrating/extensions.rst index 50f204746..e9ae48630 100644 --- a/docs/en/rst/integrating/extensions.rst +++ b/docs/en/rst/integrating/extensions.rst @@ -49,7 +49,7 @@ To add new fields to a bug, you need to do the following: my $field = new Bugzilla::Field({ name => $name }); return if $field; - + $field = Bugzilla::Field->create({ name => $name, description => $description, @@ -67,12 +67,12 @@ To add new fields to a bug, you need to do the following: .. code-block:: perl - BEGIN { - *Bugzilla::Bug::is_foopy = \&_bug_is_foopy; + BEGIN { + *Bugzilla::Bug::is_foopy = \&_bug_is_foopy; } - + ... - + sub _bug_is_foopy { return $_[0]->{'is_foopy'}; } diff --git a/docs/en/rst/integrating/faq.rst b/docs/en/rst/integrating/faq.rst index 19f8b59ff..f50453df5 100644 --- a/docs/en/rst/integrating/faq.rst +++ b/docs/en/rst/integrating/faq.rst @@ -18,10 +18,10 @@ How do I... ...use a word other than 'bug' to describe bugs? :ref:`Edit or override <templates>` the appropriate values in the template :file:`template/en/default/global/variables.none.tmpl`. - + ...call the system something other than 'Bugzilla'? :ref:`Edit or override <templates>` the appropriate value in the template :file:`template/en/default/global/variables.none.tmpl`. - + ...alter who can change what field when? See :ref:`who-can-change-what`. diff --git a/docs/en/rst/integrating/languages.rst b/docs/en/rst/integrating/languages.rst index 4d087a721..d76a82a82 100644 --- a/docs/en/rst/integrating/languages.rst +++ b/docs/en/rst/integrating/languages.rst @@ -3,7 +3,7 @@ Languages Bugzilla's templates can be localized, although it's a `big job <https://wiki.mozilla.org/Bugzilla:L10n:Guide>`_. If you have -a localized set of templates for your version of Bugzilla, Bugzilla can +a localized set of templates for your version of Bugzilla, Bugzilla can support multiple languages at once. In that case, Bugzilla honours the user's ``Accept-Language`` HTTP header when deciding which language to serve. If multiple languages are installed, a menu will display in the header allowing diff --git a/docs/en/rst/integrating/skins.rst b/docs/en/rst/integrating/skins.rst index 2cd08b4c0..92bf60dfc 100644 --- a/docs/en/rst/integrating/skins.rst +++ b/docs/en/rst/integrating/skins.rst @@ -11,7 +11,7 @@ are a couple more which are part of `bugzilla.mozilla.org <http://git.mozilla.org/?p=webtools/bmo/bugzilla.git>`_. However, in each case you may need to check that the skin supports the version of Bugzilla -you have. +you have. To create a new custom skin, make a directory that contains all the same CSS file names as :file:`skins/standard/`, and put your directory in diff --git a/docs/en/rst/integrating/templates.rst b/docs/en/rst/integrating/templates.rst index ee2c08e92..e563d8179 100644 --- a/docs/en/rst/integrating/templates.rst +++ b/docs/en/rst/integrating/templates.rst @@ -49,7 +49,7 @@ modifications, and the method you plan to use to upgrade Bugzilla. #. You can use the hooks built into many of the templates to add or modify the UI from an :ref:`extension <extensions>`. Hooks generally don't go away - and have a stable interface. + and have a stable interface. The third method is the best if there are hooks in the appropriate places and the change you want to do is possible using hooks. It's not very easy @@ -89,7 +89,7 @@ can't if you fork the file into the :file:`custom` directory. How To Edit Templates ===================== -.. note:: If you are making template changes that you intend on submitting +.. note:: If you are making template changes that you intend on submitting back for inclusion in standard Bugzilla, you should read the relevant sections of the `Developers' Guide <https://www.bugzilla.org/docs/developer.html>`_. @@ -111,7 +111,7 @@ to cross-site scripting attacks. You should run :command:`./checksetup.pl` after editing any templates. Failure to do so may mean either that your changes are not picked up, or that the -permissions on the edited files are wrong so the webserver can't read them. +permissions on the edited files are wrong so the webserver can't read them. .. _template-formats: @@ -232,11 +232,11 @@ customizing for your installation. and have their values appear formatted in the initial comment. An example of this is the `guided bug submission form - <http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi?product=WorldControl;format=guided>`_. + <https://bugzilla-dev.allizom.org/enter_bug.cgi?product=Firefox&format=guided>`_. The code for this comes with the Bugzilla distribution as an example for you to copy. It can be found in the files :file:`create-guided.html.tmpl` and :file:`comment-guided.html.tmpl`. - + A hidden field that indicates the format should be added inside the form in order to make the template functional. Its value should be the suffix of the template filename. For example, if the file diff --git a/docs/en/rst/using/creating-an-account.rst b/docs/en/rst/using/creating-an-account.rst index 0ea42ee5d..3d70096f5 100644 --- a/docs/en/rst/using/creating-an-account.rst +++ b/docs/en/rst/using/creating-an-account.rst @@ -6,8 +6,8 @@ Creating an Account If you want to use a particular installation of Bugzilla, first you need to create an account. Ask the administrator responsible for your installation for the URL you should use to access it. If you're test-driving Bugzilla, -you can use one of the installations on -`Landfill <http://landfill.bugzilla.org/>`_. +you can use one of the installations on `Mozilla’s Bugzilla (BMO) test server +<https://bugzilla-dev.allizom.org/>`_. The process of creating an account is similar to many other websites. diff --git a/docs/en/rst/using/extensions.rst b/docs/en/rst/using/extensions.rst index 752b50b9a..28bae5be5 100644 --- a/docs/en/rst/using/extensions.rst +++ b/docs/en/rst/using/extensions.rst @@ -14,5 +14,5 @@ last time you compiled the documentation): .. toctree:: :maxdepth: 1 :glob: - + ../extensions/*/index-user diff --git a/docs/en/rst/using/filing.rst b/docs/en/rst/using/filing.rst index 788cebbd5..a76e3faed 100644 --- a/docs/en/rst/using/filing.rst +++ b/docs/en/rst/using/filing.rst @@ -7,18 +7,17 @@ Reporting a New Bug =================== Years of bug writing experience has been distilled for your -reading pleasure into the -`Bug Writing Guidelines <http://landfill.bugzilla.org/bugzilla-tip/page.cgi?id=bug-writing.html>`_. +reading pleasure into the `Bug report writing guidelines +<https://developer.mozilla.org/docs/Mozilla/QA/Bug_writing_guidelines>`_. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs and isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. -.. note:: If you want to file a test bug to see how Bugzilla works, - you can do it on one of our test installations on - `Landfill <http://landfill.bugzilla.org/>`_. Please don't do it on anyone's - production Bugzilla installation. +.. note:: If you want to file a test bug to see how Bugzilla works, you can do + so on `Mozilla’s Bugzilla (BMO) test server <https://bugzilla-dev.allizom.org/>`_. + Please don’t do it on any production Bugzilla installation. The procedure for filing a bug is as follows: @@ -46,7 +45,7 @@ The procedure for filing a bug is as follows: developers easier, and the probability that they consider your bug in a reasonable timeframe will be much higher. - .. note:: Try to make sure that everything in the Summary is also in the + .. note:: Try to make sure that everything in the Summary is also in the Description. Summaries are often updated and this will ensure your original information is easily accessible. diff --git a/docs/en/rst/using/finding.rst b/docs/en/rst/using/finding.rst index 44d4003dc..baf2d9076 100644 --- a/docs/en/rst/using/finding.rst +++ b/docs/en/rst/using/finding.rst @@ -43,8 +43,8 @@ Advanced Search =============== The Advanced Search page is used to produce a list of all bugs fitting -exact criteria. `You can play with it on -Landfill <http://landfill.bugzilla.org/bugzilla-tip/query.cgi?format=advanced>`_. +exact criteria. You can play with it on `Mozilla’s Bugzilla (BMO) test server +<https://bugzilla-dev.allizom.org/query.cgi?format=advanced>`_. Advanced Search has controls for selecting different possible values for all of the fields in a bug, as described above. For some diff --git a/docs/en/rst/using/understanding.rst b/docs/en/rst/using/understanding.rst index c52bd2167..958d4baae 100644 --- a/docs/en/rst/using/understanding.rst +++ b/docs/en/rst/using/understanding.rst @@ -26,7 +26,7 @@ installation of Bugzilla. *Product and Component*: Bugs are divided up by Product and Component, with a Product - having one or more Components in it. + having one or more Components in it. *Version:* The "Version" field usually contains the numbers or names of released |