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

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