mirror of
https://github.com/apache/httpd.git
synced 2025-11-06 16:49:32 +03:00
c8d1bc9f76
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96702 13f79535-47bb-0310-9956-ffa450edef68
203 lines
7.1 KiB
Plaintext
203 lines
7.1 KiB
Plaintext
Apache HTTP Server 2.0 Documentation Status File.
|
|
Last modified: $Date: 2002/09/06 23:29:01 $
|
|
|
|
If you are interested in helping accomplish some of the tasks on this
|
|
list or otherwise improving the documentation, please join the
|
|
apache-docs mailing list by mailing to apache-docs-subscribe@apache.org
|
|
|
|
For more information on how to contribute to the Apache Documentation
|
|
Project, please see http://httpd.apache.org/docs-project/, and
|
|
http://apache-server.com/tutorials/ATdocs-project.html for an excellent
|
|
tutorial on how to get started with making your contribution.
|
|
|
|
------------------------------
|
|
|
|
- XML
|
|
- The xsl transformations could be greatly improved to a) look better
|
|
and b) use proper CSS+html rather than the horrible hack that
|
|
Joshua did (in progress).
|
|
- Rewriting of the remainder of the manual into xml is in
|
|
progress. See the bottom of this file for status info.
|
|
|
|
- modules docs
|
|
- mod_suexec: very little documentation
|
|
- mod_proxy: updates for 2.0
|
|
- mod_status: updates for 2.0
|
|
- mod_example: updates for 2.0
|
|
|
|
- man pages
|
|
- Some of the man pages need to be updated for 2.0. At least
|
|
the httpd man page appears to be outdated, and perhaps other.
|
|
After this is done, the manual/programs/ versions can be
|
|
regenerated using the program in the site-tools repository.
|
|
|
|
- MPM documentation
|
|
- Each MPM needs to have a documentation file in manual/mod/
|
|
which lists the directives it provides, and some details
|
|
about its operation.
|
|
Status: Initial outlines done. Much more details need to be
|
|
filled in.
|
|
- Non unix/windows MPMs still need to be completed.
|
|
- the perchild directives in threaded/worker need docs
|
|
|
|
- Individual docs will need some cleanup.
|
|
Status: What docs still need to be touched here?
|
|
- misc/custom_errordocs.html needs to be updated to
|
|
essentially describe how the international error
|
|
docs included in 2.0 work
|
|
- misc/perf-tuning.html - needs major rewrite for 2.0
|
|
- misc/tutorials.html - mostly not relevant to 2.0
|
|
- misc/stopping.html
|
|
- misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
|
|
- misc/known_client_problems.html - mostly ancient
|
|
|
|
- New build process.
|
|
- install.html has had a first-pass rewrite, but many things have
|
|
changed in the build system since it was written.
|
|
|
|
- Documentation of new features.
|
|
- This will probably require more input from new-httpd, since
|
|
not many people here follow the development process close
|
|
enough to know what is going on.
|
|
|
|
- API documentation
|
|
Status: Ben Laurie has written some hooks documentation
|
|
|
|
- Translations
|
|
There are several efforts underway to translate the documentation
|
|
into other languages. A detailed list of the currently known
|
|
translators (and the corresponding websites) can be found at
|
|
|
|
http://httpd.apache.org/docs-project/translations.html
|
|
|
|
New User documentation
|
|
======================
|
|
|
|
* Directory Handling (mod_dir/mod_autoindex/etc)
|
|
|
|
Documentation improvements
|
|
==========================
|
|
|
|
* Improving the "security docs"
|
|
|
|
- More content and better organisation.
|
|
|
|
* General cleaning and improving of module docs
|
|
|
|
* Making the directive definitions "less terse" (i.e., adding more
|
|
examples and details to the definitions of the directives)
|
|
|
|
- We'll need to audit these and find out which ones need munging, as
|
|
some of it looks ok. --jsl
|
|
|
|
* Making site-specific enhancements easier, including a documented
|
|
and robust way for 3P module docco to be added -- and have it
|
|
survive a server docco upgrade
|
|
|
|
- This could be something a simple and hackish as a manual/extra/
|
|
directory (a la the 1.3 src/modules/extra/ directory) and a
|
|
script in the support directory that scans the files there and
|
|
updates the manual indices. (We do something like that now for
|
|
httpd.conf file with apxs [LoadModule, etc.].)
|
|
|
|
* regex: We should at least document someplace what regex library we
|
|
are using and how to find more information about it
|
|
|
|
XML Conversions
|
|
===============
|
|
|
|
The following files need to be converted to XML as described at
|
|
http://httpd.apache.org/docs-project/docsformat.html
|
|
|
|
ebcdic.html # Perhaps move to platform/
|
|
footer.html # delete after finishing manual/
|
|
header.html # delete after finishing manual/
|
|
custom-error.html.en
|
|
index.html.en # leave in html?
|
|
cgi_path.html.en
|
|
howto/cgi.html.en
|
|
howto/ssi.html.en
|
|
howto/auth.html.en
|
|
howto/footer.html # delete after finishing howto/
|
|
howto/header.html # delete after finishing howto/
|
|
misc/custom_errordocs.html # obsolete?
|
|
misc/descriptors.html # obsolete?
|
|
misc/fin_wait_2.html # obsolete?
|
|
misc/footer.html # delete after finishing misc/
|
|
misc/header.html # delete after finishing misc/
|
|
misc/index.html
|
|
misc/known_client_problems.html # obsolete?
|
|
misc/perf-tuning.html
|
|
misc/rewriteguide.html
|
|
misc/tutorials.html # obsolete?
|
|
mod/footer.html # delete after finishing mod/ directory
|
|
mod/header.html # delete after finishing mod/ directory
|
|
platform/footer.html # delete after finishing platform/
|
|
platform/header.html # delete after finishing platform/
|
|
platform/netware.html
|
|
platform/perf-hp.html
|
|
platform/win_compiling.html
|
|
platform/win_service.html
|
|
platform/windows.html
|
|
ssl/footer.html # delete after finishing ssl/
|
|
ssl/header.html # delete after finishing ssl/
|
|
ssl/index.html.en
|
|
ssl/ssl_compat.html
|
|
ssl/ssl_faq.html
|
|
ssl/ssl_glossary.html # delete. replaced by ../glossary.html
|
|
ssl/ssl_howto.html
|
|
ssl/ssl_intro.html
|
|
vhosts/details.html
|
|
vhosts/examples.html
|
|
vhosts/footer.html # delete after finishing vhosts/
|
|
vhosts/header.html # delete after finishing vhosts/
|
|
vhosts/ip-based.html
|
|
vhosts/mass.html
|
|
vhosts/index.html.en
|
|
vhosts/fd-limits.html.en
|
|
vhosts/name-based.html.en
|
|
expand.pl # delete after finishing everything
|
|
|
|
# These will require manual.xsl changes
|
|
faq/footer.html
|
|
faq/header.html
|
|
faq/index.html
|
|
faq/support.html
|
|
|
|
# Perhaps these should be left in html to allow the developers to
|
|
# play with them
|
|
developer/API.html
|
|
developer/debugging.html
|
|
developer/documenting.html
|
|
developer/filters.html
|
|
developer/footer.html
|
|
developer/header.html
|
|
developer/hooks.html
|
|
developer/index.html
|
|
developer/layeredio.html
|
|
developer/request.html
|
|
developer/thread_safety.html
|
|
developer/modules.html.en
|
|
|
|
# These are currently generated from nroff, but nobody is editting
|
|
# the nroff sources. Should we just convert to pure xml and forget
|
|
# about man pages?
|
|
programs/ab.html
|
|
programs/apachectl.html
|
|
programs/apxs.html
|
|
programs/dbmmanage.html
|
|
programs/footer.html
|
|
programs/header.html
|
|
programs/htdigest.html
|
|
programs/htpasswd.html
|
|
programs/httpd.html
|
|
programs/index.html
|
|
programs/logresolve.html
|
|
programs/other.html
|
|
programs/rotatelogs.html
|
|
programs/suexec.html
|
|
|
|
|
|
|
|
|