You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-cvs@perl.apache.org by st...@apache.org on 2002/04/26 17:32:23 UTC
cvs commit: modperl-docs/src/contribute config.cfg docs.pod maillist.pod share_code.pod
stas 02/04/26 08:32:23
Modified: src/contribute config.cfg docs.pod maillist.pod
share_code.pod
Log:
- added links to the mailing-list page
- removed a few errors (I think, at least, but my english isn't
perfect...)
- changed from "101 ways" to "How to" (as there aren't 101 ways
mentioned...)
- edited some text
Submitted by: Thomas Klausner <do...@zsi.at>
Reviewed by: stas
Revision Changes Path
1.3 +1 -1 modperl-docs/src/contribute/config.cfg
Index: config.cfg
===================================================================
RCS file: /home/cvs/modperl-docs/src/contribute/config.cfg,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- config.cfg 13 Apr 2002 17:46:09 -0000 1.2
+++ config.cfg 26 Apr 2002 15:32:23 -0000 1.3
@@ -4,7 +4,7 @@
title => "Contribute",
- abstract => "101 ways to contribute to the mod_perl community",
+ abstract => "How to contribute to the mod_perl community",
chapters => [
qw(
1.2 +8 -7 modperl-docs/src/contribute/docs.pod
Index: docs.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/contribute/docs.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- docs.pod 5 Jan 2002 19:15:40 -0000 1.1
+++ docs.pod 26 Apr 2002 15:32:23 -0000 1.2
@@ -5,14 +5,15 @@
=head1 Submit Corrections
There is a lot of mod_perl documentation. And we are sure it includes
-documentation bugs. So if you spot any make sure to report it.
+documentation bugs. So if you spot any make sure to report them.
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.
-If you notice bad English grammar and speling :), don't hesitate to
-tell us where and what do you think is the best way to fix it.
+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
+it. Da!
=head1 Submit New Articles
@@ -32,11 +33,11 @@
=head1 How to Send Information and Where
The documentation contributions and corrections are to be sent to the
-mod_perl documentation mailing list.
+mod_perl documentation mailing list,
+L<docs-dev|maillist::list-docs-dev>
-If the correction is minor, please specify the URL you are talking
-about, and preferrably the version number of the document if such is
-available.
+If the correction is minor, please specify the full URL you are
+talking about.
If the correction is medium to large, please retrieve the
documentation source package or use the cvs repository and submit the
1.2 +13 -11 modperl-docs/src/contribute/maillist.pod
Index: maillist.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/contribute/maillist.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- maillist.pod 5 Jan 2002 19:15:40 -0000 1.1
+++ maillist.pod 26 Apr 2002 15:32:23 -0000 1.2
@@ -4,23 +4,25 @@
=head1 Answering Questions
-Since mod_perl is an open source technology, it's main support
-facility is its mailing lists. Therefore it's very essential to
-support users and developers by sharing your mod_perl and related
+Since mod_perl is an open source technology, its main support facility
+is the L<mailing lists|maillist::index>. Therefore it's very essential
+to support users and developers by sharing your mod_perl and related
knowledge through answering questions and submitting interesting posts
-that enrich community's knowledge in the related topics.
+that enrich the community's knowledge in the related topics.
-You don't have to be a guru, to be a very valuable person to the
+You don't have to be a guru to be a very valuable person to the
mod_perl community. Through answering questions you learn a lot by
-yourself, and eventually become a guru yourself.
+yourself and eventually become a guru yourself.
=head1 Helping Navigating the Documentation
-mod_perl is one of the few open source projects that bundled with a
-lot of documentation. The only problem is that it's very hard to read
-all the documentation when someone just starts with
-mod_perl. Therefore helping to find the right document to read when
-someone in trouble is a noble thing to do.
+mod_perl is one of the few open source projects that is bundled with a
+lot of comprehensive documentation. And although the documentation is
+well indexed, it can be hard to find the right piece of information,
+especially for a novice mod_perl user. If you point someone to the
+existing documentation, please try to point her to the specific URL
+containing the information, and not just to "the mod_perl guide" in
+general.
=cut
1.2 +8 -10 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.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- share_code.pod 5 Jan 2002 19:15:40 -0000 1.1
+++ share_code.pod 26 Apr 2002 15:32:23 -0000 1.2
@@ -23,23 +23,21 @@
are submitted as patches, so you benefit from others sharing their
works with you.
-Before submitting a new module to CPAN, please discuss it first on the
-mod_perl list. It's important to choose a good intuitive name for your
-module. Also it's possible that a module with a similar functionality
-already exists and most likely that someone will point it out. In
-which case you may want to help developing this existing module
-instead and integrating your features into it.
+Before submitting a new C<Apache::> module to CPAN, please discuss it
+first on the L<mod_perl list|maillist::list-modperl>. It's important
+to choose a good intuitive name for your module. Also it's possible
+that a module with a similar functionality already exists and most
+likely that someone will point it out. In which case you may want to
+help developing this existing module instead and integrating your
+features into it.
=head1 Code Snippets
If you have some neat code snippets, please send them to the mailing
list. If you are kind enough to annotate these, they could probably
fit into mod_perl documentation. At least they will be archived in the
-mailing list archive, and in the future users will be able to find
+mailing list archive and in the future users will be able to find
your code and reuse it.
-
-
-
=cut
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org