WebSite

HttpComponents Web Site

This area of our Wiki collects information on updating and deploying our web site at hc.apache.org.

Structure

The web site is divided into several sections, which are deployed independently:

• "main site" - everything that is not in another section

• "component sites" - each component has a separate section in a directory of the site, currently:

  • httpcomponents-core

  • httpcomponents-client

• "legacy site" - the section for Commons HttpClient 3.x

  • httpclient-3.x

Updating the Web Site

See below for instructions on setting up the tools. Instructions for updating the sections of the web site are here:

• main site

• component sites

• legacy site

Tools

Site generation for the main site and the component sites are based on Maven 2. For historical reasons, the legacy site is generated with Maven 1. The sources for all sites are stored in our Subversion repository.

Subversion

There is general information about Subversion here at Apache. If you don't check in new files, that should be sufficient.

If you do commit new files to Subversion, make sure that the default properties are set appropriately. These are defined in a file called ~/.subversion/config on Linux and Unix systems. There are suitable instructions in the Commons Wiki.
Additionally, you should have the following line for .apt (Almost Plain Text) files:

*.apt = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Author Id Revision HeadURL

Maven 2

where should we link for general setup/installation of Maven2?

For developing and contributing patches, a general Maven 2 installation is sufficient.
If you are a committer and have to deploy sections of the web site with Maven 2, you need the following section in your ~/.m2/settings.xml file:

<servers>
    <server>
      <id>apache.website</id>
      <username>xxxxxx</username>
      <privateKey>${usr.home}/.ssh/id_dsa</privateKey>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
      <configuration></configuration>
    </server>
</servers>

Replace xxxxxx with your login name on people.apache.org. If you haven't set up ssh for DSA authentication, or use a different file for storing your ID, you will have to adapt the section accordingly. Explanations are available here on the Maven site. Note that it is not necessary to set your passphrase or password in settings.xml, you will be queried for it.

Maven 1

where should we link for general setup/installation of Maven1?

It is important that you install an up-to-date version of the maven-xdoc-plugin. Instructions are in the release documentation for Commons HttpClient 3.x.