MozReview: Remove rbbz documentation (Bug 1262548). r?smacleod draft
authorDavid Walsh <dwalsh@mozilla.com>
Fri, 29 Apr 2016 12:51:29 -0500
changeset 8484 898c76e634748699818422d5cb0fbe5205fe5658
parent 8483 1566a5911f1b607eff5f66d0f1cef160990e7726
child 8485 bf277a5218008275f9bdc4c09a93f32feacb6823
push id917
push userbmo:dwalsh@mozilla.com
push dateThu, 09 Jun 2016 17:49:07 +0000
reviewerssmacleod
bugs1262548
MozReview: Remove rbbz documentation (Bug 1262548). r?smacleod MozReview-Commit-ID: AXIN99Nsogo
docs/rbbz/rbbz.rst
pylib/rbbz/README.md
deleted file mode 100644
--- a/docs/rbbz/rbbz.rst
+++ /dev/null
@@ -1,94 +0,0 @@
-rbbz package
-============
-
-Submodules
-----------
-
-rbbz.auth module
-----------------
-
-.. automodule:: rbbz.auth
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.bugzilla module
---------------------
-
-.. automodule:: rbbz.bugzilla
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.diffs module
------------------
-
-.. automodule:: rbbz.diffs
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.errors module
-------------------
-
-.. automodule:: rbbz.errors
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.extension module
----------------------
-
-.. automodule:: rbbz.extension
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.forms module
------------------
-
-.. automodule:: rbbz.forms
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.middleware module
-----------------------
-
-.. automodule:: rbbz.middleware
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.models module
-------------------
-
-.. automodule:: rbbz.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.resources module
----------------------
-
-.. automodule:: rbbz.resources
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-rbbz.transports module
-----------------------
-
-.. automodule:: rbbz.transports
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: rbbz
-    :members:
-    :undoc-members:
-    :show-inheritance:
deleted file mode 100644
--- a/pylib/rbbz/README.md
+++ /dev/null
@@ -1,51 +0,0 @@
-rbbz: Review Board extension for Bugzilla support
-=================================================
-
-rbbz is a [Review Board extension][] that integrates a Bugzilla user
-database.  It adds an authentication back end, which, when enabled,
-authenticates against Bugzilla's XMLRPC API instead of the local
-Review Board database.  When active, Review Board's User List web API,
-used by the UI's autosuggest, also queries Bugzilla.
-
-
-Installation
-------------
-
-As described in Review Board's [extension installation docs][],
-install rbbz like any other Python package, e.g.
-
-    pip install rbbz
-
-In the Review Board admin UI, go to the Extensions page and enable
-rbbz.  You'll then have to go to the Authentication settings and
-change the Authentication Method to "Bugzilla".  A setting for
-"Bugzilla XMLRPC URL" will appear.  Enter the URL to your Bugzilla
-installation's XMLPRC API, e.g. https://bugzilla.yourdomain/xmlrpc.cgi.
-
-At this point you should be able to log out and log back in with your
-Bugzilla credentials.  Similarly, when you choose people for a review,
-the autosuggest should return results from the Bugzilla user database.
-
-
-Technical Notes
----------------
-
-In order to stay generic, Review Board's User List web API always
-searches the local database.  To provide support for Bugzilla, rbbz
-overrides a function called early in the User List function in order
-to send a user-search query to Bugzilla.  It then writes the results
-to the Review Board user table, updating existing entries and creating
-new ones when needed.
-
-
-To Do
------
-
-* Support for Bugzilla's REST API (as an option, so older Bugzilla
-  systems are still supported).
-
-* Caching in User List to avoid always searching the Bugzilla
-  database, if possible.
-
-[Review Board extension]: http://www.reviewboard.org/docs/manual/dev/extending/
-[extension installation docs]: http://www.reviewboard.org/docs/manual/dev/admin/extensions/#installing-extensions