aboutsummaryrefslogtreecommitdiff
path: root/src/site
diff options
context:
space:
mode:
authorBruno Mahé <bmahe@apache.org>2013-12-08 21:39:59 -0800
committerBruno Mahé <bmahe@apache.org>2013-12-11 00:15:23 -0800
commit9b4ac71a96ec04c4a956faad3d787b21b9728738 (patch)
treee5e30bfda3bc16f5add18d1d4e839d7b8a04b3a5 /src/site
parentd83362bcc5f3af6169d021e5a9966409c797f633 (diff)
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
Diffstat (limited to 'src/site')
-rw-r--r--src/site/docbookx/apache-bigtop-user-guide.xml85
-rw-r--r--src/site/docbookx/customization.xsl33
-rw-r--r--src/site/docbookx/userguide/introduction.xml32
-rw-r--r--src/site/docbookx/userguide/preface.xml28
-rw-r--r--src/site/docbookx/userguide/what-s-new.xml32
-rw-r--r--src/site/resources/css/freebsd_docbook.css208
-rw-r--r--src/site/site.xml3
7 files changed, 420 insertions, 1 deletions
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 00000000..f82c4fb6
--- /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>
diff --git a/src/site/docbookx/customization.xsl b/src/site/docbookx/customization.xsl
new file mode 100644
index 00000000..3301251c
--- /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>
diff --git a/src/site/docbookx/userguide/introduction.xml b/src/site/docbookx/userguide/introduction.xml
new file mode 100644
index 00000000..f949f170
--- /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>
diff --git a/src/site/docbookx/userguide/preface.xml b/src/site/docbookx/userguide/preface.xml
new file mode 100644
index 00000000..86dce600
--- /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>
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 00000000..7d5f9d66
--- /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>
diff --git a/src/site/resources/css/freebsd_docbook.css b/src/site/resources/css/freebsd_docbook.css
new file mode 100644
index 00000000..3d40fa70
--- /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;
+}
diff --git a/src/site/site.xml b/src/site/site.xml
index 44fd16b9..6afb2a09 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">