[STATUS] (httpd-docs-2.0) Wed Jul 24 23:45:27 EDT 2002

[Rodent of Unusual Size <Ke...@Golux.Com>]

Apache HTTP Server 2.0 Documentation Status File.
Last modified: $Date: 2002/07/21 21:16:40 $

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 
apache-docs-subscribe@apache.org

For more information on how to contribute to the Apache Documentation
Project, please see http://httpd.apache.org/docs-project/, and
http://apache-server.com/tutorials/ATdocs-project.html for an excellent
tutorial on how to get started with making your contribution.

              ------------------------------

- doc-project webpage should be updated to recommend subscription to the
  CVS mailing list.

- XML
    - The xsl transformations could be greatly improved to a) look better
      and b) use proper CSS+html rather than the horrible hack that
      Joshua did.
    - xslt code needs to be added to deal with <manualpage>; shouldn't be
      too difficult.
    - Build system needs to be modified to transform directories other than
      mod/ and probably to set up some variables to get references in the
      <directive> and <module> tags to point to the right place.

- 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
      regenerated using the program in the site-tools repository.

- 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.
          - the perchild directives in threaded/worker need docs

   - Individual docs will need some cleanup. 
        Status:  What docs still need to be touched here?
                 - misc/custom_errordocs.html needs to be updated to
                   essentially describe how the international error
                   docs included in 2.0 work
                 - 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 many things have
      changed in the build system since it was written.

- 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 need a webpage describing the basics of how to go about translating
      the apache docs.  Things like naming conventions, reviewing standards,
      and perhaps some standard comments to put at the top of each doc
      (english version, auther, reviewer).

    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 (.ko.euc-kr)
    - Luxembourgish (.lb)
    - 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)
    - Chinese (.zh)
    [Need this clarified --jsl]


New User documentation
======================

* Directory Handling (mod_dir/mod_autoindex/etc)

* Sections (<Directory>/<Files>/<Location>)
  - I think this should be a priority.  A rewrite of /sections.html would
    be a good place to start.  That document is too technical and 
    insufficiently verbose for the average user.

* 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 (possible with the
  appropriate xsl stylesheet). 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

* 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.].)

* regex: We should at least document someplace what regex library we
  are using and how to find more information about it

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