1 Apache HTTP Server 2.0 Documentation Status File.
2 Last modified: $Date: 2002/02/17 21:09:03 $
4 If you are interested in helping accomplish some of the tasks on this
5 list or otherwise improving the documentation, please join the
6 apache-docs mailing list by mailing to
7 apache-docs-subscribe@apache.org
9 For more information on how to contribute to the Apache Documentation
10 Project, please see http://httpd.apache.org/docs-project/, and
11 http://apache-server.com/tutorials/ATdocs-project.html for an excellent
12 tutorial on how to get started with making your contribution.
14 ------------------------------
16 The module docs are being converted to a new xml format. The format
17 is described at: http://httpd.apache.org/docs-project/docsformat.html
18 Help with the conversion is needed.
20 - IPv6: need to update some directives to show correct syntax for IPv6
22 - NameVirtualHost/VirtualHost
26 - mod_suexec: very little documentation
27 - mod_proxy: updates for 2.0
28 - mod_status: updates for 2.0
29 - mod_example: updates for 2.0
32 - Some of the man pages need to be updated for 2.0. At least
33 the httpd man page appears to be outdated, and perhaps other.
34 After this is done, the manual/programs/ versions can be
38 - Each MPM needs to have a documentation file in manual/mod/
39 which lists the directives it provides, and some details
41 Status: Initial outlines done. Much more details need to be
43 - Non unix/windows MPMs still need to be completed.
45 - the perchild directives in threaded/worker need docs
47 - Individual docs will need some cleanup.
48 Status: What docs still need to be touched here?
49 - invoking.html has had a first-pass cleaning done.
50 - misc/perf-tuning.html - needs major rewrite for 2.0
51 - misc/tutorials.html - mostly not relevant to 2.0
53 - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
54 - misc/known_client_problems.html - mostly ancient
57 - install.html has had a first-pass rewrite, but needs more
58 work to be complete, and needs to track changes/bug-fixes
61 - Documentation of new features.
62 - This will probably require more input from new-httpd, since
63 not many people here follow the development process close
64 enough to know what is going on.
67 Status: Ben Laurie has written some hooks documentation
70 We appear to have people working on translation into the following
71 languages. These may just be the 'it worked' page, but if so
72 the authors of those should perhaps be contacted to help do the
73 rest.. :-) Note that this list is NOT identical to that for the
74 1.3 documentation project..!
76 [Should we attempt to get a known-current authorlist together? --jsl]
79 - Czech Republic (.cz)
87 - Hebrew (.he.iso8859-8)
89 - Japanese (.ja.iso2022-jp, .ja.jis)
90 - Korean (.kr.iso2022-kr, .kt.iso-kr)
97 - Portuguese [Brasilian] (.pt-br)
98 - Russian (.ru.cp-1251, .ru.cp866, .ru.iso-ru, .ru.koi8-r, .ru.ucs[248])
100 - Twi (.tw, .tw.big5)
101 (is that supposed to be Chinese/Taiwanese? Because if so, it is using
102 the code reserved for Twi..)
103 [Need this clarified --jsl]
106 New User documentation
107 ======================
109 * Directory Handling (mod_dir/mod_autoindex/etc)
111 * Sections (<Directory>/<Files>/<Location>)
113 * public_html - tutorial covering what is involved in helping users set
114 up web serving out of their home directory.
116 * .htaccess - Perhaps as simple as an auto-generated listing of what
117 directives are permitted in .htaccess files. Would be nice if common
118 examples (authentication, adding SSI or CGI capabilities, etc) could
122 Documentation improvements
123 ==========================
125 * Improving the "security docs"
127 - More content and better organisation.
129 * General cleaning and improving of module docs
131 * Making the directive definitions "less terse" (i.e., adding more
132 examples and details to the definitions of the directives)
134 - We'll need to audit these and find out which ones need munging, as
135 some of it looks ok. --jsl
137 - Every directive should have at least one example of usage, except
138 those directives which list all possible usages in the Syntax
139 description. Some module docs have been reviewed for this, and
140 mod/core.html has been checked up through the <Limit> directive.
143 * Making site-specific enhancements easier, including a documented
144 and robust way for 3P module docco to be added -- and have it
145 survive a server docco upgrade
147 - This could be something a simple and hackish as a manual/extra/
148 directory (a la the 1.3 src/modules/extra/ directory) and a
149 script in the support directory that scans the files there and
150 updates the manual indices. (We do something like that now for
151 httpd.conf file with apxs [LoadModule, etc.].)