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 - Determine what The Right Way to use the terms "Apache", "Apache HTTP
14 Server" and "httpd" are. Whether they require specific markup or
15 links. (Rich) I've been using Apache HTTP Server in the first mention,
16 and httpd thereafter, but there are some contexts in which this is
23 - Changing mentions of 'Apache' to 'Apache HTTP Server' or 'httpd'
24 as appropriate in the context.
26 - Rewriting the custom-error document, which is grossly outdated.
28 - Adding to the discussion of conditional logging, which I think
29 could be turned into more of a howto than the one paragraph it's
33 =======================
35 - Refer to this product as either 'Apache HTTP Server' or 'httpd', as
36 appropriate in context, rather than just 'Apache'. 'Apache' is the
37 Apache Software Foundation.
39 - Remove mentions of the 1.2 and 1.3 versions of the server.
41 - Update the http://httpd.apache.org/docs-project/docsformat.html
42 document to be useful. In particular:
43 - Document the various macros that can be used in documents.
44 - Document the translation process.
45 - Generally update it to make it reflect the current reality of how
47 - Improving the documentation of the documentations' build system
48 itself (requirements, procedures)
50 - Update this document. Determine which of these issues are in fact
51 still open, and which have already been dealt with.
53 - Identify which documents are grossly out of date, and fix.
55 - The FAQ never amounted to much. Review the current FAQ, which is
56 1.3-era, and bring it into this century.
58 - Security docs are unhelpful, and assume that the reader knows nothing.
59 Need something a little more advanced, which either discusses
60 application-level security, or links to something that does. I'm not
61 even sure what to say needs done. Can we get someone to elaborate on
62 what, exactly, needs written? Ivan Ristic has said maybe he would be
63 willing to contribute.
64 - More content and better organisation
65 - mod_dav resources are owned by the httpd. Perhaps write up the
66 two-httpd dav setup covered in Rich Bowen's DAV Apachecon
69 - Performance doc is way too low-level. Several people have said that
70 they might help out here, but it's a significant undertaking, and more
71 than a little daunting.
73 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
74 - Bill Rowe and Bill Stoddard are good contacts for tech questions.
75 - "using apache" has been done, "compiling apache" is still open
76 - hints on uninstalling apache (exit monitor, close directories,
77 registry entries etc) (PR 10154)
78 - FAQ: UTF-8 config and URL encoding for non-ascii characters.
81 - Much clean-up and enhancement of aaa howto
82 - Independent note on how to upgrade to new auth system
83 - Discussion of DBD auth, and, in particular, examples of how to set
84 up auth using each of the supported databases.
87 - mod_suexec: very little documentation
88 - mod_rewrite: explain, when which variables are actually available
92 - explain what the following command line options do
93 (perhaps in the developer/debugging docs):
96 one-process-mode == no threads, i.e. only one
97 process handling the requests in a single loop?
99 - Individual docs will need some cleanup.
100 - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
101 - platform/ebcdic.xml - needs major rework for 2.0
104 - Ben Laurie has written some hooks documentation
105 - authn provider API documentation could be useful
107 - SSL docs need serious update and enhancement
108 - compat docs are wrong
109 - no basic how to setup ssl doc
110 mads said he was working on this, but...
112 - How does <Proxy> fit into sections.html?
114 - Missing documentation for the support program checkgid
116 - New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
117 (draft available in wiki)
119 - Enhancements to the DTD/XSL:
120 - New index: directives by context, including listing which directives
121 are available for each AllowOverride setting.
122 - New index: backout modules by type (aaa, mappers, loggers etc.)
123 probably by introducing a <category> element in modulesynopsis
124 - Use a tag like <var> in place of <em> for things like the
127 - add letter links to glossary and quickreference,
128 perhaps also a term overview (sidebar)
129 - remove <pre> elements. Use <br /> and <indent> elements to get
132 - Provide example solutions for the mapping of encodings, especially
133 for .gz etc. (also in regard to our default configuration)
135 - How-To style documents for more of the daily tasks
136 - Logging and log reporting
139 - Writing modules - Can we provide a basic intro to writing modules,
140 perhaps based around mod_example, or one of the other simple example
143 - http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
144 profound embarrassment.
145 - Purge all the dead links
146 - API docs are generated via 'make dox'. Find somewhere that we can
147 do this on a schedule, and link to that from the documentation.
148 - Introductory module authoring doc
149 - Verify links to external resources at least every year
151 - Update the list of translations at
152 http://httpd.apache.org/docs-project/translations.html Some of those
153 are accurate, and others are way outdated.
155 - Rewriting the 'custom error' doc, which is ancient and doesn't flow
158 - I'd like to expand the discussion of conditional logging, and add a
159 few more useful exmaples.
161 - The mod_usertrack docs should describe what the module does, now,
162 rather than spending so much time comparing it to what a long-gone
163 module, which our readers never used, used to do. Examples would be
164 helpful. Additionally, a significant part of the doc consists of a
165 quoted email message. This seems somewhat unprofessional.
170 - Dozens of other little problems with presentation, cross-referencing,
173 - Cleanup xsl to make it more readable. Almost everything
174 that is currently in latex.xsl should probably be moved to common.xsl.
175 There may be a license problem with the atbeginend.sty file, since
176 latex style files rarely have explict licenses. At worst, we can
177 drop this and manually adjust the relevant spacing.
179 - Reduce the size of the pdf (both bytes and pages) in any way possible.