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

   1 Apache HTTP Server 2.1 Documentation Status File.
   2 Last modified: $Date: 2003/06/01 20:48:54 $
   3
   4 For more information on how to contribute to the Apache Documentation
   5 Project, please see http://httpd.apache.org/docs-project/
   6
   7               ------------------------------
   8
   9 Decisions pending
  10 =================
  11
  12   -Comment out .gz etc. AddEncoding lines in our default configuration.
  13     docs/conf/httpd-std.conf.in rev 1.32
  14     jerenkrantz said in the log message:
  15         Current browsers have a tendency to decompress the data when no one
  16         really wants it to do that.  If you want the old behavior that leads to
  17         transparent decompression by modern browsers, uncomment these lines.
  18         But, this shouldn't be our default.
  19     Someone else said: Certainly wasn't in 1.3.
  20     nd adds: we should provide example solutions somewhere in the docs.
  21       e.g.: .tar.gz should get the content-type application/x-gzip
  22       (hmm, bad x-, better suggestions?).
  23       <Files *.tar.gz>
  24         Forcetype ...
  25       </Files>
  26
  27      - Backport to 2.0
  28        +1: wrowe, slive, nd, erik
  29
  30 - Figure out what to do about the 2.0 FAQ
  31     - Copy important stuff from 1.3?
  32     - Some kind of XML?
  33     - Perhaps we can use the newly created Wiki for this. (SubWiki,
  34       with the possibility to get nice commit mails.)
  35        nd: someone should try to convince me, what the heck is
  36            so cool with wikis
  37        erik: it lowers the entry barrier and therefore users are able
  38              to contribute without all the build hassles (see PHP site)
  39        nd: yes, good bad example. The PHP docs would mostly be
  40            better without these comments. I don't want to censor
  41            the entries, but also don't want to leave them without
  42            control. IMHO it's better to incorporate changes into the
  43            static docs. We need some better way of feedback, anyway.
  44        erik: yes, the plan could be to have the wiki as some sort of
  45              scratch_pad (clearly stated on the relevant pages) and
  46              finally incorporate the useful info in it into the static
  47              documentation
  48
  49 Things That Need Fixing
  50 =======================
  51
  52 - Windows platform docs are in desperate need of rewrites/updates for 2.0.
  53     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  54     - "using apache" has been done, "compiling apache" is still open
  55     - hints on uninstalling apache (exit monitor, close directories,
  56       registry entries etc) (PR 10154)
  57     - FAQ! UTF-8 config and URL encoding for non-ascii characters.
  58
  59 - New Auth system
  60     - Much clean-up and enhancement of aaa howto
  61     - Independent note on how to upgrade to new auth system
  62
  63 - modules docs
  64     - mod_suexec: very little documentation
  65     - mod_proxy: updates for 2.0
  66     - mod_status: updates for 2.0
  67     - mod_example: updates for 2.0
  68     - mod_rewrite: explain, when what variables are actually available
  69       (PR 16402)
  70
  71 - MPM documentation
  72      - explain what the following command line options do
  73        (perhaps in the developer/debugging docs):
  74         -D DEBUG
  75         -D ONE_PROCESS
  76               one-process-mode == no threads, i.e. only one
  77               process handling the requests in a single loop?
  78         -D NO_DETACH (not in every MPM avail.)
  79               no daemon, but detached from terminal?
  80         -D FOREGROUND (not in every MPM avail.)
  81               ?
  82
  83 - Individual docs will need some cleanup.
  84      - misc/custom_errordocs.html needs to be updated to
  85        essentially describe how the international error
  86        docs included in 2.0 work
  87      - misc/perf-tuning.html - needs major rewrite for 2.0
  88      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
  89      - platform/ebcdic.xml - needs major rework for 2.0
  90
  91 - New build process.
  92     - install.html has had a first-pass rewrite, it is basically
  93       accurate, but very incomplete: many configure options are missing,
  94       especially those inherited from apr.
  95
  96 - API documentation
  97     - Ben Laurie has written some hooks documentation
  98     - authn provider API documentation could be useful
  99
 100 - Several features in Apache require write-access to the filesystem.
 101     Examples: CacheRoot, DavLockDB, ScriptLog
 102     We should treat the things consistently in the docs, and perhaps
 103     suggest the use of directory like /usr/local/apache2/var/ that is
 104     httpd-writable.
 105
 106 - SSL docs are generally good, but they need a refreshing by someone
 107   familiar with mod_ssl and openssl.
 108
 109 Documentation improvements
 110 ==========================
 111
 112 * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
 113
 114 * Enhancements to the DTD/XSL:
 115   - <glossary> tag that links to the glossary and uses some special
 116     style in the css.
 117   - New index: directives by context, including listing which directives
 118     are available for each AllowOverride setting.
 119   - New index: backout modules by type (aaa, mappers, loggers etc.)
 120     probably by introducing a <category> element in modulesynopsis
 121   - Use a tag like <var> in place of <em> for things like the
 122     <syntax> listing.
 123     - in progress
 124   - add letter links to glossary and quickreference,
 125     perhaps also a term overview (sidebar)
 126   - remove <pre> elements. Use <br /> and <indent> elements to get
 127     a similar effect.
 128
 129 * Autogeneration of PDF
 130   - André is working on this, Erik volunteers to help out
 131
 132 * Improving the documentation of the documentations' build system
 133   itself (requirements, procedures)
 134
 135 * Improving the "security docs"
 136   - More content and better organisation
 137   - mod_dav ressources are owned by the httpd
 138
 139 * General cleaning and improving of module docs
 140
 141 * Making the directive definitions "less terse" (i.e., adding more
 142   examples and details to the definitions of the directives)
 143
 144 * Making site-specific enhancements easier, including a documented
 145   and robust way for 3P module docco to be added -- and have it
 146   survive a server docco upgrade
 147
 148   - This could be something a simple and hackish as a manual/extra/
 149     directory (a la the 1.3 src/modules/extra/ directory) and a
 150     script in the support directory that scans the files there and
 151     updates the manual indices.  (We do something like that now for
 152     httpd.conf file with apxs [LoadModule, etc.].)
 153
 154 * Summarize all the implemented drafts/standards with short explanations
 155   within a document. (PR 16938)
 156