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

   1 Apache HTTP Server Trunk 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/ and
   6 http://httpd.apache.org/docs-project/docsformat.html
   7
   8               ------------------------------
   9
  10 Decisions pending
  11 =================
  12
  13 Things That Need Fixing
  14 =======================
  15
  16 - Refer to this product as either 'Apache HTTP Server' or 'httpd', as
  17   appropriate in context, rather than just 'Apache'. 'Apache' is the
  18   Apache Software Foundation.
  19
  20 - Remove mentions of the 1.2 and 1.3 versions of the server.
  21
  22 - Update the http://httpd.apache.org/docs-project/docsformat.html
  23   document to be useful. In particular:
  24     - Document the various macros that can be used in documents.
  25     - Document the translation process.
  26     - Generally update it to make it reflect the current reality of how
  27       we work.
  28
  29 - Update this document. Determine which of these issues are in fact
  30   still open, and which have already been dealt with.
  31
  32 - Identify which documents are grossly out of date, and fix.
  33
  34 - The FAQ never amounted to much. Review the current FAQ, which is
  35   1.3-era, and bring it into this century.
  36
  37 - Security docs are unhelpful, and assume that the reader knows nothing.
  38   Need something a little more advanced, which either discusses
  39   application-level security, or links to something that does. I'm not
  40   even sure what to say needs done. Can we get someone to elaborate on
  41   what, exactly, needs written? Ivan Ristic has said maybe he would be
  42   willing to contribute.
  43
  44 - Performance doc is way too low-level. Several people have said that
  45   they might help out here, but it's a significant undertaking, and more
  46   than a little daunting.
  47
  48 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
  49     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  50     - "using apache" has been done, "compiling apache" is still open
  51     - hints on uninstalling apache (exit monitor, close directories,
  52       registry entries etc) (PR 10154)
  53     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  54
  55 - New Auth system
  56     - Much clean-up and enhancement of aaa howto
  57     - Independent note on how to upgrade to new auth system
  58
  59 - modules docs
  60     - mod_suexec: very little documentation
  61     - mod_rewrite: explain, when which variables are actually available
  62       (PR 16402)
  63
  64 - MPM documentation
  65      - explain what the following command line options do
  66        (perhaps in the developer/debugging docs):
  67         -D DEBUG
  68         -D ONE_PROCESS
  69               one-process-mode == no threads, i.e. only one
  70               process handling the requests in a single loop?
  71
  72 - Individual docs will need some cleanup.
  73      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
  74      - platform/ebcdic.xml - needs major rework for 2.0
  75
  76 - API documentation
  77     - Ben Laurie has written some hooks documentation
  78     - authn provider API documentation could be useful
  79
  80 - SSL docs need serious update and enhancement
  81     - compat docs are wrong
  82     - no basic how to setup ssl doc
  83     mads said he was working on this, but...
  84
  85 - How does <Proxy> fit into sections.html?
  86
  87 * Missing documentation for the support program checkgid
  88
  89 * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
  90   (draft available in wiki)
  91
  92 * Enhancements to the DTD/XSL:
  93   - New index: directives by context, including listing which directives
  94     are available for each AllowOverride setting.
  95   - New index: backout modules by type (aaa, mappers, loggers etc.)
  96     probably by introducing a <category> element in modulesynopsis
  97   - Use a tag like <var> in place of <em> for things like the
  98     <syntax> listing.
  99     - in progress
 100   - add letter links to glossary and quickreference,
 101     perhaps also a term overview (sidebar)
 102   - remove <pre> elements. Use <br /> and <indent> elements to get
 103     a similar effect.
 104
 105 * Improving the documentation of the documentations' build system
 106   itself (requirements, procedures)
 107
 108 * Improving the "security docs"
 109   - More content and better organisation
 110   - mod_dav ressources are owned by the httpd
 111
 112 * Provide example solutions for the mapping of encodings, especially
 113   for .gz etc. (also in regard to our default configuration)
 114
 115 * Change the name 'Apache' to 'Apache HTTP Server' or 'http'.
 116
 117 LaTeX Todo list
 118 ==================
 119
 120 - Dozens of other little problems with presentation, cross-referencing,
 121   etc.
 122
 123 - Cleanup xsl to make it more readable.  Almost everything
 124   that is currently in latex.xsl should probably be moved to common.xsl.
 125   There may be a license problem with the atbeginend.sty file, since
 126   latex style files rarely have explict licenses.  At worst, we can
 127   drop this and manually adjust the relevant spacing.
 128
 129 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 130
 131 - Translations.
 132