[kibble] branch master updated: more docco changes

[hu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kibble.git


The following commit(s) were added to refs/heads/master by this push:
     new 6c1e01a  more docco changes
6c1e01a is described below

commit 6c1e01a6cf4f1377280208736b4738e7f82a87dc
Author: Daniel Gruno <hu...@apache.org>
AuthorDate: Fri Jan 12 19:55:54 2018 +0100

    more docco changes
---
 docs/source/managing.rst | 66 +++++++++++++++++++++++++++++++++++++++++++++++-
 docs/source/setup.rst    |  5 ++++
 2 files changed, 70 insertions(+), 1 deletion(-)

diff --git a/docs/source/managing.rst b/docs/source/managing.rst
index e4975f6..88b3ad5 100644
--- a/docs/source/managing.rst
+++ b/docs/source/managing.rst
@@ -31,8 +31,72 @@ users to it.
 Configuring Data Sources
 ************************
 
-TODO
+After you have created an organisation, you can add sources to it.
+A source is a destination to scan; it can be a git repository, a
+JIRA instance, a mailing list and so on. To start adding sources, click
+on the `Sources` tab in the left hand menu on the `Organisation` page.
 
+With all resource types, you can speed up things by adding multiple
+sources in one go by simply adding one source per line in the source
+text field.
+
+The currently supported resource types are:
+
+GitHub
+   This resource consists of GitHub repositories as well as issues/PRs
+   that are contained within. Currently, you will need to add the full
+   URL to the repo, including the `.git` part of it, such as:
+   ``https://github.com/apache/clerezza.git``.
+   **NOTE**: If you intend to use more than 60 API calls per hour, which
+   you probably do, you will need to add the credentials of a GitHub
+   user to the source, in order to get a higher rate limit of 6,000 API
+   calls per hour. You may use any anonymous account for this.
+
+Git
+   This is a plain git repository (such as those served by the standard
+   git daemon), and only scans repositories, not PRs/Issues. If basic
+   auth is required, fill our the user/pass credentials, otherwise leave
+   it blank.
+
+PiperMail
+   This is the standard MailMan 2.x list service. The URL should be the
+   full path to the directory that shows the various months
+
+Pony Mail
+   This is a Pony Mail list. It should be in the form of
+   `list.html?foo@bar.baz` and you *should* include a session cookie in
+   order to bypass email address anonymization where applicable. If the
+   Pony Mail instance does not apply anonymization, you may leave the
+   cookie blank.
+
+Gerrit
+   This is a gerrit code review resource, and will scan for tickets,
+   authors etc.
+
+BugZilla
+   This is a BugZilla ticket instance. You should add one source for
+   each BugZilla project you wish to scan. It should point to the
+   JSONRPC CGI file followed by the project you wish to scan.
+   If you wish to just add everything as one source,
+   you can do so by pointing it at ``jsonrpc.cgi *`` which will scan
+   everything in the BugZilla database. If you want to be able to
+   look at individual projects, it's recommended that you scan them
+   individually.
+
+JIRA
+   This is a JIRA project. Most JIRA instances will require the login
+   credentials of an anonymous account in order to perform API calls.
+   
+Twitter
+   This is a Twitter account. Currently not much done there. WIP.
+   
+SVN
+   This is a Subversion directory. It currently does nothing :(
+
+
+Once you have added the resource URLs you wish to analyse, you
+can obtain data by following the instructions in the chapter
+:ref:`runscan`
 
 ****************
 Adding New Users
diff --git a/docs/source/setup.rst b/docs/source/setup.rst
index a4f6711..e8862d1 100644
--- a/docs/source/setup.rst
+++ b/docs/source/setup.rst
@@ -217,6 +217,7 @@ last machine. This will balance the load and storage requirements evenly
 across all machines.
 
 
+.. _runscan:
 
 **************
 Running a Scan
@@ -235,3 +236,7 @@ resource that matches the appropriate type. The collected data will be
 pushed to the main data server and be available for visualizations
 instantly.
 
+It may be worth your while to run the scanner inside a timer wrapper,
+as such: ``time python3 src/kibble-scanner.py`` in order to gauge the
+amount of time a scan will take, and adjusting your cron jobs to match
+this.

-- 
To stop receiving notification emails like this one, please contact
['"commits@kibble.apache.org" <co...@kibble.apache.org>'].