STATUS revision 3d25838a50fb782af88ea3ac4c5a3bc2b1a1159e
b341a780162d809b187a8f35a10bba7642b69798vboxsyncApache HTTP Server Trunk Documentation Status File.
d34409ad02ea0d28e08a6c4b089a412fdb3b4c9cvboxsyncLast modified: $Date$
b341a780162d809b187a8f35a10bba7642b69798vboxsyncFor more information on how to contribute to the Apache Documentation
b341a780162d809b187a8f35a10bba7642b69798vboxsyncProject, please see http://httpd.apache.org/docs-project/ and
8d1ef2acf41d1d8a0f69bfe0ac1f41638160399cvboxsynchttp://httpd.apache.org/docs-project/docsformat.html
b341a780162d809b187a8f35a10bba7642b69798vboxsync ------------------------------
b341a780162d809b187a8f35a10bba7642b69798vboxsync=======================
b341a780162d809b187a8f35a10bba7642b69798vboxsync- Rewriting the custom-error document, which is grossly outdated.
b341a780162d809b187a8f35a10bba7642b69798vboxsync- Adding to the discussion of conditional logging, which I think
b341a780162d809b187a8f35a10bba7642b69798vboxsync could be turned into more of a howto than the one paragraph it's
b341a780162d809b187a8f35a10bba7642b69798vboxsync- Refer to this product as either 'Apache HTTP Server' or 'httpd', as
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync appropriate in context, rather than just 'Apache'. 'Apache' is the
b341a780162d809b187a8f35a10bba7642b69798vboxsync Apache Software Foundation.
b341a780162d809b187a8f35a10bba7642b69798vboxsync- Update the http://httpd.apache.org/docs-project/docsformat.html
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync document to be useful. In particular:
b341a780162d809b187a8f35a10bba7642b69798vboxsync - Document the various macros that can be used in documents.
d05e0aca826e72aa0cc78aced33dc8fc036c4483vboxsync - Document the translation process.
e2b54646f72dde25f46401f08ed8cc504a37f704vboxsync - Generally update it to make it reflect the current reality of how
e2b54646f72dde25f46401f08ed8cc504a37f704vboxsync - Improving the documentation of the documentations' build system
e2b54646f72dde25f46401f08ed8cc504a37f704vboxsync itself (requirements, procedures)
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync- Update this document. Determine which of these issues are in fact
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync still open, and which have already been dealt with.
2d4c4983fd26f0ab406f52524949229724ccbe74vboxsync- Identify which documents are grossly out of date, and fix.
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync- The FAQ never amounted to much. Review the current FAQ, which is
0de1998ac52682bb5322df476e45f237265ea9b7vboxsync 1.3-era, and bring it into this century.
b073edf5c9b00e49e6d4132e85fe60818dbc50dbvboxsync- Security docs are unhelpful, and assume that the reader knows nothing.
87b5b156b993057a03a22aee48c824ead49738a9vboxsync Need something a little more advanced, which either discusses
87b5b156b993057a03a22aee48c824ead49738a9vboxsync application-level security, or links to something that does. I'm not
069b9101fbd3b049610c5511b1cc9534d01ea472vboxsync even sure what to say needs done. Can we get someone to elaborate on
069b9101fbd3b049610c5511b1cc9534d01ea472vboxsync what, exactly, needs written? Ivan Ristic has said maybe he would be
069b9101fbd3b049610c5511b1cc9534d01ea472vboxsync willing to contribute.
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync - More content and better organisation
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync - mod_dav resources are owned by the httpd. Perhaps write up the
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync two-httpd dav setup covered in Rich Bowen's DAV Apachecon
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync presentation.
e2b54646f72dde25f46401f08ed8cc504a37f704vboxsync- Performance doc is way too low-level. Several people have said that
b341a780162d809b187a8f35a10bba7642b69798vboxsync they might help out here, but it's a significant undertaking, and more
b341a780162d809b187a8f35a10bba7642b69798vboxsync than a little daunting.
b341a780162d809b187a8f35a10bba7642b69798vboxsync- Windows platform docs are in desperate need of rewrites/updates for 2.x.
0a6d1cee0381d167a5ba61880bf05456fff798d5vboxsync - Bill Rowe and Bill Stoddard are good contacts for tech questions.
0a6d1cee0381d167a5ba61880bf05456fff798d5vboxsync - "using apache" has been done, "compiling apache" is still open
0a6d1cee0381d167a5ba61880bf05456fff798d5vboxsync - hints on uninstalling apache (exit monitor, close directories,
0a6d1cee0381d167a5ba61880bf05456fff798d5vboxsync registry entries etc) (PR 10154)
0a6d1cee0381d167a5ba61880bf05456fff798d5vboxsync - FAQ: UTF-8 config and URL encoding for non-ascii characters.
b341a780162d809b187a8f35a10bba7642b69798vboxsync- New Auth system
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - Much clean-up and enhancement of aaa howto
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - Independent note on how to upgrade to new auth system
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - Discussion of DBD auth, and, in particular, examples of how to set
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync up auth using each of the supported databases.
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync- modules docs
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - the follwing modules added since 2.2 lack documentation
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - mod_dialup
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - mod_lua (Doc added, but still very rough.)
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - mod_ratelimit
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - mod_watchdog
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - mod_heartbeat
9939e2124ce2cb00f28b089e4d78a1c4569f1009vboxsync - mod_heartmonitor
1910146bc46e3eee5b8668806da594107fe9aabfvboxsync - mod_lbmethod_bybusyness
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync - mod_lbmethod_byrequests
b341a780162d809b187a8f35a10bba7642b69798vboxsync - mod_lbmethod_bytraffic
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync - mod_lbmethod_heartbeat
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync - mod_socache_dbm
b341a780162d809b187a8f35a10bba7642b69798vboxsync - mod_socache_memcache
b341a780162d809b187a8f35a10bba7642b69798vboxsync - mod_socache_shmcb
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync - mpm_simple
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync the list may be incomplete
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync maybe some of the modules will not be included in 2.4
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync - mod_suexec: very little documentation
b341a780162d809b187a8f35a10bba7642b69798vboxsync - mod_rewrite: explain, when which variables are actually available
e2b54646f72dde25f46401f08ed8cc504a37f704vboxsync- MPM documentation
63053bf6ac5b4b7ea12b8d049180069e14f35d04vboxsync - explain what the following command line options do
2a54a98806b7ab4fb07a7f7be0e596da2c4c7397vboxsync (perhaps in the developer/debugging docs):
0de1998ac52682bb5322df476e45f237265ea9b7vboxsync -D ONE_PROCESS
9c017ff10920b7c2b1ed8ed650fd76717462d799vboxsync one-process-mode == no threads, i.e. only one
8ed23859c0e44a03f928100d5ead26a135d1f68bvboxsync process handling the requests in a single loop?
ce9bcdffe758afb7468df441551f0ce7b7084d55vboxsync- Individual docs will need some cleanup.
ce9bcdffe758afb7468df441551f0ce7b7084d55vboxsync - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
ce9bcdffe758afb7468df441551f0ce7b7084d55vboxsync - platform/ebcdic.xml - needs major rework for 2.0
49503a0bd81d413b5896c64a3db70b5e29db2049vboxsync - dso.xml - Reads as though this is a nifty new thing we just came
49503a0bd81d413b5896c64a3db70b5e29db2049vboxsync up with recently.
2e1486246f81c66189020361c3bdc93ec90ebdd2vboxsync- API documentation
2e1486246f81c66189020361c3bdc93ec90ebdd2vboxsync - Ben Laurie has written some hooks documentation
3cdef5504e9fb186b78113c97636a33a479ffeebvboxsync - authn provider API documentation could be useful
3cdef5504e9fb186b78113c97636a33a479ffeebvboxsync- SSL docs need serious update and enhancement
d4751d58b8426d696cfd906fed41ab30ae18bc9cvboxsync - compat docs are wrong
34370838dcf25e846b2a3b0032ce1eb47a1eb351vboxsync - no basic how to setup ssl doc
34370838dcf25e846b2a3b0032ce1eb47a1eb351vboxsync mads said he was working on this, but...
34370838dcf25e846b2a3b0032ce1eb47a1eb351vboxsync- How does <Proxy> fit into sections.html?
d34fd1b6c462748ecf36c49b84c27a8f77bf5be6vboxsync- Missing documentation for the support program checkgid
abcb6b328dd9d49f1fff64745167abce1d448fd6vboxsync- New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
9e32493c5dc27f447f289b8e16ec77f5fcda3883vboxsync (draft available in wiki)
9e32493c5dc27f447f289b8e16ec77f5fcda3883vboxsync- Enhancements to the DTD/XSL:
0ebe61ec4cb71b4672ce5aae561bb0708b841272vboxsync - New index: directives by context, including listing which directives
0ebe61ec4cb71b4672ce5aae561bb0708b841272vboxsync are available for each AllowOverride setting.
0ebe61ec4cb71b4672ce5aae561bb0708b841272vboxsync - New index: backout modules by type (aaa, mappers, loggers etc.)
62deca0ebd8d66e21f58703e5d4409922387084bvboxsync probably by introducing a <category> element in modulesynopsis
62deca0ebd8d66e21f58703e5d4409922387084bvboxsync - Use a tag like <var> in place of <em> for things like the
62deca0ebd8d66e21f58703e5d4409922387084bvboxsync <syntax> listing.
64c6abf772e2599fb614ed75c11b8570a6da5697vboxsync - in progress
db813f691857a4b61f81ac59a3f2cf56e8afedb4vboxsync - add letter links to glossary and quickreference,
db813f691857a4b61f81ac59a3f2cf56e8afedb4vboxsync perhaps also a term overview (sidebar)
49503a0bd81d413b5896c64a3db70b5e29db2049vboxsync - remove <pre> elements. Use <br /> and <indent> elements to get
49503a0bd81d413b5896c64a3db70b5e29db2049vboxsync a similar effect.
b341a780162d809b187a8f35a10bba7642b69798vboxsync- Provide example solutions for the mapping of encodings, especially
b341a780162d809b187a8f35a10bba7642b69798vboxsync for .gz etc. (also in regard to our default configuration)
b341a780162d809b187a8f35a10bba7642b69798vboxsync- How-To style documents for more of the daily tasks
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync - Logging, log rotation, and log reporting
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync- Writing modules - Can we provide a basic intro to writing modules,
d9992886d98f1ab92fe43b15a58f75a374cb3f1evboxsync perhaps based around mod_example, or one of the other simple example
b341a780162d809b187a8f35a10bba7642b69798vboxsync- http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync profound embarrassment.
b094ef7cd1c380aa0bdec0b8d276ac397efb101bvboxsync - Purge all the dead links
b094ef7cd1c380aa0bdec0b8d276ac397efb101bvboxsync - API docs are generated via 'make dox'. Find somewhere that we can
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync do this on a schedule, and link to that from the documentation.
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync - Introductory module authoring doc
9e32493c5dc27f447f289b8e16ec77f5fcda3883vboxsync - Verify links to external resources at least every year
b094ef7cd1c380aa0bdec0b8d276ac397efb101bvboxsync- Update the list of translations at
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync http://httpd.apache.org/docs-project/translations.html Some of those
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync are accurate, and others are way outdated.
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync- I'd like to expand the discussion of conditional logging, and add a
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync few more useful exmaples.
cfa82602cc477153717a0875667946520e6fee76vboxsync That would be a good place to document logging of cache hit/miss:
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync- The mod_usertrack docs should describe what the module does, now,
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync rather than spending so much time comparing it to what a long-gone
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync module, which our readers never used, used to do. Examples would be
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync helpful. Additionally, a significant part of the doc consists of a
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync quoted email message. This seems somewhat unprofessional.
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync- Document mod_lua based on the various docs at
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync https://svn.apache.org/repos/asf/httpd/httpd/trunk/modules/lua/docs/
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsyncLaTeX Todo list
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync==================
1781347b2a037971c77ec6823ffa3fd07db4e8devboxsync- Dozens of other little problems with presentation, cross-referencing,
b341a780162d809b187a8f35a10bba7642b69798vboxsync- Cleanup xsl to make it more readable. Almost everything
8d1ef2acf41d1d8a0f69bfe0ac1f41638160399cvboxsync that is currently in latex.xsl should probably be moved to common.xsl.
4429cc47d1e3ca88d6237e5ee7a876dc409cdc24vboxsync There may be a license problem with the atbeginend.sty file, since
2646f8fc98fb2780f8b84875b314ceddd08cf2a3vboxsync latex style files rarely have explict licenses. At worst, we can
b341a780162d809b187a8f35a10bba7642b69798vboxsync drop this and manually adjust the relevant spacing.
377e7dedbfa893b91c37bbcca7bdc1d68a018ae8vboxsync- Reduce the size of the pdf (both bytes and pages) in any way possible.
df99b216f298b5a3c25877ff677b190ba0f6f131vboxsync- Translations.