STATUS revision af4c982a7cf4515f124935f99a329744035fc699
2N/AApache HTTP Server 2.0 Documentation Status File.
2N/ALast modified: $Date: 2001/08/10 19:02:02 $
2N/A
2N/AIf you are interested in helping accomplish some of the tasks on this
2N/Alist or otherwise improving the documentation, please join the
2N/Aapache-docs mailing list by mailing to
2N/Aapache-docs-subscribe@apache.org
2N/A
2N/AFor more information on how to contribute to the Apache Documentation
2N/AProject, please see http://httpd.apache.org/docs-project/, and
2N/Ahttp://apache-server.com/tutorials/ATdocs-project.html for an excellent
2N/Atutorial on how to get started with making your contribution.
2N/A
2N/A ------------------------------
2N/A
2N/A- modules docs
2N/A - mod_suexec: no documentation yet.
2N/A - mod_include: the "INCLUDES_MAGIC_TYPE" x-server-parsed-html
2N/A appears to have been removed from mod_include, but it is still
2N/A present in mod_negotiation, mod_autoindex, and httpd.h.
2N/A Should it be removed from the docs for mod_include?
2N/A - mod_status: updates for 2.0
2N/A - mod_example: updates for 2.0
2N/A
2N/A- man pages
2N/A - Some of the man pages need to be updated for 2.0. At least
2N/A the httpd man page appears to be outdated, and perhaps other.
2N/A After this is done, the manual/programs/ versions can be
2N/A regenerated.
2N/A
2N/A- XHTML conversion
2N/A Status: James A Sutherland <jas88@cam.ac.uk>
2N/A is working on this.
2N/A Some work is still needed
2N/A to determine what the SSIs should look like.
2N/A
2N/A- MPM documentation
2N/A - Each MPM needs to have a documentation file in manual/mod/
2N/A which lists the directives it provides, and some details
2N/A about its operation.
2N/A Status: Initial outlines done. Much more details need to be
2N/A filled in.
2N/A - Non unix/windows MPMs still need to be completed.
2N/A - worker has no docs
2N/A - the perchild directives in threaded/worker need docs
2N/A
2N/A- Cleaning.
2N/A - We could use a list of all the docs that can be axed out of 2.0
2N/A because they are redundant or irrelevant.
2N/A Status:
2N/A Some suggestions on files to axe. Feel free to comment.
2N/A manual/cgi-path.html (should be documented in mod_cgi.html instead)
2N/A manual/process-model.html (documented in MPMs, eventually)
2N/A platform/perf-* (are these relevant anymore?)
2N/A misc/howto.html
2N/A
2N/A - Individual docs will need some cleanup.
2N/A Status: What docs still need to be touched here?
2N/A - invoking.html has had a first-pass cleaning done.
2N/A - misc/perf-tuning.html - needs major rewrite for 2.0
2N/A - misc/FAQ.html - some old questions could be remove
2N/A - is a new format in order?
2N/A - misc/tutorials.html - mostly not relevant to 2.0
2N/A - misc/stopping.html
2N/A - dso.html
2N/A - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
2N/A - misc/known_client_problems.html - mostly ancient
2N/A
2N/A- New build process.
2N/A - install.html has had a first-pass rewrite, but needs more
2N/A work to be complete, and needs to track changes/bug-fixes
2N/A in the build system.
2N/A
2N/A- Documentation of new features.
2N/A - This will probably require more input from new-httpd, since
2N/A not many people here follow the development process close
2N/A enough to know what is going on.
2N/A
2N/A- API documentation
2N/A Status: Ben Laurie has written some hooks documentation
2N/A
2N/A- Translations
2N/A We appear to have people working on translation into the following
2N/A languages. These may just be the 'it worked' page, but if so
2N/A the authors of those should perhaps be contacted to help do the
2N/A rest.. :-) Note that this list is NOT identical to that for the
2N/A 1.3 documentation project..!
2N/A
2N/A [Should we attempt to get a known-current authorlist together? --jsl]
2N/A
2N/A - Catalan (.ca)
2N/A - Czech Republic (.cz)
2N/A - German (.de)
2N/A - Danish (.dk)
2N/A - Estonia (.ee)
2N/A - Greek (.el)
2N/A - Spanish (.es)
2N/A - Estonian (.et)
2N/A - French (.fr)
2N/A - Hebrew (.he.iso8859-8)
2N/A - Italian (.it)
2N/A - Japanese (.ja.iso2022-jp, .ja.jis)
2N/A - Korean (.kr.iso2022-kr, .kt.iso-kr)
2N/A - ? (.ltz)
2N/A - ? (.lu)
2N/A - Dutch (.nl)
2N/A - Norwegian (.no)
2N/A - Polish (.po.iso-pl)
2N/A - Portuguese (.pt)
2N/A - Portuguese [Brasilian] (.pt-br)
2N/A - Russian (.ru.cp-1251, .ru.cp866, .ru.iso-ru, .ru.koi8-r, .ru.ucs[248])
2N/A - Swedish (.se)
2N/A - Twi (.tw, .tw.big5)
2N/A (is that supposed to be Chinese/Taiwanese? Because if so, it is using
2N/A the code reserved for Twi..)
2N/A [Need this clarified --jsl]
2N/A
2N/A
2N/A
2N/AThings to be done in both the 1.3 and 2.0 trees
2N/A===============================================
2N/A
2N/A
2N/ATutorials
2N/A=========
2N/A
2N/A* Tutorial on user authentication with Apache. Rich Bowen has contributed
2N/A his tutorial from ApacheToday, but it needs to be cleaned up and put in
2N/A a good format for the docs.
2N/A
2N/A - Rich has kindy donated the "4-part logging article on Apache Today"
2N/A articles that will need a little massaging.
2N/A
2N/ANew User documentation
2N/A======================
2N/A
2N/A* Adding more documentation for new users
2N/A
2N/A - I believe that we'll need to get more info on what is missing, ie.
2N/A user feedback and whatnot. --jsl
2N/A
2N/A
2N/ADocumentation improvements
2N/A==========================
2N/A
2N/A* Improving the "security docs"
2N/A
2N/A - More content and better organisation.
2N/A
2N/A* General cleaning and improving of module docs
2N/A
2N/A* Making the directive definitions "less terse" (i.e., adding more
2N/A examples and details to the definitions of the directives)
2N/A
2N/A - We'll need to audit these and find out which ones need munging, as
2N/A some of it looks ok. --jsl
2N/A
2N/A