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

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