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