Jenkins Build Failure Analyzer info

Add information on how to use the Build
Failure Analyzer plugin for Jenkins

Issue: RELENG-3067
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Change-Id: I026c98ed94352c21030587b64bf1909fc9322473

diff --git a/docs/_static/jenkins-build-analyzer-causes.png b/docs/_static/jenkins-build-analyzer-causes.png
new file mode 100644 (file)
index 0000000..a561f78
Binary files /dev/null and b/docs/_static/jenkins-build-analyzer-causes.png differ

diff --git a/docs/_static/jenkins-build-analyzer-new-cause.png b/docs/_static/jenkins-build-analyzer-new-cause.png
new file mode 100644 (file)
index 0000000..e589602
Binary files /dev/null and b/docs/_static/jenkins-build-analyzer-new-cause.png differ

diff --git a/docs/index.rst b/docs/index.rst
index fcb3f09..d1e5f54 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,6 +20,7 @@ Guides:
    gpg
    jenkins
    jenkins-sandbox
+   jenkins-build-failure-analyzer
    project-documentation
    nexus2
    nexus3

diff --git a/docs/jenkins-build-failure-analyzer.rst b/docs/jenkins-build-failure-analyzer.rst
new file mode 100644 (file)
index 0000000..9529873
--- /dev/null
+++ b/docs/jenkins-build-failure-analyzer.rst
@@ -0,0 +1,89 @@
+.. _jenkins-build-failure-analyzer:
+
+##############################
+Jenkins Build Failure Analyzer
+##############################
+
+The Build Failure Analyzer Jenkins plugin analyzes the causes of failed builds and
+presents the causes on the build page.
+
+It does this by using a knowledge base of build failure causes maintained from scratch.
+
+
+Plugin Documentation
+====================
+
+Official plugin documentation:
+https://plugins.jenkins.io/build-failure-analyzer/
+
+``Make sure your Jenkins server has this plugin installed before proceeding.``
+
+
+Plugin Permissions
+==================
+
+To configure the Build Failure Analyzer plugin's permissions select:
+``Manage Jenkins`` -> ``Configure Global Security`` -> ``Authorization`` section
+
+The table under the Authorization section will show the ``Build Failure Analyzer``
+column.
+
+Users and/or groups can add or remove the following permissions:
+
+* View Causes
+* Update Causes
+* Remove Causes
+
+
+View Causes
+===========
+
+Depending on the permissions granted to the groups to use the Build Failure Analyzer,
+users will be able to see the ``Failure Cause Management`` option in the left side menu
+in Jenkins.
+
+This option will display the current causes in a table with:
+
+* Name
+* Categories
+* Description
+* Comment
+* Modified
+* Remove Cause Icon (Depending on permissions)
+
+.. image:: _static/jenkins-build-analyzer-causes.png
+   :scale: 100 %
+   :alt: Jenkins Failure Cause Management table.
+   :align: center
+
+
+Update Causes
+=============
+
+The ``Create New`` option adds a new cause.
+
+A new cause will require the following information:
+
+* Name
+* Description
+* Comment
+* Categories (It will autocomplete for any existing categories)
+* Indications (What to look for in the log. Regex pattern or text)
+* Modification history (Date, time and username)
+
+.. image:: _static/jenkins-build-analyzer-new-cause.png
+   :scale: 100 %
+   :alt: Jenkins Create New Build Cause.
+   :align: center
+
+To update an existing cause, click on a cause's name from the current table.
+
+
+Delete Causes
+=============
+
+The last column of the causes table will show a remove icon for those groups with permissions
+to Remove Causes. No icon will appear if this permission is not granted.
+
+The same Remove option will appear if the user clicks on the name of any of the causes in the
+table.