Please contribute to this top-level documentation.
As with all ASF projects, if you have changes to this top-level
ASF documentation (/foundation/ and /dev/) then please send patches.
Do that via the
Infrastructure
issues tracker. (Do not reveal obviously sensitive information,
such as the name of any private mailing lists.)
The sources are managed in the SVN repository
http://svn.apache.org/repos/asf/infrastructure/site/trunk/
Everyone has read access. All ASF members, the ASF infrastructure
team, and other ASF committers who help us out with documentation have
write access.
To update the documentation ...
cd infrastructure/site/xdocs/dev
edit index.xml
cd infrastructure/site
./build.sh
... docs are generated into infrastructure/site/docs
To commit your changes ...
cd infrastructure/site
svn status
svn add (don't forget the generated docs/*.html too)
svn diff
svn commit
To deploy your changes on the website ...
ssh people.apache.org
cd /www/www.apache.org
svn update
These changes should then be mirrored worldwide within an hour or so.
The documentation at /dev/ is undergoing review
and consolidation. This is probably an ongoing process.
There are three main purposes for this documentation:
-
Explanations for committers and contributors, especially
for new committers, so that PMCs and Infra can easily
refer to online documents to answer the recurring FAQs.
-
Procedures for PMCs. We need to encourage PMCs to do as
much as possible to help themselves.
-
Procedures for people trying to assist with Infrastructure
operations.
For the committer documentation we should have very specific
documents which directly meet their needs. For the other
two groups, we could have the top section of each document
describing PMC tasks, while the bottom section is for Infra.
The /dev/index.html has been divided into sections and
links placed for each separate topic. More topics to come.
Many of these links point to non-existent documents.
Gradually we are adding new documents which just link
to the scattered information. The next step is to move
the content into the relevant docs and enhance it. We need
to be careful about broken links, because much procedural
information refers to those scattered pieces.
Contents