You are viewing a plain text version of this content. The canonical link for it is here.
Posted to droids-commits@incubator.apache.org by to...@apache.org on 2012/06/12 09:54:42 UTC
svn commit: r1349220 - in /incubator/droids/trunk/src/site: apt/download.apt
apt/features.apt apt/get-involved.apt apt/index.apt apt/install.apt
apt/news.apt resources/css/site.css resources/images/apache-egg-logo.png
site.xml
Author: tobr
Date: Tue Jun 12 09:54:41 2012
New Revision: 1349220
URL: http://svn.apache.org/viewvc?rev=1349220&view=rev
Log:
updated documentation to support apache naming conventions
Added:
incubator/droids/trunk/src/site/resources/images/apache-egg-logo.png (with props)
Modified:
incubator/droids/trunk/src/site/apt/download.apt
incubator/droids/trunk/src/site/apt/features.apt
incubator/droids/trunk/src/site/apt/get-involved.apt
incubator/droids/trunk/src/site/apt/index.apt
incubator/droids/trunk/src/site/apt/install.apt
incubator/droids/trunk/src/site/apt/news.apt
incubator/droids/trunk/src/site/resources/css/site.css
incubator/droids/trunk/src/site/site.xml
Modified: incubator/droids/trunk/src/site/apt/download.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/download.apt?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/download.apt (original)
+++ incubator/droids/trunk/src/site/apt/download.apt Tue Jun 12 09:54:41 2012
@@ -23,7 +23,7 @@
Download
- Download source below Droids 0.1.0-incubating
+ Download source below Apache Droids 0.1.0-incubating
* {{{http://www.apache.org/dyn/closer.cgi/incubator/droids/0.1.0-incubating/droids-0.1.0-incubating-source-release.zip}Source code}} (ZIP archive)
Modified: incubator/droids/trunk/src/site/apt/features.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/features.apt?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/features.apt (original)
+++ incubator/droids/trunk/src/site/apt/features.apt Tue Jun 12 09:54:41 2012
@@ -27,7 +27,7 @@ Feature List
* Multi-threaded. The architecture is that a robot (e.g. HelloCrawler controls various worker (threads) that are doing the actual work.
- * Honor robots.txt. By default droids honors the robot.txt. However you can turn on the hostile mode of a droid (droids.protocol.http.force=true).
+ * Honor robots.txt. By default Apache Droids honors the robot.txt. However you can turn on the hostile mode of a droid (droids.protocol.http.force=true).
* Crawl throttling. You can configure the amount of concurrent threads that a droid can distribute to their workers (droids.maxThreads=5) and the delay time between the requests (droids.delay.request=500). You can use one of the different delay components:
@@ -39,11 +39,11 @@ Feature List
* Spring based - dynamics. The properties mentioned above get picked up by the build process which inject them in the spring configuration.
- * Extensible - dynamics. The spring configuration makes usage of the cocoon-configurator and its dynamic registry support (making extending droids a pleasure).
+ * Extensible - dynamics. The spring configuration makes usage of the cocoon-configurator and its dynamic registry support (making extending Apache Droids a pleasure).
Architecture
- The following graph shows the basic architecture of droids with the help of the first implementation (helloCrawler).
+ The following graph shows the basic architecture of Apache Droids with the help of the first implementation (helloCrawler).
[images/droidsOverview.png] architecture graph
\ No newline at end of file
Modified: incubator/droids/trunk/src/site/apt/get-involved.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/get-involved.apt?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/get-involved.apt (original)
+++ incubator/droids/trunk/src/site/apt/get-involved.apt Tue Jun 12 09:54:41 2012
@@ -23,18 +23,18 @@
Get involved
- The Droids Project is an {{{http://www.opensource.org/}Open Source}} volunteer project released under a very liberal license.
+ The Apache Droids Project is an {{{http://www.opensource.org/}Open Source}} volunteer project released under a very liberal license.
This means there are many ways to contribute to the project - either with direct participation
(coding, documenting, answering questions, proposing ideas, reporting bugs, suggesting bug-fixes, etc..)
or by resource donations (staff time, conference presentations, publicity, software)
and even general hardware/money {{{http://www.apache.org/foundation/thanks.html}donations}} via the ASF.
- To begin with, we suggest you to subscribe to the {{{./mail-lists.html}Droids mailing lists}}
+ To begin with, we suggest you to subscribe to the {{{./mail-lists.html}Apache Droids mailing lists}}
(follow the link for information on how to subscribe and to access the mail list archives).
Listen-in for a while, to hear how others make contributions.
You can get your local working copy of the {{{./source-repository.html}latest and greatest code}}
- (which you find in the Droids module in the Labs Subversion code repository).
+ (which you find in the Apache Droids module in the Labs Subversion code repository).
Review the todo list and the issue tracker, choose a task.
Perhaps you have noticed something that needs patching, or have a new feature to contribute.
Make the changes, do the testing, generate a patch, and discuss on the dev mailing list.
@@ -50,7 +50,7 @@ Help Wanted Here
* Assisting to improve documentation.
- * Testing Droids (especially its less-frequently-used features) on various configurations and reporting back.
+ * Testing Apache Droids (especially its less-frequently-used features) on various configurations and reporting back.
* New samples, droids and plugins to concisely describe and demonstrate features. Such samples can also enable automated testing.
@@ -58,17 +58,17 @@ Help Wanted Here
Some known bugs are informally listed on To Do, and some are recorded as issues (see explanation below).
* Providing new use-cases and requirements.
- If you think that Droids does not quite meet your needs then tell us about it.
+ If you think that Apache Droids does not quite meet your needs then tell us about it.
* Specifying/analysing/designing new features - and beyond.
If you wish to get further involved with this, please join the labs mailing list,
- install and try out Droids and read some of the mail archives.
+ install and try out Apache Droids and read some of the mail archives.
You should have a reasonable fluency in Java technologies, some Spring and Ant skills,
- and a basic understanding of the Droids architecture - don't just say "it should have XYZ" without reading anything first -
+ and a basic understanding of the Apache Droids architecture - don't just say "it should have XYZ" without reading anything first -
because chances are, somebody has already thought of that feature!)
- * ... and there is just one other thing - don't forget to tell everyone who asks, how great Droids is!
- The more people that know about and start to use Droids, the larger the pool of potential contributors will be.
+ * ... and there is just one other thing - don't forget to tell everyone who asks, how great Apache Droids is!
+ The more people that know about and start to use Apache Droids, the larger the pool of potential contributors will be.
Procedure for reporting bugs and issues and enhancement suggestions
@@ -92,17 +92,17 @@ Procedure for reporting bugs and issues
SVN Usage
- An overview of how to use Subversion (SVN) to participate in Droids development.
+ An overview of how to use Subversion (SVN) to participate in Apache Droids development.
Do not be afraid - you cannot accidently destroy the actual code repository,
because you are working with a local copy as an anonymous user.
Therefore, you do not have the system permissions to change anything.
You can only update your local repository and compare your revisions with the real repository.
- The {{{./install.html}Installing Droids}} document explains.
+ The {{{./install.html}Installing Apache Droids}} document explains.
Coding Guidelines
- We use coding standards so that Droids source code is easy to understand, to maintain, and to enhance.
+ We use coding standards so that Apache Droids source code is easy to understand, to maintain, and to enhance.
We are using the commit-then-review approach.
Still, nothing untested should be committed. First test then commit!!!
@@ -116,7 +116,7 @@ Coding Guidelines
How to prepare and contribute patches
- If you use the current development version of Droids via Subversion, then first check what files have changed.
+ If you use the current development version of Apache Droids via Subversion, then first check what files have changed.
-------------------------
svn update; svn status
@@ -139,7 +139,7 @@ How to prepare and contribute patches
For more information about working with SVN, see {{{http://svnbook.red-bean.com/}Version Control}} with Subversion - the opensource SVN book.
- <<Note>>: Please send all contributions via our issue tracker. and specify the Droids version or svn version of the source.
+ <<Note>>: Please send all contributions via our issue tracker. and specify the Apache Droids version or svn version of the source.
- It is always a good idea to check the Droids issue tracker before diving in.
+ It is always a good idea to check the Apache Droids issue tracker before diving in.
Modified: incubator/droids/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/index.apt?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/index.apt (original)
+++ incubator/droids/trunk/src/site/apt/index.apt Tue Jun 12 09:54:41 2012
@@ -21,24 +21,26 @@
------
DD.MM.YYYY
-Apache Droids
+Apache Droids (Incubating)
- Droids aims to be an intelligent standalone robot framework that allows to create and extend existing droids (robots). In the future it will offer an administration application to manage and controll the different droids.
+ Apache Droids aims to be an intelligent standalone robot framework that allows to create and extend existing droids (robots). In the future it will offer an administration application to manage and controll the different droids.
- Droids makes it very easy to extend existing robots or write a new one from scratch, which can automatically seek out relevant online information based on the user's specifications.
+ Apache Droids makes it very easy to extend existing robots or write a new one from scratch, which can automatically seek out relevant online information based on the user's specifications.
- Droids (plural) is not designed for a special usecase, it is a framework: <<Take what you need, do what you want>>.
+ Apache Droids (plural) is not designed for a special usecase, it is a framework: <<Take what you need, do what you want>>.
- Droids offers you following the components so far:
+ Apache Droids offers you following the components so far:
* Queue, a queue is the data structure where the different tasks are waiting for service.
* Protocol, the protocol interface is a wrapper to hide the underlying implementation of the communication at protocol level.
- * Parser -> Apache Tika, the parser component is just a wrapper for tika since it offers everything we need. No need to duplicate the effort. The Paser component parses different input types to SAX events.
+ * Parser -> Apache Tika, the parser component is just a wrapper for Apache Tika since it offers everything we need. No need to duplicate the effort. The Paser component parses different input types to SAX events.
- * Handler, a handler is a component that uses the original stream and/or the parse (ContentHandler coming from Tika) and the url to invoke arbitrary business logic on the objects. Unless like the other components different handler can be applied on the stream/parse
+ * Handler, a handler is a component that uses the original stream and/or the parse (ContentHandler coming from Apache Tika) and the url to invoke arbitrary business logic on the objects. Unless like the other components different handler can be applied on the stream/parse
A Droid (singular) however is all about <<ONE special usecase>>. For example the helloCrawler is a wget style crawler. Meaning you go to a page extract the links and save the page afterward to the file system. The focus of the helloCrawler is this special usecase and to solve it hello uses different components.
In the future there could evolve different subprojects that are providing specialist components for a special use case. However if components get used in different usecases they should be considered common.
+
+ Apache Droids is currently undergoing Incubation at the Apache Software Foundation.
\ No newline at end of file
Modified: incubator/droids/trunk/src/site/apt/install.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/install.apt?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/install.apt (original)
+++ incubator/droids/trunk/src/site/apt/install.apt Tue Jun 12 09:54:41 2012
@@ -25,7 +25,7 @@ Installation Guide
* Prerequisites
- Before starting to work with Droids you need to install
+ Before starting to work with Apache Droids you need to install
--------------------
jdk >= 1.6
@@ -46,7 +46,7 @@ cd apache-droids
* Build
- Create a distribution (all components of droids will be build) and install them to your local maven repository (usually ~/.m2/repository) with the following command.
+ Create a distribution (all components of Apache Droids will be build) and install them to your local maven repository (usually ~/.m2/repository) with the following command.
-------------------
mvn clean install
@@ -57,7 +57,7 @@ mvn clean install
For working with eclipse you can ether use the maven eclipse plugin or the eclipse {{{http://www.eclipse.org/m2e/}Maven Integration m2e}}
- For the maven eclipse plugin run the following command from your Droids root folder
+ For the maven eclipse plugin run the following command from your Apache Droids root folder
------------------
mvn eclipse:clean eclipse:eclipse
@@ -66,4 +66,4 @@ mvn eclipse:clean eclipse:eclipse
Get Started
- Now you have successully set up droids, you can follow {{{./getting-started.html}some examples}}.
\ No newline at end of file
+ Now you have successully set up Apache Droids, you can follow {{{./getting-started.html}some examples}}.
\ No newline at end of file
Modified: incubator/droids/trunk/src/site/apt/news.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/news.apt?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/news.apt (original)
+++ incubator/droids/trunk/src/site/apt/news.apt Tue Jun 12 09:54:41 2012
@@ -25,4 +25,4 @@ News
* 03 November 2011 - First Release
- The first release of Droids Incubating has been made, version 0.1.0-incubating. You can get it from the {{{./download.html}download}} page. The binary artifacts are available on Maven Central for ease of use.
+ The first release of Apache Droids Incubating has been made, version 0.1.0-incubating. You can get it from the {{{./download.html}download}} page. The binary artifacts are available on Maven Central for ease of use.
Modified: incubator/droids/trunk/src/site/resources/css/site.css
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/resources/css/site.css?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/resources/css/site.css (original)
+++ incubator/droids/trunk/src/site/resources/css/site.css Tue Jun 12 09:54:41 2012
@@ -17,17 +17,10 @@
* under the License.
*/
-
-#banner {
- height: 121px;
- background-image: none;
-}
-
-#navcolumn h5 {
- color: #01709c;
+.droidsFooter {
+ margin-top: 6px;
}
-#bannerRight {
- margin-top: 40px;
- margin-right: 10px;
+.droidsFooter p {
+ margin-bottom: 0px;
}
Added: incubator/droids/trunk/src/site/resources/images/apache-egg-logo.png
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/resources/images/apache-egg-logo.png?rev=1349220&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/droids/trunk/src/site/resources/images/apache-egg-logo.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: incubator/droids/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/site.xml?rev=1349220&r1=1349219&r2=1349220&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/site.xml (original)
+++ incubator/droids/trunk/src/site/site.xml Tue Jun 12 09:54:41 2012
@@ -16,14 +16,14 @@
<version>1.2.1</version>
</skin>
<bannerLeft>
- <name>Maven</name>
+ <name>Apache Droids</name>
<src>images/droids-logo.png</src>
- <href>http://incubator.apache.org/droids/</href>
+ <href>https://incubator.apache.org/droids/</href>
</bannerLeft>
<bannerRight>
- <name>Maven</name>
- <src>images/asf_logo_wide.png</src>
- <href>http://www.apache.org/</href>
+ <name>Apache Incubator</name>
+ <src>images/apache-egg-logo.png</src>
+ <href>https://incubator.apache.org/</href>
</bannerRight>
<body>
<links>
@@ -57,5 +57,14 @@
<item name="Become a Sponsor" href="http://www.apache.org/foundation/sponsorship.html" />
</menu>
+ <footer><div class="row span16 droidsFooter"><p>Apache Droids is an effort undergoing incubation at The Apache Software
+Foundation (ASF), sponsored by Apache Lucene PMC.</p>
+<p>Incubation is required of all newly accepted projects until a further review
+indicates that the infrastructure, communications, and decision making process
+have stabilized in a manner consistent with other successful ASF projects.</p>
+<p>While incubation status is not necessarily a reflection of the completeness
+or stability of the code, it does indicate that the project has yet to be
+fully endorsed by the ASF.</p></div>
+<div class="row span16 droidsFooter"><p>Apache and the Apache feather logos are trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.</p></div></footer>
</body>
</project>