diff options
Diffstat (limited to 'docs/en')
| -rw-r--r-- | docs/en/images/redhat_logo.png | bin | 0 -> 5278 bytes | |||
| -rw-r--r-- | docs/en/rst/_static/bugzilla.css | 89 | ||||
| -rw-r--r-- | docs/en/rst/administering/extensions.rst | 7 | ||||
| -rw-r--r-- | docs/en/rst/administering/parameters.rst | 9 | ||||
| -rw-r--r-- | docs/en/rst/api/core/v1/bug.rst | 16 | ||||
| -rw-r--r-- | docs/en/rst/api/index.rst | 3 | ||||
| -rw-r--r-- | docs/en/rst/conf.py | 12 | ||||
| -rw-r--r-- | docs/en/rst/integrating/extensions.rst | 2 | ||||
| -rw-r--r-- | docs/en/rst/integrating/index.rst | 1 | ||||
| -rw-r--r-- | docs/en/rst/integrating/templates.rst | 2 | ||||
| -rw-r--r-- | docs/en/rst/using/extensions.rst | 7 | ||||
| -rw-r--r-- | docs/en/rst/using/filing.rst | 6 | ||||
| -rw-r--r-- | docs/en/rst/using/finding.rst | 23 |
13 files changed, 149 insertions, 28 deletions
diff --git a/docs/en/images/redhat_logo.png b/docs/en/images/redhat_logo.png Binary files differnew file mode 100644 index 000000000..3ee786b89 --- /dev/null +++ b/docs/en/images/redhat_logo.png diff --git a/docs/en/rst/_static/bugzilla.css b/docs/en/rst/_static/bugzilla.css index 06f5c8375..ce03b8b0b 100644 --- a/docs/en/rst/_static/bugzilla.css +++ b/docs/en/rst/_static/bugzilla.css @@ -1,4 +1,5 @@ @import 'default.css'; +@import '../../../../extensions/FontAwesome/web/css/all.min.css'; dt { font-weight: bold; } @@ -19,3 +20,91 @@ dt { font-weight: bold; } display: block; margin-top: -20px; } + +div.body p, div.body dd, div.body li { + + text-align: left; +} +/* Red Hat Theming */ + +@font-face { + font-family: "Overpass"; + font-style: normal; + font-weight: 600; + src: url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_regular-web.eot?#iefix") format("eot"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_regular-web.woff") format("woff"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_regular-web.ttf") format("truetype"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_regular-web.svg#webfontLTZe4IYH") format("svg"); +} +@font-face { + font-family: "Overpass"; + font-style: normal; + font-weight: 800; + src: url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_bold-web.eot?#iefix") format("eot"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_bold-web.woff") format("woff"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_bold-web.ttf") format("truetype"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_bold-web.svg#webfontzAU82Ltw") format("svg"); +} +@font-face { + font-family: "Overpass"; + font-style: normal; + font-weight: 400; + src: url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_light-webfont.eot?#iefix") format("eot"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_light-webfont.woff") format("woff"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_light-webfont.ttf") format("truetype"), url("//access.redhat.com/webassets/avalon/f/nimbus/overpass_light-webfont.svg#webfontzAU82Ltw") format("svg"); +} + + +body { + background-color: white !important; +} + +h1, h2, h3, h4, h5, .sphinxsidebar, div.sphinxsidebar h3 { + font-family: "Overpass",Overpass,Helvetica,helvetica,arial,sans-serif !important; + word-wrap: break-word; +} + +.related { + background-color: #252527 !important; + padding: 1em 0; +} + + +.logo { + margin-top: -2px; +} + +div.document { + background-color: #6e6e6e; +} + + +div.footer, +div.footer a { + color: #000000; +} + +div.sphinxsidebar a { + color: #ffffff; +} + + +span.bz-secure::before, +span.bz-updated::before, +span.bz-requested::before, +span.bz-ignored::before { + font-family: "Font Awesome 5 Free"; + font-weight: 900; + padding-right: 2px; + font-size: x-small; + color: chocolate; +} + +/* one class */ +span.bz-updated::before { + content: "\f12a\00A0"; +} + +span.bz-ignored::before { + content: "\f6a9\00A0"; +} + +span.bz-secure::before { + content: "\f023\00A0"; +} + +span.bz-requested::before { + content: "\f128\00A0"; +} diff --git a/docs/en/rst/administering/extensions.rst b/docs/en/rst/administering/extensions.rst index 2c54b8463..32f6360b9 100644 --- a/docs/en/rst/administering/extensions.rst +++ b/docs/en/rst/administering/extensions.rst @@ -11,8 +11,5 @@ the documentation for your installed extensions will show up here. Your Bugzilla installation has the following extensions available (as of the last time you compiled the documentation): -.. toctree:: - :maxdepth: 1 - :glob: - - ../extensions/*/index-admin +.. include:: ../integrating/api/Bugzilla/Extension/index-admin.rst + diff --git a/docs/en/rst/administering/parameters.rst b/docs/en/rst/administering/parameters.rst index 7f376bbf2..6ab91737a 100644 --- a/docs/en/rst/administering/parameters.rst +++ b/docs/en/rst/administering/parameters.rst @@ -792,3 +792,12 @@ strict_transport_security * :paramval:`off` - Don't send the Strict-Transport-Security header with requests. * :paramval:`this_domain_only` - Send the Strict-Transport-Security header with all requests, but only support it for the current domain. * :paramval:`include_subdomains` - Send the Strict-Transport-Security header along with the includeSubDomains flag, which will apply the security change to all subdomains. This is especially useful when combined with an :param:`attachment_base` that exists as (a) subdomain(s) under the main Bugzilla domain. + + +.. _admin-extensions: + +Extensions +========== + +.. include:: ../integrating/api/Bugzilla/Extension/index-params.rst + diff --git a/docs/en/rst/api/core/v1/bug.rst b/docs/en/rst/api/core/v1/bug.rst index 1bf2a2006..ce9e7d842 100644 --- a/docs/en/rst/api/core/v1/bug.rst +++ b/docs/en/rst/api/core/v1/bug.rst @@ -234,13 +234,15 @@ Extra fields: These fields are returned only by specifying ``_extra`` or the field name in ``include_fields``. -==== ===== ==================================================================== -name type description -==== ===== ==================================================================== -tags array Each array item is a tag name. Note that tags are - personal to the currently logged in user and are not the same as - comment tags. -==== ===== ==================================================================== +================== ===== ====================================================== +name type description +================== ===== ====================================================== +tags array Each array item is a tag name. Note that tags are + personal to the currently logged in user and are not + the same as comment tags. +dependent_products array **RED HAT EXTENSION** Returns a list of products that + this bug affects +================== ===== ====================================================== User object: diff --git a/docs/en/rst/api/index.rst b/docs/en/rst/api/index.rst index 840bcadd1..619feeb24 100644 --- a/docs/en/rst/api/index.rst +++ b/docs/en/rst/api/index.rst @@ -11,4 +11,5 @@ the deprecated :ref:`XML-RPC and JSON-RPC APIs <api-list>` is also available. :glob: core/v*/index - ../extensions/*/api/v*/index + extensions + diff --git a/docs/en/rst/conf.py b/docs/en/rst/conf.py index 34acb4778..6d30b83ea 100644 --- a/docs/en/rst/conf.py +++ b/docs/en/rst/conf.py @@ -42,8 +42,10 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' +display_toc = True + # General information about the project. -project = u'Bugzilla' +project = u'Red Hat Bugzilla' copyright = u'2016, The Bugzilla Team' # The version info for the project you're documenting, acts as replacement for @@ -121,7 +123,7 @@ rst_epilog = """ ---------- This documentation undoubtedly has bugs; if you find some, please file -them `here <https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation>`_. +them `here <https://bugzilla.redhat.com/enter_bug.cgi?product=Bugzilla&component=Documentation>`_. """ # -- Options for HTML output --------------------------------------------------- @@ -149,7 +151,7 @@ html_style = "bugzilla.css" # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = "../images/bugzilla.png" +html_logo = "../images/redhat_logo.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -190,7 +192,7 @@ html_use_index = False html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = False @@ -391,5 +393,5 @@ if on_rtd: else: base_api_url = '../integrating/api/' -extlinks = {'bug': ('https://bugzilla.mozilla.org/show_bug.cgi?id=%s', 'bug '), +extlinks = {'bug': ('https://bugzilla.redhat.com/show_bug.cgi?id=%s', 'bug '), 'api': (base_api_url + '%s', '')} diff --git a/docs/en/rst/integrating/extensions.rst b/docs/en/rst/integrating/extensions.rst index 6a3fd8d3f..e485016a9 100644 --- a/docs/en/rst/integrating/extensions.rst +++ b/docs/en/rst/integrating/extensions.rst @@ -15,7 +15,7 @@ Or, you can write your own extension. See the :api:`Bugzilla Extension documentation <Bugzilla/Extension.html>` for the core documentation on how to do that. It would make sense to read the section on :ref:`templates`. There is also a sample extension in -:file:`$BUGZILLA_HOME/extensions/Example/` which gives examples of how to +:file:`$BUGZILLA_HOME/integrating/api/Bugzilla/Extension/Example/` which gives examples of how to use all the code hooks. This section explains how to achieve some common tasks using the Extension APIs. diff --git a/docs/en/rst/integrating/index.rst b/docs/en/rst/integrating/index.rst index 816ffe8e5..d546290a6 100644 --- a/docs/en/rst/integrating/index.rst +++ b/docs/en/rst/integrating/index.rst @@ -20,3 +20,4 @@ explains how to use the available mechanisms for integration and customization. templates extensions apis + api/index diff --git a/docs/en/rst/integrating/templates.rst b/docs/en/rst/integrating/templates.rst index f30b4a848..3ec66eac6 100644 --- a/docs/en/rst/integrating/templates.rst +++ b/docs/en/rst/integrating/templates.rst @@ -262,7 +262,7 @@ customizing for your installation. It needs a couple of lines of boilerplate at the top like this:: [% USE Bugzilla %] - [% cgi = Bugzilla.cgi % + [% cgi = Bugzilla.cgi %] Then, this template can reference the form fields you have created using the syntax ``[% cgi.param("field_name") %]``. When a bug report is diff --git a/docs/en/rst/using/extensions.rst b/docs/en/rst/using/extensions.rst index 752b50b9a..5be79bf4c 100644 --- a/docs/en/rst/using/extensions.rst +++ b/docs/en/rst/using/extensions.rst @@ -11,8 +11,5 @@ the documentation for your installed extensions will show up here. Your Bugzilla installation has the following extensions available (as of the last time you compiled the documentation): -.. toctree:: - :maxdepth: 1 - :glob: - - ../extensions/*/index-user +.. include:: ../integrating/api/Bugzilla/Extension/index-user.rst + diff --git a/docs/en/rst/using/filing.rst b/docs/en/rst/using/filing.rst index 788cebbd5..f3871804d 100644 --- a/docs/en/rst/using/filing.rst +++ b/docs/en/rst/using/filing.rst @@ -8,7 +8,7 @@ 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>`_. +`Bug Writing Guidelines </page.cgi?id=bug-writing.html>`_. 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 @@ -16,8 +16,8 @@ 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 + you can do it on test installations on + `Partner <https://partner-bugzilla.redhat.com/>`_. Please don't do it on anyone's production Bugzilla installation. The procedure for filing a bug is as follows: diff --git a/docs/en/rst/using/finding.rst b/docs/en/rst/using/finding.rst index a8e18eef2..5dcfa4e9b 100644 --- a/docs/en/rst/using/finding.rst +++ b/docs/en/rst/using/finding.rst @@ -257,3 +257,26 @@ Remember Search As: You can give a search a name and remember it; a link will appear in your page footer giving you quick access to run it again later. +.. _legend: + +Table Legend +------------ + +The bug list table contains a number of icons used to indicate attributes of a bug. + +.. role:: bz-secure +.. role:: bz-requested +.. role:: bz-updated +.. role:: bz-ignored + ++ :bz-secure:`Secure:` A secure bug is a bug that has any groups set on it. + ++ :bz-ignored:`Ignored:` An ignored bug is a bug that you have told Bugzilla not + to notify you about. + ++ :bz-updated:`Updated:` An updated bug is a bug that you are involved in that has + been updated since the last time you viewed it. "Involved" means you are one of + reporter, assignee, qa contact, or you are CC'd on the bug. + ++ :bz-requested:`Requested:` A requested bug is a bug that has flags that you are + specifically requested on. i.e. needinfo or similar targeted flags. |
