1 Apache HTTP Server Trunk Documentation Status File. Last modified: $Date$
3 For more information on how to contribute to the Apache Documentation
4 Project, please see http://httpd.apache.org/docs-project/ and
5 http://httpd.apache.org/docs-project/docsformat.html
7 ------------------------------
10 =======================
12 - Update the http://httpd.apache.org/docs-project/docsformat.html
13 document to be useful. In particular:
14 - Document the various macros that can be used in documents.
15 - Document the translation process.
16 - Generally update it to make it reflect the current reality of how
18 - Improving the documentation of the documentations' build system
19 itself (requirements, procedures)
21 - Continue to enhance the FAQ, which is in the wiki:
22 http://wiki.apache.org/httpd/FAQ
24 - Security docs are unhelpful, and assume that the reader knows nothing.
25 Need something a little more advanced, which either discusses
26 application-level security, or links to something that does. I'm not
27 even sure what to say needs done. Can we get someone to elaborate on
28 what, exactly, needs written? Ivan Ristic has said maybe he would be
29 willing to contribute.
30 - More content and better organisation
31 - mod_dav resources are owned by the httpd. Perhaps write up the
32 two-httpd dav setup covered in Rich Bowen's DAV Apachecon
35 - Performance doc "drop-in replace" wikified by Igor from Sander's
36 presentation: http://wiki.apache.org/httpd/PerformanceScalingUp
37 as well as: http://wiki.apache.org/httpd/PerformanceScalingOut
38 They both need review and updates to reflect the current state
41 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
42 - Bill Rowe is a good contact for tech questions.
43 - "using apache" has been done, "compiling apache" is still open
44 - hints on uninstalling apache (exit monitor, close directories,
45 registry entries etc) (PR 10154)
46 - FAQ: UTF-8 config and URL encoding for non-ascii characters.
49 - Much clean-up and enhancement of aaa howto (Can someone clarify
50 exactly what needs cleaned up and enhanced?)
51 - Independent note on how to upgrade to new auth system
52 - Discussion of DBD auth, and, in particular, examples of how to set
53 up auth using each of the supported databases.
55 - Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...
56 Start is in expr.xml, igalic is working on this
59 - the follwing modules added since 2.2 lack documentation
64 - mod_lbmethod_heartbeat
66 the list may be incomplete
67 maybe some of the modules will not be included in 2.4
68 - mod_suexec: very little documentation
70 - mod_substitute and reverse proxies: Add example using mod_filter
71 (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)
74 - explain what the following command line options do
75 (perhaps in the developer/debugging docs):
77 -D ONE_PROCESS -- is this the same as -X, if not, should it be?
78 one-process-mode == no threads, i.e. only one
79 process handling the requests in a single loop?
81 - Identify which documents are grossly out of date, and fix.
82 - platform/ebcdic.xml - needs major rework for 2.0
83 - SSL docs need serious update and enhancement
84 - compat docs are wrong
85 - A basic how to has been started here:
86 http://wiki.apache.org/httpd/SettingUpModSSL
87 but it needs some work...
88 - http://blag.esotericsystems.at/2011/01/answering-trivial-and-interesting-questions-with-openssl/
89 looks like a good starting point for overhauling the FAQ, and
90 has been placed at our disposal by the author.
93 - Ben Laurie has written some hooks documentation
94 - authn provider API documentation could be useful
96 - How does <Proxy> fit into sections.html?
98 - Missing documentation for the support program checkgid
100 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
101 (draft available in wiki)
103 - Enhancements to the DTD/XSL:
104 - New index: directives by context, including listing which directives
105 are available for each AllowOverride setting.
106 - New index: backout modules by type (aaa, mappers, loggers etc.)
107 probably by introducing a <category> element in modulesynopsis
108 - Use a tag like <var> in place of <em> for things like the
111 - add letter links to glossary and quickreference,
112 perhaps also a term overview (sidebar)
114 - Provide example solutions for the mapping of encodings, especially
115 for .gz etc. (also in regard to our default configuration)
117 - How-To style documents for more of the daily tasks
118 - Logging, log rotation, and log reporting
119 - Secure mod_dav configuration
121 - Writing modules - Can we provide a basic intro to writing modules,
122 perhaps based around mod_example, or one of the other simple example
125 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
126 profound embarrassment.
127 - Purge all the dead links
128 - Introductory module authoring doc
129 - Verify links to external resources at least every year
131 - Update the list of translations at
132 http://httpd.apache.org/docs-project/translations.html Some of those
133 are accurate, and others are way outdated.
135 - I'd like to expand the discussion of conditional logging, and add a
136 few more useful exmaples.
137 That would be a good place to document logging of cache hit/miss:
138 https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
140 - Is it worth having a doc that discusses recommended (what does this
141 mean?) third-party modules like mod_security, mod_php, and so on - the
142 things that we all assume everyone uses, but some folks might not know
145 - Clarify which directives only affect requests when they're handled
146 by the default handler. (e.g. ForceType, TraceEnable, etc.)
148 - Add examples using expr to mod_rewrite recipes. Possibly benchmark the
149 different approaches and make intelligent remarks about the
150 comparative value of each.
152 - Fix this error message:
153 Request exceeded the limit of 10 internal redirects due to probable
154 configuration error. Use 'LimitInternalRecursion' to increase the limit
155 if necessary. Use 'LogLevel debug' to get a backtrace.
156 This error message is often returned when a RewriteRUle loops, in
157 which case setting LimitInternalRecursion won't do anything towards
158 fixing the problem. However, the error message is already very long.
164 - Dozens of other little problems with presentation, cross-referencing,
167 - Cleanup xsl to make it more readable. Almost everything
168 that is currently in latex.xsl should probably be moved to common.xsl.
169 There may be a license problem with the atbeginend.sty file, since
170 latex style files rarely have explict licenses. At worst, we can
171 drop this and manually adjust the relevant spacing.
173 - Reduce the size of the pdf (both bytes and pages) in any way possible.