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