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