Hi folks!

this is an introductory email about the software we currently have, what
it does and how. For write-access to repos, please see:
https://gitbox.apache.org/setup/

KIBBLE-SCANNERS: https://github.com/apache/kibble-scanners.git
the kibble-scanners repo contains the scanning applications that gather
data for the main server. They are essentially tiny plugins managed by a
main application (kibble-scanner.py) and gather what they figure they
can find about a data source. They connect to the master server, fetch a
list of data sources to analyse, and then each plugin decides whether it
wants to work with that source, sorted by a run-order (so that fetching
a git repo happens before analysing it etc). They then collect and
formalize data objects, which can be an email, a commit, a person, an
issue etc, and pass all that back to the main server's database.

KIBBLE: https://github.com/apache/kibble.git
This is the main server and UI for Kibble. It consists of four parts parts:
- A database (ElasticSearch)
- An OpenAPI-driven WSGI interface for displaying pages and operating
the JSON API (as well as printing the API docs).
- A user interface for managing the database, user accounts and
requesting visualizations
- A visualization library for displaying all the various charts.

Everything backend in Kibble is using Python 3. Everything frontend is
using CoffeeScript transpiled to JavaScript.

KIBBLE-WEBSITE: https://github.com/apache/kibble-website.git
This is our project web site. It uses the generate.py in the src folder
to generate html from the markdown source. see BUILDING.txt there.


The data structure in Kibble and Kibble-scanners explain a lot about how
they work, but I do plan to add a lot more documentation to the process.
Also, if someone could help with a "how to contribute" sort of document
for the web site and repos, that would help a lot!

More emails to come :)

With regards,
Daniel.

Reply via email to