You are viewing a plain text version of this content. The canonical link for it is here.
Posted to test-dev@perl.apache.org by Jim Martinez <jj...@bigbigorg.org> on 2005/05/02 05:38:33 UTC
placeholder for the Apache-Test project homepage
Hi,
On the perl.apache.org site there is this placeholder:
http://perl.apache.org/Apache-Test/index.html
Would it be appropriate to place a link there to this:
http://perl.apache.org/docs/general/testing/testing.html
Using the shortcuts navigation, the information light place holder is
always one click away. The apache testing document doesn't enjoy such
prominent linking and yet it's much more useful that the placeholder page.
Perhaps the testing document should replace the place holder entirely.
Regards,
Jim
Re: placeholder for the Apache-Test project homepage
Posted by Stas Bekman <st...@stason.org>.
Geoffrey Young wrote:
>
> Stas Bekman wrote:
>
>>Jim Martinez wrote:
>>
>>
>>>Hi,
>>>
>>>On the perl.apache.org site there is this placeholder:
>>>
>>>http://perl.apache.org/Apache-Test/index.html
>>>
>>>Would it be appropriate to place a link there to this:
>>>
>>>http://perl.apache.org/docs/general/testing/testing.html
>>>
>>>Using the shortcuts navigation, the information light place holder is
>>>always one click away. The apache testing document doesn't enjoy such
>>>prominent linking and yet it's much more useful that the placeholder
>>>page.
>>>
>>>Perhaps the testing document should replace the place holder entirely.
>>
>>
>>Good idea, Jim.
>>
>>I'm not sure the current http://perl.apache.org/Apache-Test/ is the
>>right location though. I remember Geoff put it there, so it'll be in the
>>menu, but Apache-Test is not mod_perl, so it should probably leave
>>elsewhere.
>
>
> well, perl.apache.org is the parent page for all projects within the
> Apache-Perl TLP, so Apache-Test didn't seem so bad. httpd.apache.org/apreq
> and httpd.apache.org/test (before we took it over) were similar examples of
> similar circumstances. but we can create a /projects page if you like as
> well, with /projects/Apache-Test hanging off of that.
The problem is that doesn't fit well with the rest of the top-level
material, which is all things mod_perl.
We can keep it there, but I'd suggest to remove it from the top menu,
create a sub-menu (like we have now for short-cuts and other boxes), call
it sub-projects and put it there. It's easy to do with DocSet.
>>Should we start perl.apache.org/projects/ or something like that for
>>sub-projects?
>>
>>Ideas?
>
>
> that's fine with me. the main reason I put that page up was because
> Apache-Test is becoming a relatively complex subproject - it supports both
> perl and php-based tests (both server and command-line) natively now, as
> well as apache C modules, and the plan is to incorporate mod_parrot when I
> have the time. so, my idea was to have Apache-Test/perl, Apache-Test/php,
> etc for documentation on each interface. but to make that
> projects/Apache-Test/perl, etc is no big deal with me. I just don't have
> the free tuits at the moment.
Right, I think my suggestion above should work.
> any chance we can coerce you into leading the effort, jim? :)
Yes, Jim, we need your help!
--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
Re: placeholder for the Apache-Test project homepage
Posted by Geoffrey Young <ge...@modperlcookbook.org>.
Stas Bekman wrote:
> Jim Martinez wrote:
>
>> [..]
>> Is this an accurate, acceptable summary of the improvements mentioned
>> above:
>>
>> create (as a directory) perl.apache.org/projects/
>>
>> create (as a directory) perl.apache.org/projects/Apache-Test
>>
>> create perl.apache.org/projects/index.html which would be a placeholder
>> like page that links to perl.apache.org/projects/Apache-Test/index.html
>> (and also possibly to perl.apache.org/projects/Apache-Test/php.html )
>>
>> move perl.apache.org/docs/general/testing/testing.html to
>> perl.apache.org/projects/Apache-Test/general.html
>>
>> If weak documentation is better than no documentation, I'm willing to
>> create a content light Apache-Test/php page (I recently moved a legacy
>> will-not-die side project that is written in php to the Apache::Test
>> frame
>> work). That page will contain only a few things from slides from the
>> 2004
>> ApacheCon Apache-Test/PHP talk (three php.ini configuration lines).
>>
>> So I'd create perl.apache.org/projects/Apache-Test/php.html to hold a few
>> notes from that Apachecon talk.
I'd rather see projects/Apache-Test/php/index.html but the rest sounds
great! I'm particulary tickled to see someone using the php interface in
the wild :)
if we do that, then I guess it would be projects/Apache-Test/perl/general.html
>>
>> If those tasks above are both reasonably complete and acceptable, I'm
>> willing to do them, if you're asking.
>>
>> Did I miss anything?
>
>
> Actually, I can handle the reshuffling, since nothing needs to be
> created, the docsetting system does it automatically.
>
> Do we agree on the above layout, Geoff?
yeah, sounds great, either my suggestion or the way jim layed it out is fine
with me.
>
> So all is remaining is whatever php docs you want to provide. The
> supported input formats at the moment are pod or html. Thanks Jim.
yeah, jim++
--Geoff
Re: placeholder for the Apache-Test project homepage
Posted by Stas Bekman <st...@stason.org>.
Stas Bekman wrote:
>>> so may be it should be /server/ instead of /user/?
>>
>>
>>
>> nah, I like /user better. so, let /api be the docs for the various A-T
>> classes, and /user/$lang be for language/apache-module specific configs,
>> docs, etc.
>
>
> +1
Done.
So Jim, whenever you are ready, we can accept the docs. thanks.
--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
Re: placeholder for the Apache-Test project homepage
Posted by Stas Bekman <st...@stason.org>.
Geoffrey Young wrote:
>>I suppose that the client side will be always be in perl, right?
>
>
> nope :) as of 1.21 you can write t/foo.php and it will DTRT. so long as
> t/TEST uses Apache::TestRunPHP, that is.
wow, cool!
>>so may be it should be /server/ instead of /user/?
>
>
> nah, I like /user better. so, let /api be the docs for the various A-T
> classes, and /user/$lang be for language/apache-module specific configs,
> docs, etc.
+1
--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
Re: placeholder for the Apache-Test project homepage
Posted by Geoffrey Young <ge...@modperlcookbook.org>.
Stas Bekman wrote:
> I was also thinking that it'd be nice to cut the pod files from A-T's
> .pm files, just like we do with mod_perl. Host those in the modperl-docs
> repository and extract those via svn into Apache-Test/docs/ which
> consequently gets glued to .pm files on install. That way online docs
> will be complete.
>
> In which case it probably makes sense to follow the same layout as mp
> docs, i.e.:
>
> Apache-Test/api/ <= Apache::Test, Apache::TestRequest, etc.
> Apache-Test/user/ <= tutorials and stuff
>
> The user/ will probably split into perl/, php/, python/, etc, with
> language specific docs living under those dirs.
+1
>
> I suppose that the client side will be always be in perl, right?
nope :) as of 1.21 you can write t/foo.php and it will DTRT. so long as
t/TEST uses Apache::TestRunPHP, that is.
>
> so may be it should be /server/ instead of /user/?
nah, I like /user better. so, let /api be the docs for the various A-T
classes, and /user/$lang be for language/apache-module specific configs,
docs, etc.
--Geoff
Re: placeholder for the Apache-Test project homepage
Posted by Stas Bekman <st...@stason.org>.
Jim Martinez wrote:
> On May 4 Stas Bekman wrote:
>
>
>>I was also thinking that it'd be nice to cut the pod files from A-T's
>>.pm files, just like we do with mod_perl. Host those in the modperl-docs
>>repository and extract those via svn into Apache-Test/docs/ which
>>consequently gets glued to .pm files on install. That way online docs
>>will be complete.
>
>
> I like that idea. Can we extend it to include at least references to
> other Apache-Test modules?
>
> Your idea lead me to finding these docs, most of which I haven't read:
>
> jjm@bigbigorg:~$ man -k 'Apache'|grep Test
> Apache::Test (3pm) - Test.pm wrapper with helpers for testing Apache
> Apache::TestConfig (3pm) - Configuration file for Apache::Test
> Apache::TestConfigData (3pm) - Configuration file for Apache::Test
> Apache::TestMB (3pm) - Subclass of Module::Build to support Apache::Test
> Apache::TestMM (3pm) - Provide MakeMaker Wrapper Methods
> Apache::TestReport (3pm) - A parent class for generating bug/success
> reports
> Apache::TestRequest (3pm) - Send requests to your Apache test server
> Apache::TestRun (3pm) - Run the test suite
> Apache::TestRunPerl (3pm) - Run mod_perl-requiring Test Suite
> Apache::TestRunPHP (3pm) - configure and run a PHP-based test suite
> Apache::TestSmoke (3pm) - Special Tests Sequence Failure Finder
> Apache::TestTrace (3pm) - Helper output generation functions
> Apache::TestUtil (3pm) - Utility functions for writing tests
> Bundle::ApacheTest (3pm) - A bundle to install all Apache-Test related
> modules
>
> Can we put some of these on-line too?
Well, that's exactly what I was proposing in the quoted text above.
--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
Re: placeholder for the Apache-Test project homepage
Posted by Jim Martinez <jj...@bigbigorg.org>.
On May 4 Stas Bekman wrote:
> I was also thinking that it'd be nice to cut the pod files from A-T's
> .pm files, just like we do with mod_perl. Host those in the modperl-docs
> repository and extract those via svn into Apache-Test/docs/ which
> consequently gets glued to .pm files on install. That way online docs
> will be complete.
I like that idea. Can we extend it to include at least references to
other Apache-Test modules?
Your idea lead me to finding these docs, most of which I haven't read:
jjm@bigbigorg:~$ man -k 'Apache'|grep Test
Apache::Test (3pm) - Test.pm wrapper with helpers for testing Apache
Apache::TestConfig (3pm) - Configuration file for Apache::Test
Apache::TestConfigData (3pm) - Configuration file for Apache::Test
Apache::TestMB (3pm) - Subclass of Module::Build to support Apache::Test
Apache::TestMM (3pm) - Provide MakeMaker Wrapper Methods
Apache::TestReport (3pm) - A parent class for generating bug/success
reports
Apache::TestRequest (3pm) - Send requests to your Apache test server
Apache::TestRun (3pm) - Run the test suite
Apache::TestRunPerl (3pm) - Run mod_perl-requiring Test Suite
Apache::TestRunPHP (3pm) - configure and run a PHP-based test suite
Apache::TestSmoke (3pm) - Special Tests Sequence Failure Finder
Apache::TestTrace (3pm) - Helper output generation functions
Apache::TestUtil (3pm) - Utility functions for writing tests
Bundle::ApacheTest (3pm) - A bundle to install all Apache-Test related
modules
Can we put some of these on-line too?
Jim
Re: placeholder for the Apache-Test project homepage
Posted by Stas Bekman <st...@stason.org>.
I was also thinking that it'd be nice to cut the pod files from A-T's .pm
files, just like we do with mod_perl. Host those in the modperl-docs
repository and extract those via svn into Apache-Test/docs/ which
consequently gets glued to .pm files on install. That way online docs will
be complete.
In which case it probably makes sense to follow the same layout as mp
docs, i.e.:
Apache-Test/api/ <= Apache::Test, Apache::TestRequest, etc.
Apache-Test/user/ <= tutorials and stuff
The user/ will probably split into perl/, php/, python/, etc, with
language specific docs living under those dirs.
I suppose that the client side will be always be in perl, right?
so may be it should be /server/ instead of /user/?
Apache-Test/api/ <= Apache::Test, Apache::TestRequest, etc.
/client/ <= client stuff
/server/perl/ <= tutorials and stuff
/php/
/python/
--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
Re: placeholder for the Apache-Test project homepage
Posted by Jim Martinez <jj...@bigbigorg.org>.
On May 3 Stas Bekman wrote:
>
> So all is remaining is whatever php docs you want to provide. The
> supported input formats at the moment are pod or html. Thanks Jim.
>
Before this I'll post a question or two on php configuration to make sure
the configuration lines I'm using for php are sane (they work, but do they
make good examples).
Jim
Re: placeholder for the Apache-Test project homepage
Posted by Stas Bekman <st...@stason.org>.
Jim Martinez wrote:
>[..]
> Is this an accurate, acceptable summary of the improvements mentioned
> above:
>
> create (as a directory) perl.apache.org/projects/
>
> create (as a directory) perl.apache.org/projects/Apache-Test
>
> create perl.apache.org/projects/index.html which would be a placeholder
> like page that links to perl.apache.org/projects/Apache-Test/index.html
> (and also possibly to perl.apache.org/projects/Apache-Test/php.html )
>
> move perl.apache.org/docs/general/testing/testing.html to
> perl.apache.org/projects/Apache-Test/general.html
>
> If weak documentation is better than no documentation, I'm willing to
> create a content light Apache-Test/php page (I recently moved a legacy
> will-not-die side project that is written in php to the Apache::Test frame
> work). That page will contain only a few things from slides from the 2004
> ApacheCon Apache-Test/PHP talk (three php.ini configuration lines).
>
> So I'd create perl.apache.org/projects/Apache-Test/php.html to hold a few
> notes from that Apachecon talk.
>
> If those tasks above are both reasonably complete and acceptable, I'm
> willing to do them, if you're asking.
>
> Did I miss anything?
Actually, I can handle the reshuffling, since nothing needs to be created,
the docsetting system does it automatically.
Do we agree on the above layout, Geoff?
So all is remaining is whatever php docs you want to provide. The
supported input formats at the moment are pod or html. Thanks Jim.
--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
Re: placeholder for the Apache-Test project homepage
Posted by Jim Martinez <jj...@bigbigorg.org>.
On May 3 Geoffrey Young wrote:
> Stas Bekman wrote:
>
> > Jim Martinez wrote:
> >
> >> Hi,
> >>
> >> On the perl.apache.org site there is this placeholder:
> >>
> >> http://perl.apache.org/Apache-Test/index.html
> >>
> >> Would it be appropriate to place a link there to this:
> >>
> >> http://perl.apache.org/docs/general/testing/testing.html
> >>
> >> Using the shortcuts navigation, the information light place holder is
> >> always one click away. The apache testing document doesn't enjoy
> >> such prominent linking and yet it's much more useful that the
> >> placeholder page.
> >>
> >> Perhaps the testing document should replace the place holder
> >> entirely.
> >
> >
> > Good idea, Jim.
> >
> > I'm not sure the current http://perl.apache.org/Apache-Test/ is the
> > right location though. I remember Geoff put it there, so it'll be in
> > the menu, but Apache-Test is not mod_perl, so it should probably leave
> > elsewhere.
>
> well, perl.apache.org is the parent page for all projects within the
> Apache-Perl TLP, so Apache-Test didn't seem so bad.
> httpd.apache.org/apreq and httpd.apache.org/test (before we took it
> over) were similar examples of similar circumstances. but we can create
> a /projects page if you like as well, with /projects/Apache-Test hanging
> off of that.
>
> >
> > Should we start perl.apache.org/projects/ or something like that for
> > sub-projects?
> >
> > Ideas?
>
> that's fine with me. the main reason I put that page up was because
> Apache-Test is becoming a relatively complex subproject - it supports
> both perl and php-based tests (both server and command-line) natively
> now, as well as apache C modules, and the plan is to incorporate
> mod_parrot when I have the time. so, my idea was to have
> Apache-Test/perl, Apache-Test/php, etc for documentation on each
> interface. but to make that projects/Apache-Test/perl, etc is no big
> deal with me. I just don't have the free tuits at the moment.
>
> any chance we can coerce you into leading the effort, jim? :)
Is this an accurate, acceptable summary of the improvements mentioned
above:
create (as a directory) perl.apache.org/projects/
create (as a directory) perl.apache.org/projects/Apache-Test
create perl.apache.org/projects/index.html which would be a placeholder
like page that links to perl.apache.org/projects/Apache-Test/index.html
(and also possibly to perl.apache.org/projects/Apache-Test/php.html )
move perl.apache.org/docs/general/testing/testing.html to
perl.apache.org/projects/Apache-Test/general.html
If weak documentation is better than no documentation, I'm willing to
create a content light Apache-Test/php page (I recently moved a legacy
will-not-die side project that is written in php to the Apache::Test frame
work). That page will contain only a few things from slides from the 2004
ApacheCon Apache-Test/PHP talk (three php.ini configuration lines).
So I'd create perl.apache.org/projects/Apache-Test/php.html to hold a few
notes from that Apachecon talk.
If those tasks above are both reasonably complete and acceptable, I'm
willing to do them, if you're asking.
Did I miss anything?
Jim
Re: placeholder for the Apache-Test project homepage
Posted by Geoffrey Young <ge...@modperlcookbook.org>.
Stas Bekman wrote:
> Jim Martinez wrote:
>
>> Hi,
>>
>> On the perl.apache.org site there is this placeholder:
>>
>> http://perl.apache.org/Apache-Test/index.html
>>
>> Would it be appropriate to place a link there to this:
>>
>> http://perl.apache.org/docs/general/testing/testing.html
>>
>> Using the shortcuts navigation, the information light place holder is
>> always one click away. The apache testing document doesn't enjoy such
>> prominent linking and yet it's much more useful that the placeholder
>> page.
>>
>> Perhaps the testing document should replace the place holder entirely.
>
>
> Good idea, Jim.
>
> I'm not sure the current http://perl.apache.org/Apache-Test/ is the
> right location though. I remember Geoff put it there, so it'll be in the
> menu, but Apache-Test is not mod_perl, so it should probably leave
> elsewhere.
well, perl.apache.org is the parent page for all projects within the
Apache-Perl TLP, so Apache-Test didn't seem so bad. httpd.apache.org/apreq
and httpd.apache.org/test (before we took it over) were similar examples of
similar circumstances. but we can create a /projects page if you like as
well, with /projects/Apache-Test hanging off of that.
>
> Should we start perl.apache.org/projects/ or something like that for
> sub-projects?
>
> Ideas?
that's fine with me. the main reason I put that page up was because
Apache-Test is becoming a relatively complex subproject - it supports both
perl and php-based tests (both server and command-line) natively now, as
well as apache C modules, and the plan is to incorporate mod_parrot when I
have the time. so, my idea was to have Apache-Test/perl, Apache-Test/php,
etc for documentation on each interface. but to make that
projects/Apache-Test/perl, etc is no big deal with me. I just don't have
the free tuits at the moment.
any chance we can coerce you into leading the effort, jim? :)
--Geoff
Re: placeholder for the Apache-Test project homepage
Posted by Stas Bekman <st...@stason.org>.
Jim Martinez wrote:
> Hi,
>
> On the perl.apache.org site there is this placeholder:
>
> http://perl.apache.org/Apache-Test/index.html
>
> Would it be appropriate to place a link there to this:
>
> http://perl.apache.org/docs/general/testing/testing.html
>
> Using the shortcuts navigation, the information light place holder is
> always one click away. The apache testing document doesn't enjoy such
> prominent linking and yet it's much more useful that the placeholder page.
>
> Perhaps the testing document should replace the place holder entirely.
Good idea, Jim.
I'm not sure the current http://perl.apache.org/Apache-Test/ is the right
location though. I remember Geoff put it there, so it'll be in the menu,
but Apache-Test is not mod_perl, so it should probably leave elsewhere.
Should we start perl.apache.org/projects/ or something like that for
sub-projects?
Ideas?
--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com