107N/AApache HTTP Server Trunk Documentation Status File.
107N/AFor more information on how to contribute to the Apache Documentation
107N/A ------------------------------
6983N/AApacheCon 2010 Hackathon To Do List
107N/A===================================
107N/A- mod_lua documentation with examples. (PQuerna has tentatively agreed
107N/A to give us an informal session on mod_lua in order to flesh out the
6983N/A docs and put some force behind the notion that mod_lua can replace
6983N/A- The FAQ has been put into the wiki and Wiki-formatted. It would be
107N/A 2) wherever possible, replace a detailed answer with a link to the
107N/A- Make the docs-project website more useful and actually welcoming of
107N/A- The 1.3 docs need to have links from each directive forward to the
107N/A might be done. This is a large undertaking, and involves a lot of
338N/A grunt work, but will be greatly appreciated by the folks that make it
107N/A to the wrong doc via Google. (Update: This is clearly going to take
107N/A many months of effort, due to the volume of work and the mind-numbing
107N/A- Adding to the discussion of conditional logging, which I think
107N/A could be turned into more of a howto than the one paragraph it's
107N/A document to be useful. In particular:
107N/A - Document the various macros that can be used in documents.
107N/A - Document the translation process.
107N/A - Generally update it to make it reflect the current reality of how
107N/A - Improving the documentation of the documentations' build system
107N/A itself (requirements, procedures)
107N/A- Identify which documents are grossly out of date, and fix.
107N/A- The FAQ never amounted to much. Review the current FAQ, which is
107N/A 1.3-era, and bring it into this century. (RBowen - I've copied the FAQ
107N/A there. Consensus seems to be that this should be its new home.)
107N/A- Security docs are unhelpful, and assume that the reader knows nothing.
107N/A Need something a little more advanced, which either discusses
107N/A application-level security, or links to something that does. I'm not
107N/A even sure what to say needs done. Can we get someone to elaborate on
107N/A what, exactly, needs written? Ivan Ristic has said maybe he would be
107N/A - More content and better organisation
107N/A - mod_dav resources are owned by the httpd. Perhaps write up the
107N/A two-httpd dav setup covered in Rich Bowen's DAV Apachecon
107N/A- Performance doc is way too low-level. Several people have said that
107N/A they might help out here, but it's a significant undertaking, and more
107N/A than a little daunting.
107N/A - Bill Rowe is a good contact for tech questions.
107N/A - "using apache" has been done, "compiling apache" is still open
107N/A - hints on uninstalling apache (exit monitor, close directories,
107N/A registry entries etc) (PR 10154)
107N/A - FAQ: UTF-8 config and URL encoding for non-ascii characters.
107N/A - Much clean-up and enhancement of aaa howto
107N/A - Independent note on how to upgrade to new auth system
107N/A - Discussion of DBD auth, and, in particular, examples of how to set
107N/A up auth using each of the supported databases.
107N/A- Expression syntax for <If> and Require expr
107N/A - Need complete documentation for the expression syntax.
107N/A (Is there any design doc for this? Or do we need to
107N/A - the follwing modules added since 2.2 lack documentation
107N/A - mod_lbmethod_bybusyness
107N/A - mod_lbmethod_byrequests
107N/A - mod_lbmethod_bytraffic
107N/A - mod_lbmethod_heartbeat
107N/A the list may be incomplete
2086N/A maybe some of the modules will not be included in 2.4
107N/A - The following modules have new docs added since 2.2, but are
107N/A grossly lacking in details and examples.
107N/A - mod_suexec: very little documentation
107N/A - mod_rewrite: explain, when which variables are actually available
107N/A- mod_substitute and reverse proxies: Add example using mod_filter
107N/A - explain what the following command line options do
107N/A one-process-mode == no threads,
i.e. only one
107N/A process handling the requests in a single loop?
107N/A- Individual docs will need some cleanup.
107N/A -
dso.xml - Reads as though this is a nifty new thing we just came
107N/A - Ben Laurie has written some hooks documentation
107N/A - authn provider API documentation could be useful
107N/A- SSL docs need serious update and enhancement
107N/A - compat docs are wrong
107N/A - no basic how to setup ssl doc
107N/A mads said he was working on this, but...
- Missing documentation for the support program checkgid
(draft available in wiki)
- New index: directives by context, including listing which directives
are available for each AllowOverride setting.
- New index: backout modules by type (aaa, mappers, loggers etc.)
probably by introducing a <category> element in modulesynopsis
- Use a tag like <var> in place of <em> for things like the
- add letter links to glossary and quickreference,
perhaps also a term overview (sidebar)
- remove <pre> elements. Use <br /> and <indent> elements to get
- Provide example solutions for the mapping of encodings, especially
for .gz etc. (also in regard to our default configuration)
- How-To style documents for more of the daily tasks
- Logging, log rotation, and log reporting
- Secure mod_dav configuration
- Writing modules - Can we provide a basic intro to writing modules,
perhaps based around mod_example, or one of the other simple example
- Purge all the dead links
- API docs are generated via 'make dox'. Find somewhere that we can
do this on a schedule, and link to that from the documentation.
- Introductory module authoring doc
- Verify links to external resources at least every year
- Update the list of translations at
are accurate, and others are way outdated.
- I'd like to expand the discussion of conditional logging, and add a
few more useful exmaples.
That would be a good place to document logging of cache
hit/miss:
- Is it worth having a doc that discusses recommended (what does this
mean?) third-party modules like mod_security, mod_php, and so on - the
things that we all assume everyone uses, but some folks might not know
- Clarify which directives only affect requests when they're handled
by the default handler. (
e.g. ForceType, TraceEnable, etc.)
- Dozens of other little problems with presentation, cross-referencing,
- Cleanup xsl to make it more readable. Almost everything
latex style files rarely have explict licenses. At worst, we can
drop this and manually adjust the relevant spacing.
- Reduce the size of the pdf (both bytes and pages) in any way possible.