BIGTOP-1157. Add a new Apache Bigtop user guide This is the first step in introducing a user guide for Apache Bigtop. This commit adds all the necessary files to build such guide. It builds a PDF and html version as part of the "maven site" command
Project: http://git-wip-us.apache.org/repos/asf/bigtop/repo Commit: http://git-wip-us.apache.org/repos/asf/bigtop/commit/9b4ac71a Tree: http://git-wip-us.apache.org/repos/asf/bigtop/tree/9b4ac71a Diff: http://git-wip-us.apache.org/repos/asf/bigtop/diff/9b4ac71a Branch: refs/heads/master Commit: 9b4ac71a96ec04c4a956faad3d787b21b9728738 Parents: d83362b Author: Bruno Mahé <[email protected]> Authored: Sun Dec 8 21:39:59 2013 -0800 Committer: Bruno Mahé <[email protected]> Committed: Wed Dec 11 00:15:23 2013 -0800 ---------------------------------------------------------------------- pom.xml | 810 +++++++++++--------- src/site/docbookx/apache-bigtop-user-guide.xml | 85 ++ src/site/docbookx/customization.xsl | 33 + src/site/docbookx/userguide/introduction.xml | 32 + src/site/docbookx/userguide/preface.xml | 28 + src/site/docbookx/userguide/what-s-new.xml | 32 + src/site/resources/css/freebsd_docbook.css | 208 +++++ src/site/site.xml | 3 +- 8 files changed, 856 insertions(+), 375 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 3e7c1fe..1381791 100644 --- a/pom.xml +++ b/pom.xml @@ -1,392 +1,454 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - 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 + 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 + 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. + 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. --> <project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> - <modelVersion>4.0.0</modelVersion> - - <parent> - <groupId>org.apache</groupId> - <artifactId>apache</artifactId> - <version>8</version> - </parent> + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> - <groupId>org.apache.bigtop</groupId> - <artifactId>bigtop</artifactId> - <version>0.8.0-SNAPSHOT</version> - <packaging>pom</packaging> - - <name>Bigtop</name> - <description>The development of packaging and tests of the Apache Hadoop ecosystem</description> - <url>http://bigtop.apache.org/</url> - <inceptionYear>2011</inceptionYear> + <parent> + <groupId>org.apache</groupId> + <artifactId>apache</artifactId> + <version>8</version> + </parent> - <properties> - <hadoop.version>2.0.6-alpha</hadoop.version> - <hbase.version>0.94.11</hbase.version> - <pig.version>0.11.1</pig.version> - <pig-smoke.version>0.11.1</pig-smoke.version> - <sqoop.version>1.99.2</sqoop.version> - <zookeeper.version>3.4.5</zookeeper.version> - <giraph.version>1.0.0</giraph.version> - <solr.version>4.4.0</solr.version> - <spark.version>0.8.0-incubating</spark.version> - <spark-smoke.version>${project.version}</spark-smoke.version> + <groupId>org.apache.bigtop</groupId> + <artifactId>bigtop</artifactId> + <version>0.8.0-SNAPSHOT</version> + <packaging>pom</packaging> - <itest-common.version>${project.version}</itest-common.version> + <name>Bigtop</name> + <description>The development of packaging and tests of the Apache Hadoop ecosystem</description> + <url>http://bigtop.apache.org/</url> + <inceptionYear>2011</inceptionYear> - <groovy.version>1.8.6</groovy.version> - <groovy-eclipse-compiler.version>2.7.0-01</groovy-eclipse-compiler.version> - <gmaven.version>1.0</gmaven.version> - <ant.version>1.8.2</ant.version> - <commons.logging.version>1.1</commons.logging.version> - <junit.version>4.11</junit.version> - <slf4j.version>1.6.6</slf4j.version> - <log4j.version>1.2.14</log4j.version> - <antlr.version>3.4</antlr.version> - <cxf.version>2.5.0</cxf.version> - </properties> + <properties> + <hadoop.version>2.0.6-alpha</hadoop.version> + <hbase.version>0.94.11</hbase.version> + <pig.version>0.11.1</pig.version> + <pig-smoke.version>0.11.1</pig-smoke.version> + <sqoop.version>1.99.2</sqoop.version> + <zookeeper.version>3.4.5</zookeeper.version> + <giraph.version>1.0.0</giraph.version> + <solr.version>4.4.0</solr.version> + <spark.version>0.8.0-incubating</spark.version> + <spark-smoke.version>${project.version}</spark-smoke.version> - <dependencyManagement> - <dependencies> - <dependency> - <groupId>org.codehaus.groovy</groupId> - <artifactId>groovy-all</artifactId> - <version>${groovy.version}</version> - </dependency> - <dependency> - <groupId>org.codehaus.groovy.maven.runtime</groupId> - <artifactId>gmaven-runtime-1.6</artifactId> - <version>${gmaven.version}</version> - </dependency> - <dependency> - <groupId>org.apache.ant</groupId> - <artifactId>ant-launcher</artifactId> - <version>${ant.version}</version> - </dependency> - <dependency> - <groupId>org.apache.ant</groupId> - <artifactId>ant-junit</artifactId> - <version>${ant.version}</version> - </dependency> - <dependency> - <groupId>org.apache.ant</groupId> - <artifactId>ant</artifactId> - <version>${ant.version}</version> - </dependency> - <dependency> - <groupId>commons-logging</groupId> - <artifactId>commons-logging</artifactId> - <version>${commons.logging.version}</version> - </dependency> - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <version>${junit.version}</version> - </dependency> - <dependency> - <groupId>org.slf4j</groupId> - <artifactId>slf4j-simple</artifactId> - <version>${slf4j.version}</version> - </dependency> - <dependency> - <groupId>log4j</groupId> - <artifactId>log4j</artifactId> - <version>1.2.14</version> - </dependency> - <dependency> - <groupId>org.antlr</groupId> - <artifactId>antlr</artifactId> - <version>${antlr.version}</version> - </dependency> - <dependency> - <groupId>org.apache.cxf</groupId> - <artifactId>cxf-rt-frontend-jaxrs</artifactId> - <version>${cxf.version}</version> - </dependency> + <itest-common.version>${project.version}</itest-common.version> - <dependency> - <groupId>org.apache.bigtop.itest</groupId> - <artifactId>itest-common</artifactId> - <version>${itest-common.version}</version> - </dependency> + <groovy.version>1.8.6</groovy.version> + <groovy-eclipse-compiler.version>2.7.0-01</groovy-eclipse-compiler.version> + <gmaven.version>1.0</gmaven.version> + <ant.version>1.8.2</ant.version> + <commons.logging.version>1.1</commons.logging.version> + <junit.version>4.11</junit.version> + <slf4j.version>1.6.6</slf4j.version> + <log4j.version>1.2.14</log4j.version> + <antlr.version>3.4</antlr.version> + <cxf.version>2.5.0</cxf.version> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-common</artifactId> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-common</artifactId> - <type>test-jar</type> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-client</artifactId> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-minicluster</artifactId> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-common-test</artifactId> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-hdfs</artifactId> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-hdfs-test</artifactId> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hadoop</groupId> - <artifactId>hadoop-mapreduce</artifactId> - <version>${hadoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hbase</groupId> - <artifactId>hbase</artifactId> - <version>${hbase.version}</version> - </dependency> - <dependency> - <groupId>org.apache.hbase</groupId> - <artifactId>hbase</artifactId> - <version>${hbase.version}</version> - <type>test-jar</type> - </dependency> - <dependency> - <groupId>org.apache.pig</groupId> - <artifactId>pig</artifactId> - <version>${pig.version}</version> - </dependency> - <dependency> - <groupId>org.apache.pig</groupId> - <artifactId>pigsmoke</artifactId> - <version>${pig-smoke.version}</version> - </dependency> - <dependency> - <groupId>org.apache.zookeeper</groupId> - <artifactId>zookeeper</artifactId> - <version>${zookeeper.version}</version> - </dependency> - <dependency> - <groupId>org.apache.giraph</groupId> - <artifactId>giraph</artifactId> - <version>${giraph.version}</version> - </dependency> - <dependency> - <groupId>org.apache.solr</groupId> - <artifactId>solr-solrj</artifactId> - <version>${solr.version}</version> - </dependency> - <dependency> - <groupId>org.apache.sqoop</groupId> - <artifactId>sqoop</artifactId> - <version>${sqoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.sqoop</groupId> - <artifactId>sqoop-core</artifactId> - <version>${sqoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.sqoop</groupId> - <artifactId>sqoop-client</artifactId> - <version>${sqoop.version}</version> - </dependency> - <dependency> - <groupId>org.apache.spark</groupId> - <artifactId>spark-core_2.9.3</artifactId> - <version>${spark.version}</version> - </dependency> - </dependencies> - </dependencyManagement> + <maven.build.timestamp.format> + yyyy-MM-dd'T'HH:mm + </maven.build.timestamp.format> + <buildDate>${maven.build.timestamp}</buildDate> + </properties> - <build> - <extensions> - <extension> - <groupId>org.apache.maven.wagon</groupId> - <artifactId>wagon-ssh-external</artifactId> - <version>1.0-beta-6</version> - </extension> - </extensions> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.apache.rat</groupId> - <artifactId>apache-rat-plugin</artifactId> - <version>0.7</version> - <configuration> - <excludes> - <exclude>.git/**</exclude> - <exclude>**/.gitignore</exclude> - <!-- Test data with rigid structure and/or binary --> - <exclude>bigtop-tests/test-artifacts/**/resources/**</exclude> - <!-- Debian package files that have a rigid structure (* matches package name) --> - <exclude>bigtop-packages/src/deb/*/*.dirs</exclude> - <exclude>bigtop-packages/src/deb/*/dirs</exclude> - <exclude>bigtop-packages/src/deb/*/*.install</exclude> - <exclude>bigtop-packages/src/deb/*/*.manpages</exclude> - <exclude>bigtop-packages/src/deb/*/*.docs</exclude> - <exclude>bigtop-packages/src/deb/*/docs</exclude> - <exclude>bigtop-packages/src/deb/*/compat</exclude> - <exclude>bigtop-packages/src/deb/*/source/format</exclude> - <exclude>bigtop-packages/src/deb/*/*.lintian-overrides</exclude> - <exclude>bigtop-packages/src/deb/*/shlibs.local</exclude> - <exclude>bigtop-repos/apt/distributions</exclude> - <!-- Miscelaneous individual files --> - <exclude>src/site/resources/bigtop.rdf</exclude> - <exclude>src/site/resources/images/bigtop-logo.ai</exclude> - <exclude>test/MANIFEST.txt</exclude> - <exclude>bigtop-deploy/puppet/modules/hadoop/templates/taskcontroller.cfg</exclude> - <exclude>bigtop-deploy/puppet/modules/hadoop/templates/container-executor.cfg</exclude> - <exclude>bigtop-deploy/puppet/README.md</exclude> - <exclude>bigtop-deploy/puppet/config/site.csv.example</exclude> - </excludes> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-pdf-plugin</artifactId> - <version>1.2</version> - <dependencies> - <dependency> - <groupId>org.apache.maven.doxia</groupId> - <artifactId>doxia-module-confluence</artifactId> - <version>1.1.3</version> - </dependency> - </dependencies> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-site-plugin</artifactId> - <version>2.1.1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-assembly-plugin</artifactId> - <version>2.3</version> - <configuration> - <descriptorRefs> - <descriptorRef>project</descriptorRef> - </descriptorRefs> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-gpg-plugin</artifactId> - <version>1.4</version> - </plugin> - </plugins> - </pluginManagement> - </build> + <dependencyManagement> + <dependencies> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy-all</artifactId> + <version>${groovy.version}</version> + </dependency> + <dependency> + <groupId>org.codehaus.groovy.maven.runtime</groupId> + <artifactId>gmaven-runtime-1.6</artifactId> + <version>${gmaven.version}</version> + </dependency> + <dependency> + <groupId>org.apache.ant</groupId> + <artifactId>ant-launcher</artifactId> + <version>${ant.version}</version> + </dependency> + <dependency> + <groupId>org.apache.ant</groupId> + <artifactId>ant-junit</artifactId> + <version>${ant.version}</version> + </dependency> + <dependency> + <groupId>org.apache.ant</groupId> + <artifactId>ant</artifactId> + <version>${ant.version}</version> + </dependency> + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <version>${commons.logging.version}</version> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <version>${junit.version}</version> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-simple</artifactId> + <version>${slf4j.version}</version> + </dependency> + <dependency> + <groupId>log4j</groupId> + <artifactId>log4j</artifactId> + <version>1.2.14</version> + </dependency> + <dependency> + <groupId>org.antlr</groupId> + <artifactId>antlr</artifactId> + <version>${antlr.version}</version> + </dependency> + <dependency> + <groupId>org.apache.cxf</groupId> + <artifactId>cxf-rt-frontend-jaxrs</artifactId> + <version>${cxf.version}</version> + </dependency> - <issueManagement> - <system>JIRA</system> - <url>http://issues.apache.org/jira/browse/BIGTOP</url> - </issueManagement> - <mailingLists> - <mailingList> - <name>Users</name> - <post>[email protected]</post> - <subscribe>[email protected]</subscribe> - <unsubscribe>[email protected]</unsubscribe> - <archive>http://mail-archives.apache.org/mod_mbox/bigtop-user/</archive> - </mailingList> - <mailingList> - <name>Development</name> - <post>[email protected]</post> - <subscribe>[email protected]</subscribe> - <unsubscribe>[email protected]</unsubscribe> - <archive>http://mail-archives.apache.org/mod_mbox/bigtop-dev/</archive> - </mailingList> - <mailingList> - <name>Commits</name> - <post>[email protected]</post> - <subscribe>[email protected]</subscribe> - <unsubscribe>[email protected]</unsubscribe> - <archive>http://mail-archives.apache.org/mod_mbox/bigtop-commits/</archive> - </mailingList> - </mailingLists> - <scm> - <connection>scm:git:https://git-wip-us.apache.org/repos/asf/bigtop.git</connection> - <url>https://git-wip-us.apache.org/repos/asf?p=bigtop.git</url> - </scm> + <dependency> + <groupId>org.apache.bigtop.itest</groupId> + <artifactId>itest-common</artifactId> + <version>${itest-common.version}</version> + </dependency> - <distributionManagement> - <site> - <id>apache.website</id> - <url>scpexe://people.apache.org/www/bigtop.apache.org/</url> - </site> - </distributionManagement> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-common</artifactId> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-common</artifactId> + <type>test-jar</type> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-client</artifactId> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-minicluster</artifactId> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-common-test</artifactId> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-hdfs</artifactId> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-hdfs-test</artifactId> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hadoop</groupId> + <artifactId>hadoop-mapreduce</artifactId> + <version>${hadoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hbase</groupId> + <artifactId>hbase</artifactId> + <version>${hbase.version}</version> + </dependency> + <dependency> + <groupId>org.apache.hbase</groupId> + <artifactId>hbase</artifactId> + <version>${hbase.version}</version> + <type>test-jar</type> + </dependency> + <dependency> + <groupId>org.apache.pig</groupId> + <artifactId>pig</artifactId> + <version>${pig.version}</version> + </dependency> + <dependency> + <groupId>org.apache.pig</groupId> + <artifactId>pigsmoke</artifactId> + <version>${pig-smoke.version}</version> + </dependency> + <dependency> + <groupId>org.apache.zookeeper</groupId> + <artifactId>zookeeper</artifactId> + <version>${zookeeper.version}</version> + </dependency> + <dependency> + <groupId>org.apache.giraph</groupId> + <artifactId>giraph</artifactId> + <version>${giraph.version}</version> + </dependency> + <dependency> + <groupId>org.apache.solr</groupId> + <artifactId>solr-solrj</artifactId> + <version>${solr.version}</version> + </dependency> + <dependency> + <groupId>org.apache.sqoop</groupId> + <artifactId>sqoop</artifactId> + <version>${sqoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.sqoop</groupId> + <artifactId>sqoop-core</artifactId> + <version>${sqoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.sqoop</groupId> + <artifactId>sqoop-client</artifactId> + <version>${sqoop.version}</version> + </dependency> + <dependency> + <groupId>org.apache.spark</groupId> + <artifactId>spark-core_2.9.3</artifactId> + <version>${spark.version}</version> + </dependency> + </dependencies> + </dependencyManagement> - <profiles> - <profile> - <id>release</id> - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-assembly-plugin</artifactId> - <executions> - <execution> - <phase>package</phase> - <goals> - <goal>single</goal> - </goals> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.apache.rat</groupId> - <artifactId>apache-rat-plugin</artifactId> - <executions> - <execution> - <phase>verify</phase> - <goals> - <goal>check</goal> - </goals> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-gpg-plugin</artifactId> - <executions> - <execution> - <id>sign-artifacts</id> - <phase>verify</phase> - <goals> - <goal>sign</goal> - </goals> - </execution> - </executions> - </plugin> - </plugins> - </build> - </profile> - </profiles> + <build> + <extensions> + <extension> + <groupId>org.apache.maven.wagon</groupId> + <artifactId>wagon-ssh-external</artifactId> + <version>1.0-beta-6</version> + </extension> + </extensions> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.rat</groupId> + <artifactId>apache-rat-plugin</artifactId> + <version>0.7</version> + <configuration> + <excludes> + <exclude>.git/**</exclude> + <exclude>**/.gitignore</exclude> + <!-- Test data with rigid structure and/or binary --> + <exclude>bigtop-tests/test-artifacts/**/resources/**</exclude> + <!-- Debian package files that have a rigid structure (* matches package name) --> + <exclude>bigtop-packages/src/deb/*/*.dirs</exclude> + <exclude>bigtop-packages/src/deb/*/dirs</exclude> + <exclude>bigtop-packages/src/deb/*/*.install</exclude> + <exclude>bigtop-packages/src/deb/*/*.manpages</exclude> + <exclude>bigtop-packages/src/deb/*/*.docs</exclude> + <exclude>bigtop-packages/src/deb/*/docs</exclude> + <exclude>bigtop-packages/src/deb/*/compat</exclude> + <exclude>bigtop-packages/src/deb/*/source/format</exclude> + <exclude>bigtop-packages/src/deb/*/*.lintian-overrides</exclude> + <exclude>bigtop-packages/src/deb/*/shlibs.local</exclude> + <exclude>bigtop-repos/apt/distributions</exclude> + <!-- Miscelaneous individual files --> + <exclude>src/site/resources/bigtop.rdf</exclude> + <exclude>src/site/resources/images/bigtop-logo.ai</exclude> + <exclude>test/MANIFEST.txt</exclude> + <exclude>bigtop-deploy/puppet/modules/hadoop/templates/taskcontroller.cfg</exclude> + <exclude>bigtop-deploy/puppet/modules/hadoop/templates/container-executor.cfg</exclude> + <exclude>bigtop-deploy/puppet/README.md</exclude> + <exclude>bigtop-deploy/puppet/config/site.csv.example</exclude> + </excludes> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-pdf-plugin</artifactId> + <version>1.2</version> + <dependencies> + <dependency> + <groupId>org.apache.maven.doxia</groupId> + <artifactId>doxia-module-confluence</artifactId> + <version>1.1.3</version> + </dependency> + </dependencies> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>2.1.1</version> + + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-assembly-plugin</artifactId> + <version>2.3</version> + <configuration> + <descriptorRefs> + <descriptorRef>project</descriptorRef> + </descriptorRefs> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-gpg-plugin</artifactId> + <version>1.4</version> + </plugin> + </plugins> + </pluginManagement> + <plugins> + <!--Build the documentation. We build it twice. Once as a single page and then again as multipage. --> + <plugin> + <groupId>com.agilejava.docbkx</groupId> + <artifactId>docbkx-maven-plugin</artifactId> + <version>2.0.14</version> + <inherited>false</inherited> + <dependencies> + <dependency> + <groupId>org.docbook</groupId> + <artifactId>docbook-xml</artifactId> + <version>4.4</version> + <scope>runtime</scope> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${basedir}/src/site/docbookx/</sourceDirectory> + <targetDirectory>${basedir}/target/site/book/</targetDirectory> + <htmlCustomization>${basedir}/src/site/docbookx/customization.xsl</htmlCustomization> + <chunkerOutputEncoding>UTF-8</chunkerOutputEncoding> + <sectionAutolabelMaxDepth>100</sectionAutolabelMaxDepth> + <sectionAutolabel>true</sectionAutolabel> + <sectionLabelIncludesComponentLabel>true</sectionLabelIncludesComponentLabel> + <tocMaxDepth>2</tocMaxDepth> + <insertXrefPageNumber>yes</insertXrefPageNumber> + <xincludeSupported>true</xincludeSupported> + <useIdAsFilename>true</useIdAsFilename> + </configuration> + <executions> + <execution> + <id>multipage</id> + <goals> + <goal>generate-html</goal> + </goals> + <phase>pre-site</phase> + <configuration> + <navigShowtitles>true</navigShowtitles> + <chunkedOutput>true</chunkedOutput> + <imgSrcPath>../../images/</imgSrcPath> + <htmlStylesheet>../../css/freebsd_docbook.css</htmlStylesheet> + </configuration> + </execution> + <execution> + <id>doc</id> + <goals> + <goal>generate-pdf</goal> + </goals> + <phase>pre-site</phase> + <configuration> + <showXslMessages>true</showXslMessages> + <imgSrcPath>${basedir}/src/site/resources/images/</imgSrcPath> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + + <issueManagement> + <system>JIRA</system> + <url>http://issues.apache.org/jira/browse/BIGTOP</url> + </issueManagement> + <mailingLists> + <mailingList> + <name>Users</name> + <post>[email protected]</post> + <subscribe>[email protected]</subscribe> + <unsubscribe>[email protected]</unsubscribe> + <archive>http://mail-archives.apache.org/mod_mbox/bigtop-user/</archive> + </mailingList> + <mailingList> + <name>Development</name> + <post>[email protected]</post> + <subscribe>[email protected]</subscribe> + <unsubscribe>[email protected]</unsubscribe> + <archive>http://mail-archives.apache.org/mod_mbox/bigtop-dev/</archive> + </mailingList> + <mailingList> + <name>Commits</name> + <post>[email protected]</post> + <subscribe>[email protected]</subscribe> + <unsubscribe>[email protected]</unsubscribe> + <archive>http://mail-archives.apache.org/mod_mbox/bigtop-commits/</archive> + </mailingList> + </mailingLists> + <scm> + <connection>scm:git:https://git-wip-us.apache.org/repos/asf/bigtop.git</connection> + <url>https://git-wip-us.apache.org/repos/asf?p=bigtop.git</url> + </scm> + + <distributionManagement> + <site> + <id>apache.website</id> + <url>scpexe://people.apache.org/www/bigtop.apache.org/</url> + </site> + </distributionManagement> + + <profiles> + <profile> + <id>release</id> + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-assembly-plugin</artifactId> + <executions> + <execution> + <phase>package</phase> + <goals> + <goal>single</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.rat</groupId> + <artifactId>apache-rat-plugin</artifactId> + <executions> + <execution> + <phase>verify</phase> + <goals> + <goal>check</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-gpg-plugin</artifactId> + <executions> + <execution> + <id>sign-artifacts</id> + <phase>verify</phase> + <goals> + <goal>sign</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + </profile> + </profiles> </project> http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/src/site/docbookx/apache-bigtop-user-guide.xml ---------------------------------------------------------------------- diff --git a/src/site/docbookx/apache-bigtop-user-guide.xml b/src/site/docbookx/apache-bigtop-user-guide.xml new file mode 100644 index 0000000..f82c4fb --- /dev/null +++ b/src/site/docbookx/apache-bigtop-user-guide.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + /** + * + * 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. + */ +--> +<book version="5.0" xmlns="http://docbook.org/ns/docbook"; xmlns:xlink="http://www.w3.org/1999/xlink"; xmlns:xi="http://www.w3.org/2001/XInclude"; + xmlns:svg="http://www.w3.org/2000/svg"; xmlns:m="http://www.w3.org/1998/Math/MathML"; xmlns:html="http://www.w3.org/1999/xhtml"; + xmlns:db="http://docbook.org/ns/docbook"; xml:id="book"> + <info> + <title> + <link xlink:href="http://bigtop.apache.org";> + The + <trademark class='trade'>Apache Bigtop</trademark> + User Guide + </link> + </title> + <subtitle> + <link xlink:href="http://bigtop.apache.org";> + <inlinemediaobject> + <imageobject> + <imagedata align="center" valign="center" fileref="bigtop-logo.png"/> + </imageobject> + </inlinemediaobject> + </link> + </subtitle> + <copyright> + <year>2013</year> + <holder> + Apache Software Foundation. + All Rights Reserved. Apache Bigtop, Hadoop, Hadoop, MapReduce, HDFS, Zookeeper, + HBase, and the + Apache Bigtop project logo are trademarks of the Apache Software Foundation. + </holder> + </copyright> + <abstract> + <para> + This is the official user guide of + <link xlink:href="http://bigtop.apache.org";> + <trademark class='trade'>Apache Bigtop</trademark> + </link> + , a project for the development of packaging and tests of the + <link xlink:href="http://hadoop.apache.org/";> + <trademark class='trade'>Apache Hadoop</trademark> + </link> + ecosystem. + </para> + </abstract> + + <revhistory> + <revision> + <revnumber> + <?eval ${project.version}?> + </revnumber> + <date> + <?eval ${buildDate}?> + </date> + </revision> + </revhistory> + </info> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="userguide/preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="userguide/introduction.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="userguide/what-s-new.xml"/> + + <index xml:id="book_index"> + <title>Index</title> + </index> + +</book> http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/src/site/docbookx/customization.xsl ---------------------------------------------------------------------- diff --git a/src/site/docbookx/customization.xsl b/src/site/docbookx/customization.xsl new file mode 100644 index 0000000..3301251 --- /dev/null +++ b/src/site/docbookx/customization.xsl @@ -0,0 +1,33 @@ +<?xml version="1.0"?> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; + version="1.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. + */ +--> + <xsl:import href="urn:docbkx:stylesheet"/> + <xsl:output method="html" encoding="UTF-8" indent="no"/> + + <xsl:template name="user.header.content" > + </xsl:template> + + <xsl:template name="user.footer.content"> + </xsl:template> + +</xsl:stylesheet> http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/src/site/docbookx/userguide/introduction.xml ---------------------------------------------------------------------- diff --git a/src/site/docbookx/userguide/introduction.xml b/src/site/docbookx/userguide/introduction.xml new file mode 100644 index 0000000..f949f17 --- /dev/null +++ b/src/site/docbookx/userguide/introduction.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter version="5.0" xml:id="introduction" + xmlns="http://docbook.org/ns/docbook"; + xmlns:xlink="http://www.w3.org/1999/xlink"; + xmlns:xi="http://www.w3.org/2001/XInclude"; + xmlns:svg="http://www.w3.org/2000/svg"; + xmlns:m="http://www.w3.org/1998/Math/MathML"; + xmlns:html="http://www.w3.org/1999/xhtml"; + xmlns:db="http://docbook.org/ns/docbook";> +<!-- +/** + * 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. + */ +--> + <title>Introduction</title> + + +</chapter> http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/src/site/docbookx/userguide/preface.xml ---------------------------------------------------------------------- diff --git a/src/site/docbookx/userguide/preface.xml b/src/site/docbookx/userguide/preface.xml new file mode 100644 index 0000000..86dce60 --- /dev/null +++ b/src/site/docbookx/userguide/preface.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<preface version="5.0" xml:id="preface" xmlns="http://docbook.org/ns/docbook"; xmlns:xlink="http://www.w3.org/1999/xlink"; + xmlns:xi="http://www.w3.org/2001/XInclude"; xmlns:svg="http://www.w3.org/2000/svg"; xmlns:m="http://www.w3.org/1998/Math/MathML"; + xmlns:html="http://www.w3.org/1999/xhtml"; xmlns:db="http://docbook.org/ns/docbook";> + <!-- + /** + * 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. + */ + --> + <title>Preface</title> + + <para> + </para> +</preface> http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/src/site/docbookx/userguide/what-s-new.xml ---------------------------------------------------------------------- diff --git a/src/site/docbookx/userguide/what-s-new.xml b/src/site/docbookx/userguide/what-s-new.xml new file mode 100644 index 0000000..7d5f9d6 --- /dev/null +++ b/src/site/docbookx/userguide/what-s-new.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter version="5.0" xml:id="what-s-new" + xmlns="http://docbook.org/ns/docbook"; + xmlns:xlink="http://www.w3.org/1999/xlink"; + xmlns:xi="http://www.w3.org/2001/XInclude"; + xmlns:svg="http://www.w3.org/2000/svg"; + xmlns:m="http://www.w3.org/1998/Math/MathML"; + xmlns:html="http://www.w3.org/1999/xhtml"; + xmlns:db="http://docbook.org/ns/docbook";> +<!-- +/** + * 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. + */ +--> + <title>What is new in Apache Bigtop <?eval ${project.version}?></title> + + +</chapter> http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/src/site/resources/css/freebsd_docbook.css ---------------------------------------------------------------------- diff --git a/src/site/resources/css/freebsd_docbook.css b/src/site/resources/css/freebsd_docbook.css new file mode 100644 index 0000000..3d40fa7 --- /dev/null +++ b/src/site/resources/css/freebsd_docbook.css @@ -0,0 +1,208 @@ +/* + * Copyright (c) 2001, 2003, 2010 The FreeBSD Documentation Project + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * $FreeBSD: doc/share/misc/docbook.css,v 1.15 2010/03/20 04:15:01 hrs Exp $ + */ + +BODY ADDRESS { + line-height: 1.3; + margin: .6em 0; +} + +BODY BLOCKQUOTE { + margin-top: .75em; + line-height: 1.5; + margin-bottom: .75em; +} + +HTML BODY { + margin: 1em 8% 1em 10%; + line-height: 1.2; +} + +.LEGALNOTICE { + font-size: small; + font-variant: small-caps; +} + +BODY DIV { + margin: 0; +} + +DL { + margin: .8em 0; + line-height: 1.2; +} + +BODY FORM { + margin: .6em 0; +} + +H1, H2, H3, H4, H5, H6, +DIV.EXAMPLE P B, +.QUESTION, +DIV.TABLE P B, +DIV.PROCEDURE P B { + color: #990000; +} + +BODY H1, BODY H2, BODY H3, BODY H4, BODY H5, BODY H6 { + line-height: 1.3; + margin-left: 0; +} + +BODY H1, BODY H2 { + margin: .8em 0 0 -4%; +} + +BODY H3, BODY H4 { + margin: .8em 0 0 -3%; +} + +BODY H5 { + margin: .8em 0 0 -2%; +} + +BODY H6 { + margin: .8em 0 0 -1%; +} + +BODY HR { + margin: .6em; + border-width: 0 0 1px 0; + border-style: solid; + border-color: #cecece; +} + +BODY IMG.NAVHEADER { + margin: 0 0 0 -4%; +} + +OL { + margin: 0 0 0 5%; + line-height: 1.2; +} + +BODY PRE { + margin: .75em 0; + line-height: 1.0; + font-family: monospace; +} + +BODY TD, BODY TH { + line-height: 1.2; +} + +UL, BODY DIR, BODY MENU { + margin: 0 0 0 5%; + line-height: 1.2; +} + +HTML { + margin: 0; + padding: 0; +} + +BODY P B.APPLICATION { + color: #000000; +} + +.FILENAME { + color: #007a00; +} + +.GUIMENU, .GUIMENUITEM, .GUISUBMENU, +.GUILABEL, .INTERFACE, +.SHORTCUT, .SHORTCUT .KEYCAP { + font-weight: bold; +} + +.GUIBUTTON { + background-color: #CFCFCF; + padding: 2px; +} + +.ACCEL { + background-color: #F0F0F0; + text-decoration: underline; +} + +.SCREEN { + padding: 1ex; +} + +.PROGRAMLISTING { + padding: 1ex; + background-color: #eee; + border: 1px solid #ccc; +} + +@media screen { /* hide from IE3 */ + a[href]:hover { background: #ffa } +} + +BLOCKQUOTE.NOTE { + color: #222; + background: #eee; + border: 1px solid #ccc; + padding: 0.4em 0.4em; + width: 85%; +} + +BLOCKQUOTE.TIP { + color: #004F00; + background: #d8ecd6; + border: 1px solid green; + padding: 0.2em 2em; + width: 85%; +} + +BLOCKQUOTE.IMPORTANT { + font-style:italic; + border: 1px solid #a00; + border-left: 12px solid #c00; + padding: 0.1em 1em; +} + +BLOCKQUOTE.WARNING { + color: #9F1313; + background: #f8e8e8; + border: 1px solid #e59595; + padding: 0.2em 2em; + width: 85%; +} + +.EXAMPLE { + background: #fefde6; + border: 1px solid #f1bb16; + margin: 1em 0; + padding: 0.2em 2em; + width: 90%; +} + +.INFORMALTABLE TABLE.CALSTABLE TR TD { + padding-left: 1em; + padding-right: 1em; +} http://git-wip-us.apache.org/repos/asf/bigtop/blob/9b4ac71a/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 44fd16b..6afb2a0 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -56,11 +56,12 @@ <links position="left"> </links> - <menu name="Bigtop"> + <menu name="Apache Bigtop"> <item name="Overview" href="index.html"/> <item name="Power by" href="https://cwiki.apache.org/confluence/display/BIGTOP/Powered+By+Bigtop"; /> <item name="Who We Are" href="team-list.html" /> <item name="Feedback" href="issue-tracking.html" /> + <item name="User Guide" href="book/apache-bigtop-user-guide/apache-bigtop-user-guide.html" /> </menu> <menu name="Releases">
