Site improvements:
authorIvan Habunek <ihabunek@apache.org>
Thu, 2 Jun 2011 22:00:08 +0000 (22:00 +0000)
committerIvan Habunek <ihabunek@apache.org>
Thu, 2 Jun 2011 22:00:08 +0000 (22:00 +0000)
* removed the "Install" page - the information contained there has been split between "Download" and "Quickstart" pages
* removed the Roadmap page since it does not contain any useful information
* renamed "PHPDoc" page to "API docs"
* minor improvements to "Upgrading" and "Quickstart" pages.

git-svn-id: https://svn.apache.org/repos/asf/logging/log4php/trunk@1130840 13f79535-47bb-0310-9956-ffa450edef68

src/site/apt/download.apt
src/site/apt/install.apt [deleted file]
src/site/apt/quickstart.apt
src/site/apt/upgrading.apt
src/site/site.xml

index 6ce9f7b..bb06685 100644 (file)
@@ -18,31 +18,66 @@ Download
  ------
  ------
 
-Download log4php
+Download
 
-  Apache log4php is distributed under the {{{http://www.apache.org/licenses/LICENSE-2.0.html} Apache License, version 2.0}}.
+       Apache log4php is distributed under the {{{http://www.apache.org/licenses/LICENSE-2.0.html} Apache License, version 2.0}}.
 
-* Version 2.0.0
+       Version 2.0.0 is the latest stable version, available since 12.12.2009.
 
-  Version 2.0.0 is available since 12.12.2009.
+* Source package 
   
-  The following artifacts contain the complete sourcecode and API docs. It is recommended for most users:
+       The source package contains the complete source code and API docs. This is recommended for most users.
   
-  * {{{http://www.apache.org/dyn/closer.cgi/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.tar.gz}apache-log4php-2.0.0-incubating-src.tar.gz}} {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.tar.gz.md5}MD5}} {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.tar.gz.asc}ASC}}
+*----------+-----------+------------+
+|| Mirrors || Checksum || Signature |
+*----------+-----------+------------+
+| {{{http://www.apache.org/dyn/closer.cgi/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.tar.gz}apache-log4php-2.0.0-incubating-src.tar.gz}} | {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.tar.gz.md5}MD5}} | {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.tar.gz.asc}ASC}} |
+*----------+-----------+------------+
+| {{{http://www.apache.org/dyn/closer.cgi/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.zip}apache-log4php-2.0.0-incubating-src.zip}} | {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.zip.md5}MD5}} | {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.zip.asc}ASC}} |
+*----------+-----------+------------+
   
-  * {{{http://www.apache.org/dyn/closer.cgi/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.zip}apache-log4php-2.0.0-incubating-src.zip}} {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.zip.md5}MD5}} {{{http://www.apache.org/dist/logging/log4php/2.0.0/apache-log4php-2.0.0-incubating-src.zip.asc}ASC}}
+* Pear package
 
+       The pear package is prepared for a {{{http://pear.php.net}pear}} channel and is recommended for users who want to make log4php available in their own channels.
 
-  The following artifact is prepared for a pear channel and is recommended to users who want to make log4php available in their own channels:
+*----------+-----------+------------+
+|| Mirrors || Checksum || Signature |
+*----------+-----------+------------+
+| {{{http://www.apache.org/dyn/closer.cgi/logging/log4php/2.0.0/Apache_log4php-2.0.0-incubating-pear.tgz}Apache_log4php-2.0.0-incubating-pear.tgz}} | {{{http://www.apache.org/dist/logging/log4php/2.0.0/Apache_log4php-2.0.0-incubating-pear.tgz.md5}MD5}} | {{{http://www.apache.org/dist/logging/log4php/2.0.0/Apache_log4php-2.0.0-incubating-pear.tgz.asc}ASC}} |
+*----------+-----------+------------+
+  
+* From repository  
   
-  * {{{http://www.apache.org/dyn/closer.cgi/logging/log4php/2.0.0/Apache_log4php-2.0.0-incubating-pear.tgz}Apache_log4php-2.0.0-incubating-pear.tgz}} {{{http://www.apache.org/dist/logging/log4php/2.0.0/Apache_log4php-2.0.0-incubating-pear.tgz.md5}MD5}} {{{http://www.apache.org/dist/logging/log4php/2.0.0/Apache_log4php-2.0.0-incubating-pear.tgz.asc}ASC}}
+       The latest development version can be checked out from the {{{./source-repository.html}project repository}}. This will provide access to all the latest features, but may be unstable and should not be used in production systems. 
   
+* Previous Releases
+
+       All previous releases of Apache log4php can be found in the {{{http://archive.apache.org/dist/logging/log4php}archive repository}}.
+       
 * Please mind the signatures
 
-  <<Note:>> when downloading from a mirror please check the {{{http://www.apache.org/dev/release-signing#md5}md5sum}}
-  and verify the {{{http://www.apache.org/dev/release-signing#openpgp}OpenPGP}} compatible signature from the main  {{{http://www.apache.org}Apache site}}. 
-  Links are provided above (next to the release download link).
-  This {{{http://www.apache.org/dist/incubator/log4php/KEYS}KEYS}} file contains the public keys used for signing release. 
-  It is recommended that (when possible) a {{{http://www.apache.org/dev/release-signing#web-of-trust}web of trust}}
-  is used to confirm the identity of these keys. 
-  For more information, please see the {{{http://www.apache.org/dev/release.html}Apache Release FAQ}}.
\ No newline at end of file
+       It is important that you verify the integrity of the downloaded files using the PGP or MD5 signatures. 
+       Please read {{{http://httpd.apache.org/dev/verification.html}Verifying Apache HTTP Server Releases}} for more
+       information on why you should verify our releases.
+
+       The PGP signatures can be verified using PGP or GPG. First download the {{{http://www.apache.org/dist/logging/log4php/KEYS}KEYS}}
+       as well as the asc signature file for the relevant distribution. Make sure you get these files from the 
+       {{{http://www.apache.org/dist/logging/log4php}main distribution directory}}, rather than from a mirror. 
+       
+       Then verify the signatures using:
+
+---
+# gpg --import KEYS
+# gpg --verify apache-log4php-2.0.0-incubating-src.tar.gz.asc
+---
+
+       This should result in a confirmation message:
+       
+---
+gpg: Signature made Fri 27 Nov 2009 07:47:28 AM CET using DSA key ID 42196CA8
+gpg: Good signature from "Christian Grobmeier (Apache Codesigning) <grobmeier@apache.org>"
+---
+
+       Apache log4php 2.0.0 is signed by Christian Grobmeier (key 42196CA8).
+
+       Alternatively, you can verify the MD5 signature on the files.
\ No newline at end of file
diff --git a/src/site/apt/install.apt b/src/site/apt/install.apt
deleted file mode 100644 (file)
index 3b6be99..0000000
+++ /dev/null
@@ -1,43 +0,0 @@
-~~ Licensed to the Apache Software Foundation (ASF) under one or more
-~~ contributor license agreements.  See the NOTICE file distributed with
-~~ this work for additional information regarding copyright ownership.
-~~ The ASF licenses this file to You under the Apache License, Version 2.0
-~~ (the "License"); you may not use this file except in compliance with
-~~ the License.  You may obtain a copy of the License at
-~~
-~~      http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing, software
-~~ distributed under the License is distributed on an "AS IS" BASIS,
-~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-~~ See the License for the specific language governing permissions and
-~~ limitations under the License.
- ------
-Installation
- ------
- ------
- ------
-
-Installation
-
-  log4php is installed easily: 
-
-  * {{{./download.html}download}} the package and unpack it.
-  
-  * copy the folder src/main/php into the target location of your application, f. e. $YOURAPP/log4php
-  
-  * include/require the class log4php/Logger.php in your applications
-  
-  * finished :-)
-
-Installation from repository
-
-  * Make sure you have an SVN client installed on your machine
-  
-  * Type: svn co http://svn.apache.org/viewcvs.cgi/logging/log4php/trunk log4php
-  
-  * Alternative, use TortoiseSVN or Eclipse and check out the directory above
-  
-  * copy the folder src/main/php into the target location of your application, f. e. $YOURAPP/log4php
-  
-  * include/require the class log4php/Logger.php in your applications 
index 8191d2b..a949bb3 100644 (file)
@@ -20,16 +20,18 @@ Quickstart
 
 Quickstart
 
-  First, please {{{./install.html}install log4php}}.
+  First, please {{{./download.html}download log4php}} and unpack it.
+  
+  Optionally, you may copy the folder <<src/main/php>>, which contains the source code, to a location of your choosing. For example, a folder within your project.  
 
-  It would also be wise to read the {{{./docs/introduction.html}introduction to log4php}} to familiarise yoursef with the basic concepts used throughout the documentation and examples.
+  Please read the {{{./docs/introduction.html}introduction}} to familiarise yoursef with the basic concepts used throughout the documentation and examples.
   
 * A trivial example
   
   You just want logging to stdout?
 
 +--
-require_once('log4php/Logger.php');
+include('log4php/Logger.php');
 
 $logger = Logger::getLogger("main");
 $logger->info("foo");
@@ -77,8 +79,8 @@ Sun Jul 26 01:40:23 2009,030 [10093] WARN main - bar
   To try it out, run the following code:
 
 +--
-// Replace the path with where you installed log4php
-require_once('/path/to/log4php/Logger.php');
+// Insert the path where you unpacked log4php
+include('log4php/Logger.php');
 
 // Tell log4php to use our configuration file.
 Logger::configure('log4php.xml');
@@ -105,7 +107,15 @@ FATAL - My sixth message.
 
 * An advanced example
 
-  Named loggers; layouts; best practices in object-oriented programming.
+  This example covers:
+  
+  * named loggers 
+  
+  * using layouts 
+  
+  * best practices in object-oriented programming
+  
+  []
   
   Create the following configuration file:
 
@@ -144,7 +154,7 @@ FATAL - My sixth message.
   The code:
   
 +--
-require 'D:\Projects\apache\log4php\src\main\php\Logger.php';
+include('log4php/Logger.php');
 
 Logger::configure('D:\Projects\apache\_playground\log4php.xml');
 
index 6cd4519..c5a6d56 100644 (file)
@@ -18,18 +18,18 @@ Upgrading
  ------
  ------
 
-Upgrading from previous versions to 2.0
+Upgrading
 
-  log4php 2.0 is not compatible with the previous versions. Please have the following in mind when
+  Apache log4php 2.0 is not compatible with the previous versions. Please have the following in mind when
   upgrading to log4php 2.0 in your project: 
 
-  * PHP5 is required instead of PHP4
+  * PHP 5.2+ is required
   
-  * The LoggerManager class has been removed. Use Logger instead.
+  * LoggerManager class has been removed. Use Logger instead.
   
   * LoggerHierarchy is not a singleton anymore by default. 
   
-  * log4php logs to std out by default
+  * Apache log4php logs to STDOUT by default
   
-  * The old constants LOG4PHP_CONFIGURATION and similar are not longer valid. Please use Logger::configure for configuring log4php
+  * LOG4PHP_CONFIGURATION constant is no longer used. Please use Logger::configure() to configure log4php.
   
\ No newline at end of file
index cf7f0ac..1743357 100644 (file)
@@ -45,7 +45,6 @@
   
                <menu name="Get log4php">
                   <item name="Download" href="/download.html"/>
-                  <item name="Install" href="/install.html"/>
                   <item name="Upgrading" href="/upgrading.html"/>
                </menu>
 
@@ -63,7 +62,7 @@
                                <item name="Renderer" href="/docs/renderer.html"/> 
                                <item name="Performance" href="/docs/performance.html"/>
                        </item>
-                       <item name="PHPDoc" href="/apidocs/index.html"/>
+                       <item name="API docs" href="/apidocs/index.html"/>
                </menu>
                
                <menu name="Community">
@@ -76,7 +75,6 @@
                <menu name="Developers">
                        <item name="Volunteering" href="/volunteering.html"/>
                        <item name="Contributing Patches" href="/contributingpatches.html"/>                    
-                       <item name="Roadmap" href="/roadmap.html"/>
                        <item name="Code Coverage" href="/coverage-report/index.html"/>
                        <item name="Buildbot" href="http://ci.apache.org/projects/log4php"/>
                </menu>