You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by André Malo <nd...@perlig.de> on 2002/11/09 03:53:47 UTC

[Review] mod_deflate.xml

I've tried to enhance the mod_deflate documentation a bit.
Any suggestions and comments on content and my English :) are welcome.

You'll find attached the patch to the current xml file.
The whole new html output is online at 
<http://cvs.apache.org/~nd/manual/mod/mod_deflate.html>

nd
-- 
die (eval q-qq:Just Another Perl Hacker
:-)

# Andr� Malo, <http://www.perlig.de/> #

Re: [Review] mod_deflate.xml

Posted by Luiz Rocha <ls...@lsdr.net>.
On Saturday 09 November 2002 00:53, André Malo wrote:

> I've tried to enhance the mod_deflate documentation a bit.
> Any suggestions and comments on content and my English :) are welcome.

   I liked it. Have 2 suggestions, though

   1) Between "Some popular browsers ... " and " If you want to restrict ... " 
(the second and the third pharagraphs on Enabling Compression) I'd like to 
see the SetEnv example back, like:

<example>
SetEnv gzip-only-text/html 1
</example>

   I think is important this things for people who's reading this docs for the 
first time and still a little bit illiterate Apache-wise.

   2) You'll not put this one (" # other browsers have other problems ;-) ") 
in the final commit, right? I find funny, but other people might not.

   Of course, its my opinion. Let's see what the others think about it.

-- 
Luiz Rocha <ls...@lsdr.net>
http://lsdr.net/

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Re: [Review] mod_deflate.xml (Revision)

Posted by André Malo <nd...@perlig.de>.
* Joshua Slive wrote:

> One possibility: Should we have a separate <section> called "Recommended
> Configuration" listed first, to be really clear what we recommend for a
> typical server?  And shouldn't the recommended configuration include the
> Header directive to set the Vary: User-Agent?

been there, done that.

> There are a couple small gramatical nits,

probably. My native languages are German and Perl...

> but it would probably be easier
> if you commit and then I'll try to remember to clean them up later.

..but I'm actually trying to improve my English :)

nd
-- 
"Eine Eieruhr", erklärt ihr Hermann, "besteht aus einem Ei. Du nimmst
das Ei und kochst es. Wenn es hart ist, sind fünf Minuten um. Dann weißt
du, daß die Zeit vergangen ist."
                             -- Hannes Hüttner in "Das Blaue vom Himmel"

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Re: [Review] mod_deflate.xml (Revision) (was: [Review] mod_deflate.xml)

Posted by Joshua Slive <jo...@slive.ca>.
On Sun, 10 Nov 2002, André Malo wrote:
> Thanks (Luiz also) for your feedback. The only thing I didn't (re-)built in
> is the SetEnv example. I currently can't imagine a configuration that makes
> much sense, since AddoutputFilterByType exists and is much more flexible.
>
> I also added a section about mod_deflate and proxy servers. Another review
> would be appreciated...
>
> I put the whole revision online again at
> <http://cvs.apache.org/~nd/manual/mod/mod_deflate.html>
>
> attached you'll find the whole patch against the current xml and a patch
> against the first version (choose whatever you want to read ;-)

One possibility: Should we have a separate <section> called "Recommended
Configuration" listed first, to be really clear what we recommend for a
typical server?  And shouldn't the recommended configuration include the
Header directive to set the Vary: User-Agent?

There are a couple small gramatical nits, but it would probably be easier
if you commit and then I'll try to remember to clean them up later.

Looks very good overall.

Joshua.


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Re: [Review] mod_deflate.xml (Revision) (was: [Review] mod_deflate.xml)

Posted by André Malo <nd...@perlig.de>.
* Joshua Slive wrote:

> Some suggestions:
[...]

Thanks (Luiz also) for your feedback. The only thing I didn't (re-)built in 
is the SetEnv example. I currently can't imagine a configuration that makes 
much sense, since AddoutputFilterByType exists and is much more flexible.

I also added a section about mod_deflate and proxy servers. Another review 
would be appreciated...

I put the whole revision online again at 
<http://cvs.apache.org/~nd/manual/mod/mod_deflate.html>

attached you'll find the whole patch against the current xml and a patch 
against the first version (choose whatever you want to read ;-)

nd
-- 
Treat your password like your toothbrush. Don't let anybody else
use it, and get a new one every six months.  -- Clifford Stoll

                                    (found in ssl_engine_pphrase.c)


Re: [Review] mod_deflate.xml

Posted by Joshua Slive <jo...@slive.ca>.
On Sat, 9 Nov 2002, André Malo wrote:

> I've tried to enhance the mod_deflate documentation a bit.
> Any suggestions and comments on content and my English :) are welcome.

Looks good.

Some suggestions:

1. Remove "so you can do negative matches".  It isn't very clear, and it
isn't really even true.  The restriction to only matching "1" was put in
for that purpose.  But, in my opinion, it was a mistake.  There are plenty
of other ways to do negative matches, which you demonstrate in the
examples below.

2. "Internet Explorer identifies ITSELF as ..."

3. "If now a request contains" should be just "Now if a request contains"

4. Perhaps you want to explicitly label your main example as a
"recommended configuration"?  I don't have much mod_deflate experience,
but if those browsers really do have problems, we should present a
recommended configuration that avoids the issues.

5. It might be excessive to put all the filter directives in <seealso>s.
Perhaps the link to the filter documentation is enough.

Joshua.


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org