[Jakarta-httpclient Wiki] Update of "WebSite" by RolandWeber

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jakarta-httpclient Wiki" for change notification.

The following page has been changed by RolandWeber:
http://wiki.apache.org/jakarta-httpclient/WebSite

The comment on the change is:
tools for site deployment

New page:
= HttpComponents Web Site =

This area of our Wiki collects information on updating and deploying
our web site at [http://hc.apache.org/ 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:
   * [http://hc.apache.org/httpcomponents-core/ httpcomponents-core]
   * [http://hc.apache.org/httpcomponents-client/ httpcomponents-client]
 * "legacy site" - the section for Commons !HttpClient 3.x
   * [http://hc.apache.org/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:

 * [wiki:Self:WebSite/MainSite main site]
 * [wiki:Self:WebSite/ComponentSite component sites]
 * [wiki:Self:WebSite/LegacySite 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
[http://www.apache.org/dev/version-control.html 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
[http://wiki.apache.org/jakarta-commons/UsingSVN#head-6c72845e21a04245b67eb4793d6dc0b364846fe1 Commons Wiki].
[[BR]]
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.
[[BR]]
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 [http://people.apache.org/ 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 [http://maven.apache.org/settings.html#Servers 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
[wiki:Self:HttpClientReleaseProcess#head-d34cf583c1ad9c54c63bd90b8555b3141ba0fff6 release documentation]
for Commons !HttpClient 3.x.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org