httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Rodent of Unusual Size <Ken.C...@Golux.Com>
Subject [STATUS] (httpd-docs-2.0) Wed Mar 27 23:45:20 EST 2002
Date Thu, 28 Mar 2002 04:45:20 GMT
Apache HTTP Server 2.0 Documentation Status File.
Last modified: $Date: 2002/03/23 03:23:15 $

If you are interested in helping accomplish some of the tasks on this
list or otherwise improving the documentation, please join the
apache-docs mailing list by mailing to

For more information on how to contribute to the Apache Documentation
Project, please see, and for an excellent
tutorial on how to get started with making your contribution.


The module docs are being converted to a new xml format.  The format
is described at:
Help with the conversion is needed.

- IPv6: need to update some directives to show correct syntax for IPv6
    - Listen
    - NameVirtualHost/VirtualHost
    - Allow/Deny

- modules docs
    - mod_suexec: very little documentation
    - mod_proxy: updates for 2.0
    - mod_status: updates for 2.0
    - mod_example: updates for 2.0
- man pages
    - Some of the man pages need to be updated for 2.0.  At least
      the httpd man page appears to be outdated, and perhaps other.
      After this is done, the manual/programs/ versions can be

- MPM documentation
   - Each MPM needs to have a documentation file in manual/mod/
     which lists the directives it provides, and some details
     about its operation.
        Status: Initial outlines done.  Much more details need to be
          filled in.
          - Non unix/windows MPMs still need to be completed.
          - worker has no docs
          - the perchild directives in threaded/worker need docs

   - Individual docs will need some cleanup. 
        Status:  What docs still need to be touched here?
                 - invoking.html has had a first-pass cleaning done.
                 - misc/perf-tuning.html - needs major rewrite for 2.0
                 - misc/tutorials.html - mostly not relevant to 2.0
                 - misc/stopping.html
                 - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
                 - misc/known_client_problems.html - mostly ancient

- New build process.
    - install.html has had a first-pass rewrite, but needs more
      work to be complete, and needs to track changes/bug-fixes
      in the build system.

- Documentation of new features.
   - This will probably require more input from new-httpd, since
     not many people here follow the development process close
     enough to know what is going on.

- API documentation
    Status: Ben Laurie has written some hooks documentation

- Translations
    We appear to have people working on translation into the following
    languages.  These may just be the 'it worked' page, but if so
    the authors of those should perhaps be contacted to help do the
    rest.. :-)  Note that this list is NOT identical to that for the
    1.3 documentation project..!

  [Should we attempt to get a known-current authorlist together? --jsl]

    - Catalan (.ca)
    - Czech Republic (.cz)
    - German (.de)
    - Danish (.dk)
    - Estonia (.ee)
    - Greek (.el)
    - Spanish (.es)
    - Estonian (.et)
    - French (.fr)
    - Hebrew (.he.iso8859-8)
    - Italian (.it)
    - Japanese (.ja.iso2022-jp, .ja.jis)
    - Korean (.kr.iso2022-kr, .kt.iso-kr)
    - ? (.ltz)
    - ? (.lu)
    - Dutch (.nl)
    - Norwegian (.no)
    - Polish (.po.iso-pl)
    - Portuguese (.pt)
    - Portuguese [Brasilian] (.pt-br)
    - Russian (.ru.cp-1251, .ru.cp866, .ru.iso-ru, .ru.koi8-r, .ru.ucs[248])
    - Swedish (.se)
    - Twi (.tw, .tw.big5)
      (is that supposed to be Chinese/Taiwanese?  Because if so, it is using
      the code reserved for Twi..)
    [Need this clarified --jsl]

New User documentation

* Directory Handling (mod_dir/mod_autoindex/etc)

* Sections (<Directory>/<Files>/<Location>)

* public_html - tutorial covering what is involved in helping users set
  up web serving out of their home directory.

* .htaccess - Perhaps as simple as an auto-generated listing of what
  directives are permitted in .htaccess files. Would be nice if common
  examples (authentication, adding SSI or CGI capabilities, etc) could
  be given as well.

Documentation improvements

* Improving the "security docs"

  - More content and better organisation.

* General cleaning and improving of module docs

* Making the directive definitions "less terse" (i.e., adding more
  examples and details to the definitions of the directives)

  - We'll need to audit these and find out which ones need munging, as
    some of it looks ok.  --jsl

  - Every directive should have at least one example of usage, except
    those directives which list all possible usages in the Syntax
    description. And maybe some of those too. People like examples.
    mod/core.html has been checked all the way through, as have a few
    of the modules.

* Making site-specific enhancements easier, including a documented
  and robust way for 3P module docco to be added -- and have it
  survive a server docco upgrade

  - This could be something a simple and hackish as a manual/extra/
    directory (a la the 1.3 src/modules/extra/ directory) and a
    script in the support directory that scans the files there and
    updates the manual indices.  (We do something like that now for
    httpd.conf file with apxs [LoadModule, etc.].)

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message