You can help improve this apache.org website - send in your patches to help us better explain how the ASF works!

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.) Note: PMC chairs have write access to SVN and are responsible for ensuring that the portions of the website which relate to their PMC are kept up to date.

Contents

Introduction
- To update the documentation using the CMS system
- To update the documentation using only command-line tools
How The Homepage Works
What Information Is Where
Improvements to /dev documentation

Introduction¶

The source code for this website managed in the SVN repository https://svn.apache.org/repos/asf/infrastructure/site/trunk
Everyone has read access. All ASF committers have write access, although you should only commit changes to areas you have responsibility for. Only ASF members or the Infrastructure team can actually publish to the live website, however.

This website uses markdown files managed by the Apache CMS tool.

To update the documentation using the CMS system¶

Install the bookmarklet from the cms page. You only have to do this once.
Navigate to the page you wish to edit (on the live site, not in the cms).
Click the bookmarklet. There will be a short pause while the CMS system is initialised for you and prepares an editable version of the website.
Click on Edit
The page editor should then be displayed. Almost all files in the CMS are Markdown format.
Click Submit to save your edit to your local workarea
Click Commit to save the updated file to SVN and trigger a staged build. (to skip this step click on the "Quick Commit" checkbox in the Edit form).
The results should appear shortly on the staging site. (You may have to force the page to refresh in order to see the updated content)
Once you are happy with the updated page, click on Publish Site to deploy, and provide a brief checkin comment and commit to push to the production server. (Reminder: only ASF Members can publish site)

To update the documentation using only command-line tools¶

$ cd infrastructure/content/dev/
$ $EDITOR infra-site.mdtext
$ svn commit
... wait a short while for the page to be rebuilt ...
... **ONLY IF** you are an ASF Member, then publish: ...
$ curl -sL http://s.apache.org/cms-cli | perl

Note: the project name for the ASF website (www.apache.org) is www.

These changes should then be mirrored worldwide within a few seconds.

How The Homepage Works¶

The apache.org homepage itself is built from a number of different information sources and tools. The index.html itself is both static content as well as a shell that pulls in various other content bits from /index_page/. These are all static content that are used for different awareness campaigns.

The Featured Projects section is built dynamically, and rotates to show a different set of three Apache projects each time the file is checked in (it is not currently rotating live). To correct data in this section, ensure that every Apache project has:

A logo in apache.org/img/projectname.jpg that is 212 pixels wide
A proper description in the project's DOAP file from projects.a.o

VP, Marketing and Publicity is the formal owner of the homepage, and can be reached at press@.

What Information Is Where¶

The main apache.org website provides information about the ASF overall, as well as some technical information about the systems and tools that Apache projects use to build their indepenent software products.

Some useful starting points are:

/dev/ is a top level site map of infrastructure and tooling documentation.
/foundation/ is the top level about the ASF as a corporation
/foundation/governance/ explains how the corporation is governed (which is separate from how Apache projects work)]
/legal/ includes information about ASF legal policies
/licenses/ includes copies of the Apache license and FAQs
/press/ is for press or analyst information
/security/ is the home of the Security Team that coordinates CVEs with projects

Improvements to /dev documentation¶

The documentation at /dev/ is undergoing review and consolidation. In particular, the Infrastructure team is consolidating the underlying technical documentation about ASF systems on their website, and in the future the /dev/ path will likely be helpful end-user FAQs and pointers to the specific documentation elsewhere.

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.