STATUS revision 3b1b124e492337a5a2bd446e9575d86ec10109ec
5f5870385cff47efd2f58e7892f251cf13761528Timo SirainenApache HTTP Server 2.0 Documentation Status File.
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo SirainenLast modified: $Date: 2002/07/25 21:36:43 $
377dd19a90436b8f96902af741a3ea130bc3fe75Timo SirainenIf you are interested in helping accomplish some of the tasks on this
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainenlist or otherwise improving the documentation, please join the
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainenapache-docs mailing list by mailing to
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainenapache-docs-subscribe@apache.org
377dd19a90436b8f96902af741a3ea130bc3fe75Timo SirainenFor more information on how to contribute to the Apache Documentation
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo SirainenProject, please see http://httpd.apache.org/docs-project/, and
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainenhttp://apache-server.com/tutorials/ATdocs-project.html for an excellent
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainentutorial on how to get started with making your contribution.
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen ------------------------------
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen- doc-project webpage should be updated to recommend subscription to the
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen CVS mailing list.
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen - The xsl transformations could be greatly improved to a) look better
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen and b) use proper CSS+html rather than the horrible hack that
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen - xslt code needs to be added to deal with <manualpage>; shouldn't be
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen too difficult.
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen - Build system needs to be modified to transform directories other than
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen mod/ and probably to set up some variables to get references in the
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen <directive> and <module> tags to point to the right place.
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen- modules docs
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen - mod_suexec: very little documentation
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - mod_proxy: updates for 2.0
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - mod_status: updates for 2.0
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - mod_example: updates for 2.0
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Some of the man pages need to be updated for 2.0. At least
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen the httpd man page appears to be outdated, and perhaps other.
9522aa5f33cc37fe8ccd0d647cc51dd3ba6a9b55Timo Sirainen After this is done, the manual/programs/ versions can be
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen regenerated using the program in the site-tools repository.
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen- MPM documentation
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Each MPM needs to have a documentation file in manual/mod/
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen which lists the directives it provides, and some details
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen about its operation.
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen Status: Initial outlines done. Much more details need to be
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Non unix/windows MPMs still need to be completed.
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - the perchild directives in threaded/worker need docs
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Individual docs will need some cleanup.
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen Status: What docs still need to be touched here?
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen - misc/custom_errordocs.html needs to be updated to
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen essentially describe how the international error
fe7f9298fb789717d26dc4cb6317a9d376acd8fcTimo Sirainen docs included in 2.0 work
3574bab52a67dfe1291f6306e707c6199e777043Timo Sirainen - misc/perf-tuning.html - needs major rewrite for 2.0
3574bab52a67dfe1291f6306e707c6199e777043Timo Sirainen - misc/tutorials.html - mostly not relevant to 2.0
5a5b39ce7c6ba6d6ff2218ae1679e0485bf43b47Timo Sirainen - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen - misc/known_client_problems.html - mostly ancient
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen- New build process.
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen - install.html has had a first-pass rewrite, but many things have
fe7f9298fb789717d26dc4cb6317a9d376acd8fcTimo Sirainen changed in the build system since it was written.
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen- Documentation of new features.
03fa2d644be0a9274e7e94fb4835cc374c539264Timo Sirainen - This will probably require more input from new-httpd, since
03fa2d644be0a9274e7e94fb4835cc374c539264Timo Sirainen not many people here follow the development process close
0a53eb0283d7ec28c6105f61e118b96fce8ecb95Timo Sirainen enough to know what is going on.
4bc4042782c465636eff2c713bc85f5a1d773d91Timo Sirainen- API documentation
4bc4042782c465636eff2c713bc85f5a1d773d91Timo Sirainen Status: Ben Laurie has written some hooks documentation
9a656df90290a5fef45b3a1191ae75864f17602dTimo Sirainen- Translations
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - We need a webpage describing the basics of how to go about translating
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen the apache docs. Things like naming conventions, reviewing standards,
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen and perhaps some standard comments to put at the top of each doc
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen (english version, auther, reviewer).
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen We appear to have people working on translation into the following
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen languages. These may just be the 'it worked' page, but if so
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen the authors of those should perhaps be contacted to help do the
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen rest.. :-) Note that this list is NOT identical to that for the
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen 1.3 documentation project..!
377dd19a90436b8f96902af741a3ea130bc3fe75Timo Sirainen [Should we attempt to get a known-current authorlist together? --jsl]
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Catalan (.ca)
0a53eb0283d7ec28c6105f61e118b96fce8ecb95Timo Sirainen - Czech Republic (.cz)
4bc4042782c465636eff2c713bc85f5a1d773d91Timo Sirainen - German (.de)
ee3362f3b78827a2c9a7e9ddee83f5a429c06213Timo Sirainen - Danish (.dk)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Estonia (.ee)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Greek (.el)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Spanish (.es)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Estonian (.et)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - French (.fr)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Italian (.it)
6cb8e7d726a7e9d157e87fb379982d52100b283fTimo Sirainen - Luxembourgish (.lb)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Dutch (.nl)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Norwegian (.no)
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen - Portuguese (.pt)
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen - Portuguese [Brasilian] (.pt-br)
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen - Russian (.ru.cp-1251, .ru.cp866, .ru.iso-ru, .ru.koi8-r, .ru.ucs[248])
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Swedish (.se)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - Chinese (.zh)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen [Need this clarified --jsl]
8d63b0ab4dea920a4dd6a4469289950eef50a063Timo SirainenNew User documentation
242abe3ad2423776e9cf05e1304eb8fda4831b23Timo Sirainen======================
f64b5bc9e73bedc63ba3c072c286542c29c69e43Timo Sirainen* Directory Handling (mod_dir/mod_autoindex/etc)
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen* Sections (<Directory>/<Files>/<Location>)
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen - I think this should be a priority. A rewrite of /sections.html would
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen be a good place to start. That document is too technical and
0a53eb0283d7ec28c6105f61e118b96fce8ecb95Timo Sirainen insufficiently verbose for the average user.
2670cd577aa57eb9f915a4f4220ae48c9b4fc5fbTimo Sirainen* public_html - tutorial covering what is involved in helping users set
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen up web serving out of their home directory.
98d5941dc28754f32432edc38578b946ba71dd0bTimo SirainenDocumentation improvements
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen==========================
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen* Improving the "security docs"
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen - More content and better organisation.
4847d74a7442a3efabe76a8ad18dd464082d6581Timo Sirainen* General cleaning and improving of module docs
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen* Making the directive definitions "less terse" (i.e., adding more
98d5941dc28754f32432edc38578b946ba71dd0bTimo Sirainen examples and details to the definitions of the directives)
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen - We'll need to audit these and find out which ones need munging, as
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen some of it looks ok. --jsl
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen* Making site-specific enhancements easier, including a documented
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen and robust way for 3P module docco to be added -- and have it
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen survive a server docco upgrade
cc22ca265b5b355c4a029155e074f36b5baf2e60Timo Sirainen - This could be something a simple and hackish as a manual/extra/
cc22ca265b5b355c4a029155e074f36b5baf2e60Timo Sirainen directory (a la the 1.3 src/modules/extra/ directory) and a
cc22ca265b5b355c4a029155e074f36b5baf2e60Timo Sirainen script in the support directory that scans the files there and
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen updates the manual indices. (We do something like that now for
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen httpd.conf file with apxs [LoadModule, etc.].)
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen* regex: We should at least document someplace what regex library we
5f5713d6468dca1acf3d350dd8a33057331f78c5Timo Sirainen are using and how to find more information about it