1 Apache HTTP Server Trunk Documentation Status File.
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
8 ------------------------------
13 Things That Need Fixing
14 =======================
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.
20 - Remove mentions of the 1.2 and 1.3 versions of the server.
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
28 - Improving the documentation of the documentations' build system
29 itself (requirements, procedures)
31 - Update this document. Determine which of these issues are in fact
32 still open, and which have already been dealt with.
34 - Identify which documents are grossly out of date, and fix.
36 - The FAQ never amounted to much. Review the current FAQ, which is
37 1.3-era, and bring it into this century.
39 - Security docs are unhelpful, and assume that the reader knows nothing.
40 Need something a little more advanced, which either discusses
41 application-level security, or links to something that does. I'm not
42 even sure what to say needs done. Can we get someone to elaborate on
43 what, exactly, needs written? Ivan Ristic has said maybe he would be
44 willing to contribute.
45 - More content and better organisation
46 - mod_dav resources are owned by the httpd. Perhaps write up the
47 two-httpd dav setup covered in Rich Bowen's DAV Apachecon
50 - Performance doc is way too low-level. Several people have said that
51 they might help out here, but it's a significant undertaking, and more
52 than a little daunting.
54 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
55 - Bill Rowe and Bill Stoddard are good contacts for tech questions.
56 - "using apache" has been done, "compiling apache" is still open
57 - hints on uninstalling apache (exit monitor, close directories,
58 registry entries etc) (PR 10154)
59 - FAQ: UTF-8 config and URL encoding for non-ascii characters.
62 - Much clean-up and enhancement of aaa howto
63 - Independent note on how to upgrade to new auth system
64 - Discussion of DBD auth, and, in particular, examples of how to set
65 up auth using each of the supported databases.
68 - mod_suexec: very little documentation
69 - mod_rewrite: explain, when which variables are actually available
73 - explain what the following command line options do
74 (perhaps in the developer/debugging docs):
77 one-process-mode == no threads, i.e. only one
78 process handling the requests in a single loop?
80 - Individual docs will need some cleanup.
81 - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
82 - platform/ebcdic.xml - needs major rework for 2.0
85 - Ben Laurie has written some hooks documentation
86 - authn provider API documentation could be useful
88 - SSL docs need serious update and enhancement
89 - compat docs are wrong
90 - no basic how to setup ssl doc
91 mads said he was working on this, but...
93 - How does <Proxy> fit into sections.html?
95 - Missing documentation for the support program checkgid
97 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
98 (draft available in wiki)
100 - Enhancements to the DTD/XSL:
101 - New index: directives by context, including listing which directives
102 are available for each AllowOverride setting.
103 - New index: backout modules by type (aaa, mappers, loggers etc.)
104 probably by introducing a <category> element in modulesynopsis
105 - Use a tag like <var> in place of <em> for things like the
108 - add letter links to glossary and quickreference,
109 perhaps also a term overview (sidebar)
110 - remove <pre> elements. Use <br /> and <indent> elements to get
113 - Provide example solutions for the mapping of encodings, especially
114 for .gz etc. (also in regard to our default configuration)
116 - How-To style documents for more of the daily tasks
117 - Logging and log reporting
120 - Writing modules - Can we provide a basic intro to writing modules,
121 perhaps based around mod_example, or one of the other simple example
127 - Dozens of other little problems with presentation, cross-referencing,
130 - Cleanup xsl to make it more readable. Almost everything
131 that is currently in latex.xsl should probably be moved to common.xsl.
132 There may be a license problem with the atbeginend.sty file, since
133 latex style files rarely have explict licenses. At worst, we can
134 drop this and manually adjust the relevant spacing.
136 - Reduce the size of the pdf (both bytes and pages) in any way possible.