-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This one is in the project meta-repository readme, so it should be a bit easier to find.
- Loading branch information
Showing
1 changed file
with
105 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,105 @@ | ||
# cpantesters-project | ||
A meta-project for tracking CPAN Testers project goals | ||
|
||
# The CPANTesters Project | ||
|
||
A meta-project for tracking CPAN Testers project goals. [See the Issues | ||
for project tracking or to see how you can get | ||
involved](https://github.com/cpan-testers/cpantesters-project/issues) | ||
|
||
## Project Overview | ||
|
||
|
||
## Repositories | ||
|
||
These are the repositories that are meta-managed by this repository. | ||
|
||
### Metabase | ||
|
||
Metabase is the primary source for CPAN Testers reports. Reporters write | ||
directly to the Metabase to send in reports. This replaces the original | ||
reports which were sent via e-mail. | ||
|
||
* [Metabase](https://github.com/rjbs/metabase) | ||
* The main Metabase repository. | ||
* [Metabase::Fact](https://github.com/dagolden/Metabase-Fact) | ||
* The core model that is stored in the Metabase. The Metabase | ||
consists of a collection of Metabase Facts. | ||
* [Metabase::Web](https://github.com/dagolden/metabase-web) | ||
* The Metabase web application <http://metabase.cpantesters.org>. | ||
|
||
### CPANTesters | ||
|
||
These are the modules that comprise the CPANTesters application, | ||
including the backend ETL which loads and parses reports from Metabase | ||
and the web application that displays reports and statistics. | ||
|
||
#### Backend | ||
|
||
Backend modules handle processing and parsing reports. | ||
|
||
* [Data::Generator](https://github.com/barbie/cpan-testers-data-generator) | ||
* This module handles grabbing reports from the Metabase and inserting | ||
them into the correct places in the CPANTesters report database | ||
* [Data::Uploads](https://github.com/barbie/cpan-testers-data-uploads) | ||
* The Uploads database contains basic information about the history | ||
of CPAN, including the release dates of all CPAN and BackPAN | ||
modules, direct from PAUSE. | ||
* [Data::Uploads::Mailer](https://github.com/barbie/cpan-testers-data-uploads-mailer) | ||
* Send e-mails when invalid distributions are uploaded to CPAN | ||
* [Data::Release](https://github.com/barbie/CPAN-Testers-Data-Release) | ||
* Create a standalone database from the release summary information. | ||
|
||
#### Frontend | ||
|
||
Frontend modules handle the web application. | ||
|
||
* [WWW::Reports](https://github.com/barbie/cpan-testers-www-reports) | ||
* This handles the [main reports website | ||
(cpantesters.org)](http://cpantesters.org), which allows for viewing | ||
individual reports, and listing reports by distribution and author. | ||
This is the primary application of CPANTesters. | ||
* [WWW::Admin](https://github.com/barbie/cpan-testers-www-admin) | ||
* This handles the [administration website | ||
(admin.cpantesters.org)](http://admin.cpantesters.org), which allows | ||
CPAN authors and testers to flag reports which may have been sent in | ||
error. For example, authors can flag reports that were generated by | ||
a misconfigured CPAN client and are a problem with the client and | ||
not the distribution. | ||
* [WWW::Statistics](https://github.com/barbie/cpan-testers-www-statistics) | ||
* The [CPANTesters Statistics | ||
website](https://github.com/barbie/cpan-testers-www-statistics), | ||
which shows lots of useful metrics like how many testers, which | ||
versions of Perl, which OSes, and etc... | ||
* [WWW::Preferences](https://github.com/barbie/cpan-testers-www-preferences) | ||
* The [CPANTesters Preferences | ||
website](https://prefs.cpantesters.org/) which allows authors and | ||
testers to configure how CPANTesters sends them reports and which | ||
reports get sent. | ||
|
||
#### Clients | ||
|
||
These modules provide APIs to fetch information from the CPANTesters web | ||
app. | ||
|
||
* [CPAN::Testers::WWW::Reports::Query::AJAX](https://metacpan.org/pod/CPAN::Testers::WWW::Reports::Query::AJAX) | ||
* Fetch CPANTesters results using AJAX, including aggregate results | ||
and individual report details. | ||
* [CPAN::Testers::WWW::Reports::Query::Report](https://github.com/barbie/cpan-testers-www-reports-query-report) | ||
* Access individual reports from the CPANTesters Reports website. | ||
|
||
#### Meta | ||
|
||
These repositories are related to the CPANTesters application. | ||
|
||
* [cpantesters-deploy](http://github.com/cpan-testers/cpantesters-deploy) | ||
* Automated deployment for the CPANTesters servers, along with | ||
a special deployment for development virtual machines. | ||
|
||
### Reporters | ||
|
||
Reporters send test reports to the Metabase. These can be used to set up | ||
your own CPANTesters smoke boxes. | ||
|
||
* [CPAN::Reporter](https://github.com/cpan-testers/CPAN-Reporter) | ||
* This reporter works with the common CPAN client (CPAN.pm which is | ||
shipped with Perl) | ||
|