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

   1 Apache HTTP Server 2.1 Documentation Status File.
   2 Last modified: $Date: 2004/04/02 21:08:29 $
   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 - Remove several out-of-place files into somewhere in the tree outside
  13   of the actual web site content?  Erik suggests we merge the two icons
  14   readmes into one.  Perhaps all of these go into httpd-2.0/docs/README?
  15     error/readme
  16     icons/readme
  17     icons/small/readme.txt
  18   Votes for a single top-level README reference?
  19   +1: wrowe, slive, nd, erikabele, kess, mads
  20
  21
  22 Things That Need Fixing
  23 =======================
  24
  25 - Windows platform docs are in desperate need of rewrites/updates for 2.0.
  26     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  27     - "using apache" has been done, "compiling apache" is still open
  28     - hints on uninstalling apache (exit monitor, close directories,
  29       registry entries etc) (PR 10154)
  30     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  31     - FAQ: AcceptEx failed / virusscanner, firewall fun
  32
  33 - New Auth system
  34     - Much clean-up and enhancement of aaa howto
  35     - Independent note on how to upgrade to new auth system
  36
  37 - modules docs
  38     - mod_suexec: very little documentation
  39     - mod_status: updates for 2.0
  40     - mod_example: updates for 2.0
  41     - mod_rewrite: explain, when which variables are actually available
  42       (PR 16402)
  43
  44 - MPM documentation
  45      - explain what the following command line options do
  46        (perhaps in the developer/debugging docs):
  47         -D DEBUG
  48         -D ONE_PROCESS
  49               one-process-mode == no threads, i.e. only one
  50               process handling the requests in a single loop?
  51         -D NO_DETACH (not in every MPM avail.)
  52               no daemon, but detached from terminal?
  53         -D FOREGROUND (not in every MPM avail.)
  54               ?
  55
  56 - Individual docs will need some cleanup.
  57      - misc/custom_errordocs.html needs to be updated to
  58        essentially describe how the international error
  59        docs included in 2.0 work
  60      - misc/perf-tuning.html - needs major rewrite for 2.0
  61      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
  62      - platform/ebcdic.xml - needs major rework for 2.0
  63
  64 - API documentation
  65     - Ben Laurie has written some hooks documentation
  66     - authn provider API documentation could be useful
  67
  68 - SSL docs need serious update and enhancement
  69     - compat docs are wrong
  70     - no basic how to setup ssl doc
  71     mads said he was working on this, but...
  72
  73 - How does <Proxy> fit into sections.html?
  74
  75 Documentation improvements
  76 ==========================
  77
  78 * Missing documentation for the support programs htdbm and checkgid
  79
  80 * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
  81
  82 * Enhancements to the DTD/XSL:
  83   - <glossary> tag that links to the glossary and uses some special
  84     style in the css.
  85   - New index: directives by context, including listing which directives
  86     are available for each AllowOverride setting.
  87   - New index: backout modules by type (aaa, mappers, loggers etc.)
  88     probably by introducing a <category> element in modulesynopsis
  89   - Use a tag like <var> in place of <em> for things like the
  90     <syntax> listing.
  91     - in progress
  92   - add letter links to glossary and quickreference,
  93     perhaps also a term overview (sidebar)
  94   - remove <pre> elements. Use <br /> and <indent> elements to get
  95     a similar effect.
  96
  97 * Improving the documentation of the documentations' build system
  98   itself (requirements, procedures)
  99
 100 * Improving the "security docs"
 101   - More content and better organisation
 102   - mod_dav ressources are owned by the httpd
 103
 104 * Making site-specific enhancements easier, including a documented
 105   and robust way for 3P module docco to be added -- and have it
 106   survive a server docco upgrade
 107
 108   - This could be something a simple and hackish as a manual/extra/
 109     directory (a la the 1.3 src/modules/extra/ directory) and a
 110     script in the support directory that scans the files there and
 111     updates the manual indices.  (We do something like that now for
 112     httpd.conf file with apxs [LoadModule, etc.].)
 113
 114 * Provide example solutions for the mapping of encodings, especially
 115   for .gz etc. (also in regard to our default configuration)
 116
 117 * Several features in Apache require write-access to the filesystem.
 118     Examples: CacheRoot, DavLockDB, ScriptLog
 119     We should treat the things consistently in the docs, and perhaps
 120     suggest the use of directory like /usr/local/apache2/var/ that is
 121     httpd-writable.
 122
 123 * Change the name 'Apache' to 'Apache HTTP Server' or 'http'.
 124
 125 LaTeX Todo list
 126 ==================
 127
 128 - Dozens of other little problems with presentation, cross-referencing,
 129   etc.
 130
 131 - Cleanup xsl to make it more readable.  Almost everything
 132   that is currently in latex.xsl should probably be moved to common.xsl.
 133   There may be a license problem with the atbeginend.sty file, since
 134   latex style files rarely have explict licenses.  At worst, we can
 135   drop this and manually adjust the relevant spacing.
 136
 137 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 138
 139 - Translations.