You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bigtop.apache.org by ja...@apache.org on 2014/08/02 19:51:40 UTC
git commit: BIGTOP-1391: improve README.md markdown formatting
Repository: bigtop
Updated Branches:
refs/heads/master 0025ca395 -> e0bbd3def
BIGTOP-1391: improve README.md markdown formatting
Signed-off-by: jay@apache.org <jayunit100>
Project: http://git-wip-us.apache.org/repos/asf/bigtop/repo
Commit: http://git-wip-us.apache.org/repos/asf/bigtop/commit/e0bbd3de
Tree: http://git-wip-us.apache.org/repos/asf/bigtop/tree/e0bbd3de
Diff: http://git-wip-us.apache.org/repos/asf/bigtop/diff/e0bbd3de
Branch: refs/heads/master
Commit: e0bbd3defce67582c6ecf17683e6d3e43e0ffa17
Parents: 0025ca3
Author: Matt Fenwick <mf...@gmail.com>
Authored: Sat Aug 2 06:52:40 2014 -0400
Committer: jay@apache.org <jayunit100>
Committed: Sat Aug 2 13:46:17 2014 -0400
----------------------------------------------------------------------
README.md | 92 ++++++++++++++++++++++++++++++----------------------------
1 file changed, 47 insertions(+), 45 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/bigtop/blob/e0bbd3de/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index d9696b0..893de30 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,31 @@
- 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.
-------------------------------------------------------------------------------------------------------------------------------------------------------
-Apache Bigtop (http://bigtop.apache.org/)
-======
+[Apache Bigtop](http://bigtop.apache.org/)
+==========================================
-...is a project for the development of packaging and tests of the Apache Hadoop (http://hadoop.apache.org/) ecosystem.
-
-------------------------------------------------------------------------------------------------------------------------------------------------------
+...is a project for the development of packaging and tests of the [Apache Hadoop](http://hadoop.apache.org/) ecosystem.
The primary goal of Apache Bigtop is to build a community around the packaging and interoperability testing of Apache Hadoop-related projects. This includes testing at various levels (packaging, platform, runtime, upgrade, etc...) developed by a community with a focus on the system as a whole, rather than individual projects.
-Quick overview of source code for Apache Bigtop.
+Quick overview of source code directories
=========================================
* __bigtop-deploy__ : deployment scripts, puppet stuff, VM utilities for Apache Bigtop.
- * __bigtop-packages__ : RPM/DEB specifications for Apache Bigtop subcomponents
+* __bigtop-packages__ : RPM/DEB specifications for Apache Bigtop subcomponents
* __bigtop-test-framework__ : The source code for the iTest utilities (framework used by smoke tests).
* __bigtop-tests__ :
* __test-artifacts__ : source for tests.
@@ -40,23 +37,23 @@ Also, there is a new project underway, Apache Bigtop blueprints, which aims to c
Contributing
============
- There are lots of ways to contribute, people with different expertise can help with various subprojects:
+There are lots of ways to contribute. People with different expertise can help with various subprojects:
-* __puppet__ : Much of the Apache Bigtop deploy and pacakging tools use puppet to bootstrap and setup a cluster. But recipes for other tools are also welcome (ie. Chef, Ansible, etc.)
+* __puppet__ : Much of the Apache Bigtop deploy and pacakging tools use puppet to bootstrap and set up a cluster. But recipes for other tools are also welcome (ie. Chef, Ansible, etc.)
* __groovy__ : Primary language used to write the Apache Bigtop smokes and itest framework.
* __maven__ : Used to build Apache Bigtop smokes and also to define the high level Apache Bigtop project.
* __RPM/DEB__ : Used to package Apache Hadoop ecosystem related projects into GNU/Linux installable packages for most popular GNU/Linux distributions. So one could add a new project or improve existing packages.
* __hadoop__ : Apache Hadoop users can also contribute by using the Apache Bigtop smokes, improving them, and evaluating their breadth.
-* __contributing your worloads__ : Contributing your workloads enable us to tests projects against real use cases and enable you to have people verifying the use cases you care about are always working
+* __contributing your workloads__ : Contributing your workloads enable us to tests projects against real use cases and enable you to have people verifying the use cases you care about are always working.
* __documentation__ : We are always in need of a better documentation!
-* __giving feedback__ : Tell us how you use Apache Bigtop, what was great and what was not so great. Also what are you expecting from it and what would you like to see in the future?
+* __giving feedback__ : Tell us how you use Apache Bigtop, what was great and what was not so great. Also, what are you expecting from it and what would you like to see in the future?
- Also opening JIRA's https://issues.apache.org/jira/browse/BIGTOP and getting started by posting on the mailing list is helpful.
+Also, opening [JIRA's](https://issues.apache.org/jira/browse/BIGTOP) and getting started by posting on the mailing list is helpful.
-What to people use Apache Bigtop for?
+What do people use Apache Bigtop for?
==============================
-You can go to the Apache Bigtop website : http://bigtop.apache.org/ for notes on how to do "common" tasks like
+You can go to the [Apache Bigtop website](http://bigtop.apache.org/) for notes on how to do "common" tasks like:
* Apache Hadoop App developers: Download an Apache Bigtop built Apache Hadoop 2.0 VM from the website, so you can have a running psuedodistributed Apache Hadoop cluster to test your code on.
* Cluster administers or deployment gurus: Run the Apache Bigtop smoke tests to ensure that your cluster is working.
@@ -66,7 +63,7 @@ Getting Started
===============
Below are some recipes for getting started with using Apache Bigtop. As Apache Bigtop has different subprojects, these recipes will continue to evolve.
-For specific questions its always a good idea to ping the mailing list at dev-subscribe@bigtop.apache.org to get some immediate feedback, or open a JIRA : https://issues.apache.org/jira/browse/BIGTOP
+For specific questions it's always a good idea to ping the mailing list at dev-subscribe@bigtop.apache.org to get some immediate feedback, or [open a JIRA](https://issues.apache.org/jira/browse/BIGTOP).
For Users: Running the tests
----------------------------
@@ -78,17 +75,23 @@ WARNING: since testing packages requires installing them on a live system it is
*... and so on.*
* Step 1: Build the smokes with snapshots. This ensures that all transitive dependencies etc.. are in your repo
- * mvn clean install -DskipTests -DskipITs -DperformRelease -f ./bigtop-test-framework/pom.xml
- * mvn clean install -DskipTests -DskipITs -DperformRelease -f ./test-artifacts/pom.xml
+
+ mvn clean install -DskipTests -DskipITs -DperformRelease -f ./bigtop-test-framework/pom.xml
+ mvn clean install -DskipTests -DskipITs -DperformRelease -f ./test-artifacts/pom.xml
+
* Step 2: Now, rebuild in "offline" mode. This will make sure that your local changes to bigtop are embeded in the changes.
- * mvn clean install -DskipTests -DskipITs -DperformRelease -o -nsu -f ./bigtop-test-framework/pom.xml
- * mvn clean install -DskipTests -DskipITs -DperformRelease -o -nsu -f ./bigtop-tests/test-artifacts/pom.xml
+
+ mvn clean install -DskipTests -DskipITs -DperformRelease -o -nsu -f ./bigtop-test-framework/pom.xml
+ mvn clean install -DskipTests -DskipITs -DperformRelease -o -nsu -f ./bigtop-tests/test-artifacts/pom.xml
* Step 3: Now, you can run the smoke tests on your cluster.
* Example 1: Running all the smoke tests with TRACE level logging (shows std out from each mr job).
- * mvn clean verify -Dorg.apache.bigtop.itest.log4j.level=TRACE -f ./bigtop/bigtop-tests/test-execution/smokes/pom.xml
+
+ mvn clean verify -Dorg.apache.bigtop.itest.log4j.level=TRACE -f ./bigtop/bigtop-tests/test-execution/smokes/pom.xml
+
* Just running hadoop examples, nothing else.
- * mvn clean verify -D'org.apache.maven-failsafe-plugin.testInclude=**/*TestHadoopExamples*' -f bigtop-tests/test-execution/smokes/package/pom.xml
+
+ mvn clean verify -D'org.apache.maven-failsafe-plugin.testInclude=**/*TestHadoopExamples*' -f bigtop-tests/test-execution/smokes/package/pom.xml
Note: A minor bug/issue: you need the "testInclude" regular expression above, even if you don't want to customize the tests,
since existing test names don't follow the maven integration test naming convention of IT*, but instead, follow the surefire (unit test) convention of Test*.
@@ -96,11 +99,11 @@ WARNING: since testing packages requires installing them on a live system it is
For Users: Creating Your Own Apache Hadoop Environment
-----------------------------------------------
- Another common use case for Apache Bigtop is creating / setting up your own Apache Hadoop distribution.
- For details on this, check out the bigtop-deploy/README.md file, which describes how to use the puppet repos
- to create and setup your VMs.
- There is a current effort underway to create vagrant/docker recipes as well, which will be contained in the
- bigtop-deploy/ package.
+Another common use case for Apache Bigtop is creating / setting up your own Apache Hadoop distribution.
+For details on this, check out the bigtop-deploy/README.md file, which describes how to use the puppet repos
+to create and setup your VMs.
+There is a current effort underway to create vagrant/docker recipes as well, which will be contained in the
+bigtop-deploy/ package.
For Developers: Building the entire distribution from scratch
@@ -118,8 +121,8 @@ __On all systems, Building Apache Bigtop requires the following tools__
* __Debian__ based distros need these packages : build-essential dh-make debhelper devscripts, reprepro
* __openSUSE 11.4__ needs these packages : relaxngDatatypedocbook-utils docbook-simple, asciidoc, fuse-devel, docbook5, docbook5-xsl-stylesheets, libxml2-devel, xmlformat, xmlto, libxslt, libopenssl-devel
-* __Building packages__ : make [component-name]-[rpm|deb]
-* __Building local YUM/APT repositories__ : make [component-name]-[yum|apt]
+* __Building packages__ : `make [component-name]-[rpm|deb]`
+* __Building local YUM/APT repositories__ : `make [component-name]-[yum|apt]`
For Developers: Building and modifying the web site
@@ -131,11 +134,10 @@ project. The main page can be accessed from "project_root/target/site/index.htm
The source for the website is located in "project_root/src/site/".
-----------------------
-Contact us
-----------------------
+Contact us
+----------
- You can get in touch with us on the Apache Bigtop mailing lists (http://bigtop.apache.org/mail-lists.html).
+You can get in touch with us on [the Apache Bigtop mailing lists](http://bigtop.apache.org/mail-lists.html).