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

   1 Apache HTTP Server 2.1 Documentation Status File.
   2 Last modified: $Date: 2003/05/29 19:46:08 $
   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
  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     - Something that allows dynamic contributions from users a la
  34       FAQ-O-Matic?  (I don't think any really good software exists
  35       for this.)
  36     - Perhaps we can use the newly created Wiki for this. (SubWiki,
  37       with the possibility to get nice commit mails.)
  38        nd: someone should try to convince me, what the heck is
  39            so cool with wikis
  40        erik: it lowers the entry barrier and therefore users are able to
  41              contribute (handy for a FAQ, see PHP site)
  42        nd: yes, good bad example. The PHP docs would mostly be
  43            better without these comments. I don't want to censor
  44            the entries, but also don't want to leave them without
  45            control. IMHO it's better to incorporate changes into the
  46            static docs. We need some better way of feedback, anyway.
  47
  48 Things That Need Fixing
  49 =======================
  50
  51 - Windows platform docs are in desperate need of rewrites/updates for 2.0.
  52     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  53     - "using apache" has been done, "compiling apache" is still open
  54     - hints on uninstalling apache (exit monitor, close directories,
  55       registry entries etc) (PR 10154)
  56     - FAQ! UTF-8 config and URL encoding for non-ascii characters.
  57
  58 - New Auth system
  59     - Much clean-up and enhancement of aaa howto
  60     - Independent note on how to upgrade to new auth system
  61
  62 - modules docs
  63     - mod_suexec: very little documentation
  64     - mod_proxy: updates for 2.0
  65     - mod_status: updates for 2.0
  66     - mod_example: updates for 2.0
  67     - mod_rewrite: explain, when what variables are actually available
  68       (PR 16402)
  69
  70 - man pages
  71     - Convert from nroff to our xml format.  See list at bottom.
  72     - Then if someone gets creative, they can try to find an automatic
  73       way to convert back to nroff.
  74       - An example: http://cyberelk.net/tim/data/xmlto/db2man/
  75         This is designed for docbook, but it could be adapted.
  76         I'm not sure what the license is.
  77
  78 - MPM documentation
  79      - explain what the following command line options do
  80        (perhaps in the developer/debugging docs):
  81         -D DEBUG
  82         -D ONE_PROCESS
  83               one-process-mode == no threads, i.e. only one
  84               process handling the requests in a single loop?
  85         -D NO_DETACH (not in every MPM avail.)
  86               no daemon, but detached from terminal?
  87         -D FOREGROUND (not in every MPM avail.)
  88               ?
  89
  90 - Individual docs will need some cleanup.
  91      - misc/custom_errordocs.html needs to be updated to
  92        essentially describe how the international error
  93        docs included in 2.0 work
  94      - misc/perf-tuning.html - needs major rewrite for 2.0
  95      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
  96      - platform/ebcdic.xml - needs major rework for 2.0
  97
  98 - New build process.
  99     - install.html has had a first-pass rewrite, it is basically
 100       accurate, but very incomplete: many configure options are missing,
 101       especially those inherited from apr.
 102
 103 - API documentation
 104     - Ben Laurie has written some hooks documentation
 105     - authn provider API documentation could be useful
 106
 107 - Several features in Apache require write-access to the filesystem.
 108     Examples: CacheRoot, DavLockDB, ScriptLog
 109     We should treat the things consistently in the docs, and perhaps
 110     suggest the use of directory like /usr/local/apache2/var/ that is
 111     httpd-writable.
 112
 113 - SSL docs are generally good, but they need a refreshing by someone
 114   familiar with mod_ssl and openssl.
 115
 116 Documentation improvements
 117 ==========================
 118
 119 * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
 120
 121 * Enhancements to the DTD/XSL:
 122   - <glossary> tag that links to the glossary and uses some special
 123     style in the css.
 124   - New index: directives by context, including listing which directives
 125     are available for each AllowOverride setting.
 126   - New index: backout modules by type (aaa, mappers, loggers etc.)
 127     probably by introducing a <category> element in modulesynopsis
 128   - Use a tag like <var> in place of <em> for things like the
 129     <syntax> listing.
 130     - in progress
 131   - add letter links to glossary and quickreference,
 132     perhaps also a term overview (sidebar)
 133   - cross references between the different languages,
 134     at least links from non-en docs to the originals.
 135     - Javascript?
 136     - post processing (s&r, XML::Parser, ...)?
 137     - pre processing ([kind of] type maps
 138       generated from sitemap entries like:
 139       <page><variant lang="en" href="">title</variant>)?
 140     - looking for other good ideas ;-)
 141   - remove <pre> elements. Use <br /> and <indent> elements to get
 142     a similar effect.
 143
 144 * Autogeneration of PDF
 145   - André is working on this, Erik volunteers to help out
 146
 147 * Improving the "security docs"
 148   - More content and better organisation.
 149     - mod_dav ressources are owned by the httpd
 150
 151 * General cleaning and improving of module docs
 152
 153 * Making the directive definitions "less terse" (i.e., adding more
 154   examples and details to the definitions of the directives)
 155
 156 * Making site-specific enhancements easier, including a documented
 157   and robust way for 3P module docco to be added -- and have it
 158   survive a server docco upgrade
 159
 160   - This could be something a simple and hackish as a manual/extra/
 161     directory (a la the 1.3 src/modules/extra/ directory) and a
 162     script in the support directory that scans the files there and
 163     updates the manual indices.  (We do something like that now for
 164     httpd.conf file with apxs [LoadModule, etc.].)
 165
 166 * Summarize all the implemented drafts/standards with short explanations
 167   within a document. (PR 16938)
 168