stas 02/04/29 09:27:53
Modified: src/contribute docs.pod maillist.pod share_code.pod
src/download docs.pod
Log:
- changed the prompts in docs.pod to ai%, as stated in style.pod.
- add missing descriptions
Submitted by: Per Einar Ellefsen <[EMAIL PROTECTED]>
Revision Changes Path
1.4 +14 -3 modperl-docs/src/contribute/docs.pod
Index: docs.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/contribute/docs.pod,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- docs.pod 27 Apr 2002 03:19:40 -0000 1.3
+++ docs.pod 29 Apr 2002 16:27:53 -0000 1.4
@@ -2,6 +2,11 @@
Contribute to the Documentation
+=head1 Description
+
+Once you have read the documentation provided for mod_perl, you will
+probably have some additions of your own, which are always welcome.
+
=head1 Submit Corrections
There is a lot of mod_perl documentation. And we are sure it includes
@@ -9,7 +14,7 @@
The documentation includes code examples, which sometimes were written
without testing, so it's possible that they are broken. If some
-example doesn't work for you, please, let us know.
+example doesn't work for you, please let us know.
If you notice bad grammar of English and speling, don't hesitate to
tell us where and what you think is the best way to korrectink
@@ -40,7 +45,13 @@
talking about.
If the correction is medium to large use the cvs repository and submit
-the patch against the latest version. L<This document|download::docs>
-explains how to use the cvs repository.
+the patch against the latest version, or even better, just send us the
+modified document. L<This document|download::docs> explains how to use
+the cvs repository.
+
+Note that if you for some reason cannot use the CVS repository, each
+page contains a I<src> link in the upper-right corner. From there you
+can access the POD/HTML source of documents, which you can then modify
+and send to us.
=cut
1.3 +5 -0 modperl-docs/src/contribute/maillist.pod
Index: maillist.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/contribute/maillist.pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- maillist.pod 26 Apr 2002 15:32:23 -0000 1.2
+++ maillist.pod 29 Apr 2002 16:27:53 -0000 1.3
@@ -2,6 +2,11 @@
Contribute at the Mailing List
+=head1 Description
+
+The first way to contribute to the mod_perl community is by following
+the mailing list and helping out anyone else having problems.
+
=head1 Answering Questions
Since mod_perl is an open source technology, its main support facility
1.3 +5 -0 modperl-docs/src/contribute/share_code.pod
Index: share_code.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/contribute/share_code.pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- share_code.pod 26 Apr 2002 15:32:23 -0000 1.2
+++ share_code.pod 29 Apr 2002 16:27:53 -0000 1.3
@@ -2,6 +2,11 @@
Contribute by Sharing Code
+=head1 Description
+
+Your Perl and mod_perl know-how is more than welcome as contributions
+to Apache modules or to mod_perl itself.
+
=head1 mod_perl Patches
If you have modified the mod_perl source code, improved and extended
1.4 +39 -10 modperl-docs/src/download/docs.pod
Index: docs.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/download/docs.pod,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- docs.pod 27 Apr 2002 18:45:56 -0000 1.3
+++ docs.pod 29 Apr 2002 16:27:53 -0000 1.4
@@ -5,7 +5,7 @@
=head1 Description
You may want to download and install the mod_perl documentation
-locally for easier reading.
+locally for easier reading, or to submit documentation patches.
To install the documentation you will have to install the whole site
at the same time though, but this should just be a benefit because you
@@ -19,9 +19,9 @@
CVS installed, run the following commands from the directory you want
to place the I<modperl-docs> directory in:
- % cvs -d:pserver:[EMAIL PROTECTED]:/home/cvspublic login
+ ai% cvs -d:pserver:[EMAIL PROTECTED]:/home/cvspublic login
(use the password "anoncvs")
- % cvs -d:pserver:[EMAIL PROTECTED]:/home/cvspublic co modperl-docs
+ ai% cvs -d:pserver:[EMAIL PROTECTED]:/home/cvspublic co modperl-docs
You will now find a directory called I<modperl-docs> in the current
working directory which contains all the sources needed to build the
@@ -63,17 +63,20 @@
checked out from CVS. To build the whole site, run this while being
placed in the I<modperl-docs> directory.
- % bin/build
+ ai% bin/build
This will place the site in the sub-directory I<dst_html>. You may
open I<index.html> in there to start browsing the site.
+If you are using the Windows operating system, please see the file
+I<INSTALL.win32> for some win32-specific information.
+
=head2 PDF version
Now, you can go back to your I<modperl-docs> directory. Building the
PDF version is as easy as with the HTML version, just do a simple:
- % bin/build -d
+ ai% bin/build -d
And the PDF version will be built. This is often very time-consuming
and heave on resources though. The results will be placed in
@@ -92,21 +95,47 @@
copy, and re-build the site (although it will only rebuilt modified
files).
- % cvs up
- % bin/build
+ ai% cvs up
+ ai% bin/build
Rebuilding the PDF version is just as easy, just run:
- % bin/build -d
+ ai% bin/build -d
There are some times however when a simple rebuild will not be enough:
usually when there are changes made to the design or to I<config.cfg>
files. In that case, you will need to force the whole rebuild:
- % bin/build -f
- % bin/build -df # if you want PDF to be rebuild.
+ ai% bin/build -f
+ ai% bin/build -df # if you want PDF to be rebuilt.
+
+=head1 Submitting documentation patches
+
+We warmly welcome any updates to the documentation. To send us a
+documentation patch, please update your CVS tree, and then, depending
+on the patch:
+
+=over
+
+=item *
+
+If the change is big, send the whole source file to the maintainer.
+
+=item *
+
+If you only add a paragraph/modify a line, please make sure you have
+the I<latest> CVS version, and then issue:
+
+ ai% cvs diff -u > patch
+
+And send the I<patch> file to the maintainer, preferably inline in
+your e-mail.
+=back
+When writing documentation, please make sure to read the files
+contained in I<admin/> in the CVS tree, especially I<style.pod>, to
+see what guidelines you should follow.
=head1 Maintainers
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
