[Bps-public-commit] rt-onlinedocs branch, master, updated. 0.10-12-g03bf1b8

Thu Oct 27 11:23:10 EDT 2011

The branch, master has been updated
       via  03bf1b8e80910d6c53e61d8dfcd39c67045fd375 (commit)
       via  d30c2315961b88207b7c6507d3c569b154ee2a99 (commit)
      from  9ac0e6444f24cc1c5ebd38964300f1c82f2a1956 (commit)

Summary of changes:
 META.yml             |    6 +++-
 Makefile.PL          |    5 +--
 README               |   47 ++++++++++++++++++++++++++++++++--------
 lib/RT/OnlineDocs.pm |   57 ++++++++++++++++++++++++++++++++++++++++++++++++-
 4 files changed, 98 insertions(+), 17 deletions(-)

- Log -----------------------------------------------------------------
commit d30c2315961b88207b7c6507d3c569b154ee2a99
Author: Kevin Falcone <falcone at bestpractical.com>
Date:   Thu Oct 27 11:22:13 2011 -0400

    Shove the README into lib and generate it

diff --git a/META.yml b/META.yml
index 434af55..b47ee62 100644
--- a/META.yml
+++ b/META.yml
@@ -1,7 +1,7 @@
 ---
-abstract: 'Display RT API documentation online'
+abstract: 'RT OnlineDocs Extension'
 author:
-  - 'Jesse Vincent <jesse at bestpractical.com>'
+  - 'Jesse Vincent - <jesse at bestpractical.com>'
 build_requires:
   ExtUtils::MakeMaker: 6.42
 configure_requires:
@@ -24,4 +24,6 @@ requires:
   File::Temp: 0
   Pod::Simple::HTML: 0
   perl: 5.8.3
+resources:
+  license: http://opensource.org/licenses/gpl-license.php
 version: 0.10
diff --git a/Makefile.PL b/Makefile.PL
index dc1adec..ddcc082 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -1,8 +1,7 @@
 use inc::Module::Install;
 RTx('RT-OnlineDocs');
-version_from ('lib/RT/OnlineDocs.pm');
-author('Jesse Vincent <jesse at bestpractical.com>');
-abstract('Display RT API documentation online');
+readme_from ('lib/RT/OnlineDocs.pm');
+all_from ('lib/RT/OnlineDocs.pm');
 
 requires_rt('4.0.0');
 perl_version('5.8.3');
diff --git a/README b/README
index 509b247..8409bb4 100644
--- a/README
+++ b/README
@@ -1,14 +1,38 @@
-RT::OnlineDocs adds a "Developer Documentation" menu to the RT user interface.
-This tool provides a browsable user interface to the RT API documentation for
-the running RT instance. I'm indebted to Autrijus Tang who contributed the
-first version of this code.
+NAME
+    RT-OnlineDocs - Provides a browseable interface to the developer
+    documentation
 
-In RT 3.8.0 and newer you can enable and disable estension using @Plugins option:
+DESCRIPTION
+    RT::OnlineDocs adds a "Developer Documentation" menu to the RT user
+    interface. This tool provides a browsable user interface to the RT API
+    documentation for the running RT instance. I'm indebted to Audrey Tang
+    who contributed the first version of this code.
 
-    Set( @Plugins, 'RT::OnlineDocs' );
+INSTALLATION
+    perl Makefile.PL
+    make
+    make install
+        May need root permissions
 
-Be sure to stop and start your webserver to fully enable this RT extension
+    Edit your /opt/rt4/etc/RT_SiteConfig.pm
+        Add this line:
+
+            Set(@Plugins, qw(RT::OnlineDocs));
+
+        or add "RT::OnlineDocs" to your existing @Plugins line.
+
+    Clear your mason cache
+            rm -rf /opt/rt4/var/mason_data/obj
+
+    Restart your webserver
+
+AUTHOR
+    Jesse Vincent - <jesse at bestpractical.com> Audrey Tang -
+    <audreyt at audreyt.org>
+
+LICENCE AND COPYRIGHT
+    This software is copyright (c) 1996-2011 by Best Practical Solutions.
+
+    This module is free software; you can redistribute it and/or modify it
+    under the terms of version 2 of the GNU General Public License.
 
-    Jesse Vincent
-    <jesse at bestpractical.com>
-    Best Practical Solutions, LLC
diff --git a/lib/RT/OnlineDocs.pm b/lib/RT/OnlineDocs.pm
index 431c14f..319c376 100644
--- a/lib/RT/OnlineDocs.pm
+++ b/lib/RT/OnlineDocs.pm
@@ -1,5 +1,55 @@
-# Copyright 1996-2008 Best Practical Solutions, LLC
-#
+=head1 NAME
+
+RT-OnlineDocs - Provides a browseable interface to the developer documentation
+
+=head1 DESCRIPTION
+
+RT::OnlineDocs adds a "Developer Documentation" menu to the RT user interface.
+This tool provides a browsable user interface to the RT API documentation for
+the running RT instance. I'm indebted to Audrey Tang who contributed the
+first version of this code.
+
+=head1 INSTALLATION
+
+=over
+
+=item perl Makefile.PL
+
+=item make
+
+=item make install
+
+May need root permissions
+
+=item Edit your /opt/rt4/etc/RT_SiteConfig.pm
+
+Add this line:
+
+    Set(@Plugins, qw(RT::OnlineDocs));
+
+or add C<RT::OnlineDocs> to your existing C<@Plugins> line.
+
+=item Clear your mason cache
+
+    rm -rf /opt/rt4/var/mason_data/obj
+
+=item Restart your webserver
+
+=back
+
+=head1 AUTHOR
+
+Jesse Vincent - <jesse at bestpractical.com>
+Audrey Tang - <audreyt at audreyt.org>
+
+=head1 LICENCE AND COPYRIGHT
+
+This software is copyright (c) 1996-2011 by Best Practical Solutions.
+
+This module is free software; you can redistribute it and/or
+modify it under the terms of version 2 of the GNU General Public License.
+
+=cut
 
 use strict;
 use warnings;

commit 03bf1b8e80910d6c53e61d8dfcd39c67045fd375
Author: Kevin Falcone <falcone at bestpractical.com>
Date:   Thu Oct 27 11:23:01 2011 -0400

    Add a note about our change to 4.0 only

diff --git a/README b/README
index 8409bb4..3c1b703 100644
--- a/README
+++ b/README
@@ -9,6 +9,9 @@ DESCRIPTION
     who contributed the first version of this code.
 
 INSTALLATION
+    This extension is intended for RT4 only. If you wish to run this
+    extension on RT 3.8 or earlier, please install version .10.
+
     perl Makefile.PL
     make
     make install
diff --git a/lib/RT/OnlineDocs.pm b/lib/RT/OnlineDocs.pm
index 319c376..00ae838 100644
--- a/lib/RT/OnlineDocs.pm
+++ b/lib/RT/OnlineDocs.pm
@@ -11,6 +11,9 @@ first version of this code.
 
 =head1 INSTALLATION
 
+This extension is intended for RT4 only. If you wish to run this
+extension on RT 3.8 or earlier, please install version .10.
+
 =over
 
 =item perl Makefile.PL

-----------------------------------------------------------------------

