granicus.if.org Git - apache/blob - docs/STATUS

   1 Apache HTTP Server Trunk Documentation Status File.
   2 Last modified: $Date$
   3
   4 For more information on how to contribute to the Apache Documentation
   5 Project, please see http://httpd.apache.org/docs-project/ and
   6 http://httpd.apache.org/docs-project/docsformat.html
   7
   8               ------------------------------
   9
  10 To Do List
  11 =======================
  12
  13 - The dns-caveats document is largely rubbish, and needs to be
  14   completely rewritten. Many of the points stopped being true over a
  15   decade ago.
  16
  17 - The 1.3 docs need to have links from each directive forward to the
  18   /docs/current/ version of that directive, or a note that it's not
  19   avaialble in this century. See core.html for examples of how this
  20   might be done. This is a large undertaking, and involves a lot of
  21   grunt work, but will be greatly appreciated by the folks that make it
  22   to the wrong doc via Google.
  23
  24 - Update custom-error document to mention the negotiated SSI error docs
  25   introduced back in 2.0.
  26
  27 - Adding to the discussion of conditional logging, which I think
  28   could be turned into more of a howto than the one paragraph it's
  29   got now.
  30
  31 - Update the http://httpd.apache.org/docs-project/docsformat.html
  32   document to be useful. In particular:
  33     - Document the various macros that can be used in documents.
  34     - Document the translation process.
  35     - Generally update it to make it reflect the current reality of how
  36       we work.
  37     -  Improving the documentation of the documentations' build system
  38        itself (requirements, procedures)
  39
  40 - Identify which documents are grossly out of date, and fix.
  41
  42 - The FAQ never amounted to much. Review the current FAQ, which is
  43   1.3-era, and bring it into this century.
  44
  45 - Security docs are unhelpful, and assume that the reader knows nothing.
  46   Need something a little more advanced, which either discusses
  47   application-level security, or links to something that does. I'm not
  48   even sure what to say needs done. Can we get someone to elaborate on
  49   what, exactly, needs written? Ivan Ristic has said maybe he would be
  50   willing to contribute.
  51   - More content and better organisation
  52   - mod_dav resources are owned by the httpd. Perhaps write up the
  53     two-httpd dav setup covered in Rich Bowen's DAV Apachecon
  54     presentation.
  55
  56 - Performance doc is way too low-level. Several people have said that
  57   they might help out here, but it's a significant undertaking, and more
  58   than a little daunting.
  59
  60 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
  61     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  62     - "using apache" has been done, "compiling apache" is still open
  63     - hints on uninstalling apache (exit monitor, close directories,
  64       registry entries etc) (PR 10154)
  65     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  66
  67 - New Auth system
  68     - Much clean-up and enhancement of aaa howto
  69     - Independent note on how to upgrade to new auth system
  70     - Discussion of DBD auth, and, in particular, examples of how to set
  71       up auth using each of the supported databases.
  72
  73 - modules docs
  74     - the follwing modules added since 2.2 lack documentation
  75         - mod_serf
  76         - mod_watchdog
  77         - mod_heartbeat
  78         - mod_heartmonitor
  79         - mod_lbmethod_bybusyness
  80         - mod_lbmethod_byrequests
  81         - mod_lbmethod_bytraffic
  82         - mod_lbmethod_heartbeat
  83         - mod_socache_dbm
  84         - mod_socache_memcache
  85         - mod_socache_shmcb
  86         - mpm_simple
  87       the list may be incomplete
  88       maybe some of the modules will not be included in 2.4
  89     - The following modules have new docs added since 2.2, but are
  90       grossly lacking in details and examples.
  91         - mod_dialup
  92     - mod_suexec: very little documentation
  93     - mod_rewrite: explain, when which variables are actually available
  94       (PR 16402)
  95
  96 - MPM documentation
  97      - explain what the following command line options do
  98        (perhaps in the developer/debugging docs):
  99         -D DEBUG
 100         -D ONE_PROCESS
 101               one-process-mode == no threads, i.e. only one
 102               process handling the requests in a single loop?
 103
 104 - Individual docs will need some cleanup.
 105      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
 106      - platform/ebcdic.xml - needs major rework for 2.0
 107      - dso.xml - Reads as though this is a nifty new thing we just came
 108        up with recently.
 109
 110 - API documentation
 111     - Ben Laurie has written some hooks documentation
 112     - authn provider API documentation could be useful
 113
 114 - SSL docs need serious update and enhancement
 115     - compat docs are wrong
 116     - no basic how to setup ssl doc
 117     mads said he was working on this, but...
 118
 119 - How does <Proxy> fit into sections.html?
 120
 121 - Missing documentation for the support program checkgid
 122
 123 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
 124   (draft available in wiki)
 125
 126 - Enhancements to the DTD/XSL:
 127   - New index: directives by context, including listing which directives
 128     are available for each AllowOverride setting.
 129   - New index: backout modules by type (aaa, mappers, loggers etc.)
 130     probably by introducing a <category> element in modulesynopsis
 131   - Use a tag like <var> in place of <em> for things like the
 132     <syntax> listing.
 133     - in progress
 134   - add letter links to glossary and quickreference,
 135     perhaps also a term overview (sidebar)
 136   - remove <pre> elements. Use <br /> and <indent> elements to get
 137     a similar effect.
 138
 139 - Provide example solutions for the mapping of encodings, especially
 140   for .gz etc. (also in regard to our default configuration)
 141
 142 - How-To style documents for more of the daily tasks
 143     - Logging, log rotation, and log reporting
 144     - ?
 145
 146 - Writing modules - Can we provide a basic intro to writing modules,
 147   perhaps based around mod_example, or one of the other simple example
 148   modules?
 149
 150 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
 151   profound embarrassment.
 152     - Purge all the dead links
 153     - API docs are generated via 'make dox'. Find somewhere that we can
 154       do this on a schedule, and link to that from the documentation.
 155     - Introductory module authoring doc
 156     - Verify links to external resources at least every year
 157
 158 - Update the list of translations at
 159   http://httpd.apache.org/docs-project/translations.html  Some of those
 160   are accurate, and others are way outdated.
 161
 162 - I'd like to expand the discussion of conditional logging, and add a
 163   few more useful exmaples.
 164   That would be a good place to document logging of cache hit/miss:
 165   https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
 166
 167 - The mod_usertrack docs should describe what the module does, now,
 168   rather than spending so much time comparing it to what a long-gone
 169   module, which our readers never used, used to do. Examples would be
 170   helpful. Additionally, a significant part of the doc consists of a
 171   quoted email message. This seems somewhat unprofessional.
 172
 173 - Is it worth having a doc that discusses recommended (what does this
 174   mean?) third-party modules like mod_security, mod_php, and so on - the
 175   things that we all assume everyone uses, but some folks might not know
 176   about.
 177
 178 LaTeX Todo list
 179 ==================
 180
 181 - Dozens of other little problems with presentation, cross-referencing,
 182   etc.
 183
 184 - Cleanup xsl to make it more readable.  Almost everything
 185   that is currently in latex.xsl should probably be moved to common.xsl.
 186   There may be a license problem with the atbeginend.sty file, since
 187   latex style files rarely have explict licenses.  At worst, we can
 188   drop this and manually adjust the relevant spacing.
 189
 190 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 191
 192 - Translations.
 193