From: Christian Walde Date: Mon, 4 Mar 2013 13:28:33 +0000 (+0100) Subject: Move DocMap link to top of DBIx::Class to prevent it being missed X-Git-Tag: v0.08210~30 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=06752a03d;p=dbsrgits%2FDBIx-Class.git Move DocMap link to top of DBIx::Class to prevent it being missed Reorganize the section to be a bit more comprehensive --- diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 31af611..ef0717d 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -99,9 +99,20 @@ sub _attr_cache { DBIx::Class - Extensible and flexible object <-> relational mapper. -=head1 GETTING HELP/SUPPORT +=head1 WHERE TO START READING -The community can be found via: +See L for an overview of the exhaustive documentation. +To get the most out of DBIx::Class with the least confusion it is strongly +recommended to read (at the very least) the +L in the order presented there. + +=head1 HOW TO GET HELP + +Due to the complexity of its problem domain, DBIx::Class is a relatively +complex framework. After you start using DBIx::Class questions will inevitably +arise. If you are stuck with a problem or have doubts about a particular +approach do not hesitate to contact the community with your questions. The +list below is sorted by "fastest response time": =over @@ -112,21 +123,34 @@ The community can be found via: =item * Mailing list: L -=item * Twitter L +=item * RT Bug Tracker: L + +=item * Twitter: L =item * Web Site: L -=item * RT Bug Tracker: L - =back -The project is maintained in a git repository, accessible from the following sources: +=head1 HOW TO CONTRIBUTE + +Contributions are always welcome, in all usable forms (we especially +welcome documentation improvements). The delivery methods include git- +or unified-diff formatted patches, GitHub pull requests, or plain bug +reports either via RT or the Mailing list. Contributors are generally +granted full access to the official repository after their first patch +passes successful review. + +=for comment +FIXME: Getty, frew and jnap need to get off their asses and finish the contrib section so we can link it here ;) + +This project is maintained in a git repository. The code and related tools are +accessible at the following locations: =over -=item * git: L +=item * official repo: L -=item * gitweb: L +=item * official gitweb: L =item * github mirror: L @@ -135,7 +159,7 @@ The project is maintained in a git repository, accessible from the following sou =item * Travis-CI log: L =for html - +
↪ Stable branch CI status: =back @@ -273,11 +297,6 @@ The test suite is quite substantial, and several developer releases are generally made to CPAN before the branch for the next release is merged back to trunk for a major release. -=head1 WHERE TO GO NEXT - -L lists each task you might want help on, and -the modules where you will find documentation. - =head1 AUTHOR mst: Matt S. Trout