From e6de46ef37057ae409b4eb892fd8b4e3340cc344 Mon Sep 17 00:00:00 2001 From: Michael Stack Date: Tue, 8 Jun 2010 08:16:12 +0000 Subject: [PATCH] HBASE-2558 [mvn] Our javadoc overview -- 'Getting Started', requirements, etc. -- is not carried across by mvn javadoc:javadoc target git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@952565 13f79535-47bb-0310-9956-ffa450edef68 --- CHANGES.txt | 4 +- pom.xml | 10 +- src/assembly/bin.xml | 11 + src/docs/forrest.properties | 104 ------ src/docs/src/documentation/README.txt | 7 - .../classes/CatalogManager.properties | 37 -- .../src/documentation/content/xdocs/index.xml | 40 -- .../src/documentation/content/xdocs/site.xml | 76 ---- .../src/documentation/content/xdocs/tabs.xml | 35 -- src/docs/src/documentation/skinconf.xml | 345 ------------------ src/docs/status.xml | 74 ---- src/site/resources/css/site.css | 109 ++++++ .../resources/images/architecture.gif | Bin src/site/resources/images/asf_logo_wide.png | Bin 0 -> 7090 bytes .../resources/images/favicon.ico | Bin .../resources/images/hadoop-logo.jpg | Bin .../resources/images/hbase_logo_med.gif | Bin .../resources/images/hbase_small.gif | Bin src/site/site.xml | 46 +++ .../xdocs => site/xdoc}/acid-semantics.xml | 46 +-- .../xdocs => site/xdoc}/bulk-loads.xml | 43 +-- .../content/xdocs => site/xdoc}/cygwin.xml | 48 +-- src/site/xdoc/index.xml | 50 +++ .../content/xdocs => site/xdoc}/metrics.xml | 33 +- 24 files changed, 292 insertions(+), 826 deletions(-) delete mode 100644 src/docs/forrest.properties delete mode 100644 src/docs/src/documentation/README.txt delete mode 100644 src/docs/src/documentation/classes/CatalogManager.properties delete mode 100644 src/docs/src/documentation/content/xdocs/index.xml delete mode 100644 src/docs/src/documentation/content/xdocs/site.xml delete mode 100644 src/docs/src/documentation/content/xdocs/tabs.xml delete mode 100644 src/docs/src/documentation/skinconf.xml delete mode 100644 src/docs/status.xml create mode 100644 src/site/resources/css/site.css rename src/{docs/src/documentation => site}/resources/images/architecture.gif (100%) create mode 100644 src/site/resources/images/asf_logo_wide.png rename src/{docs/src/documentation => site}/resources/images/favicon.ico (100%) rename src/{docs/src/documentation => site}/resources/images/hadoop-logo.jpg (100%) rename src/{docs/src/documentation => site}/resources/images/hbase_logo_med.gif (100%) rename src/{docs/src/documentation => site}/resources/images/hbase_small.gif (100%) create mode 100644 src/site/site.xml rename src/{docs/src/documentation/content/xdocs => site/xdoc}/acid-semantics.xml (92%) rename src/{docs/src/documentation/content/xdocs => site/xdoc}/bulk-loads.xml (88%) rename src/{docs/src/documentation/content/xdocs => site/xdoc}/cygwin.xml (96%) create mode 100644 src/site/xdoc/index.xml rename src/{docs/src/documentation/content/xdocs => site/xdoc}/metrics.xml (90%) diff --git a/CHANGES.txt b/CHANGES.txt index a01dfa925b3..002d869dd78 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -672,7 +672,9 @@ Release 0.21.0 - Unreleased HBASE-2651 Allow alternate column separators to be specified for ImportTsv HBASE-2661 Add test case for row atomicity guarantee HBASE-2578 Add ability for tests to override server-side timestamp - setting (currentTimeMillis) (Daniel Ploeg via Ryan Rawson) + setting (currentTimeMillis) (Daniel Ploeg via Ryan Rawson) + HBASE-2558 Our javadoc overview -- "Getting Started", requirements, etc. -- + is not carried across by mvn javadoc:javadoc target NEW FEATURES HBASE-1961 HBase EC2 scripts diff --git a/pom.xml b/pom.xml index d05bfac68f3..bda5ff3b614 100644 --- a/pom.xml +++ b/pom.xml @@ -7,7 +7,8 @@ jar 0.21.0-SNAPSHOT HBase - HBase is the Hadoop database. Use it when you need random, realtime read/write access to your Big Data. + + HBase is the &lt;a href="http://hadoop.apache.org"&rt;Hadoop</a&rt; database. Use it when you need random, realtime read/write access to your Big Data. This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters of commodity hardware. @@ -22,6 +23,11 @@ + + Apache Software Foundation + http://www.apache.org + + scm:svn:http://svn.apache.org/repos/asf/hbase/trunk scm:svn:https://svn.apache.org/repos/asf/hbase/trunk @@ -881,10 +887,12 @@ maven-surefire-report-plugin 2.5 + org.apache.rat apache-rat-plugin diff --git a/src/assembly/bin.xml b/src/assembly/bin.xml index a1964c79b1a..95227c9858b 100644 --- a/src/assembly/bin.xml +++ b/src/assembly/bin.xml @@ -40,6 +40,17 @@ **/*.jsp + + target/site + docs + + + src/main/resources/ + conf + + hbase-default.xml + + diff --git a/src/docs/forrest.properties b/src/docs/forrest.properties deleted file mode 100644 index 3a0752828fa..00000000000 --- a/src/docs/forrest.properties +++ /dev/null @@ -1,104 +0,0 @@ -# Copyright 2002-2004 The Apache Software Foundation -# -# Licensed 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. - -############## -# Properties used by forrest.build.xml for building the website -# These are the defaults, un-comment them if you need to change them. -############## - -# Prints out a summary of Forrest settings for this project -#forrest.echo=true - -# Project name (used to name .war file) -#project.name=my-project - -# Specifies name of Forrest skin to use -#project.skin=tigris -#project.skin=pelt - -# comma separated list, file:// is supported -#forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml - -############## -# behavioural properties -#project.menu-scheme=tab_attributes -#project.menu-scheme=directories - -############## -# layout properties - -# Properties that can be set to override the default locations -# -# Parent properties must be set. This usually means uncommenting -# project.content-dir if any other property using it is uncommented - -#project.status=status.xml -#project.content-dir=src/documentation -#project.raw-content-dir=${project.content-dir}/content -#project.conf-dir=${project.content-dir}/conf -#project.sitemap-dir=${project.content-dir} -#project.xdocs-dir=${project.content-dir}/content/xdocs -#project.resources-dir=${project.content-dir}/resources -#project.stylesheets-dir=${project.resources-dir}/stylesheets -#project.images-dir=${project.resources-dir}/images -#project.schema-dir=${project.resources-dir}/schema -#project.skins-dir=${project.content-dir}/skins -#project.skinconf=${project.content-dir}/skinconf.xml -#project.lib-dir=${project.content-dir}/lib -#project.classes-dir=${project.content-dir}/classes -#project.translations-dir=${project.content-dir}/translations - -############## -# validation properties - -# This set of properties determine if validation is performed -# Values are inherited unless overridden. -# e.g. if forrest.validate=false then all others are false unless set to true. -forrest.validate=false -#forrest.validate.xdocs=${forrest.validate} -#forrest.validate.skinconf=${forrest.validate} -#forrest.validate.sitemap=${forrest.validate} -#forrest.validate.stylesheets=${forrest.validate} -#forrest.validate.skins=${forrest.validate} -#forrest.validate.skins.stylesheets=${forrest.validate.skins} - -# *.failonerror=(true|false) - stop when an XML file is invalid -#forrest.validate.failonerror=true - -# *.excludes=(pattern) - comma-separated list of path patterns to not validate -# e.g. -#forrest.validate.xdocs.excludes=samples/subdir/**, samples/faq.xml -#forrest.validate.xdocs.excludes= - - -############## -# General Forrest properties - -# The URL to start crawling from -#project.start-uri=linkmap.html -# Set logging level for messages printed to the console -# (DEBUG, INFO, WARN, ERROR, FATAL_ERROR) -#project.debuglevel=ERROR -# Max memory to allocate to Java -#forrest.maxmemory=64m -# Any other arguments to pass to the JVM. For example, to run on an X-less -# server, set to -Djava.awt.headless=true -#forrest.jvmargs= -# The bugtracking URL - the issue number will be appended -#project.bugtracking-url=http://issues.apache.org/bugzilla/show_bug.cgi?id= -#project.bugtracking-url=http://issues.apache.org/jira/browse/ -# The issues list as rss -#project.issues-rss-url= -#I18n Property only works for the "forrest run" target. -#project.i18n=true diff --git a/src/docs/src/documentation/README.txt b/src/docs/src/documentation/README.txt deleted file mode 100644 index 9bc261b2f15..00000000000 --- a/src/docs/src/documentation/README.txt +++ /dev/null @@ -1,7 +0,0 @@ -This is the base documentation directory. - -skinconf.xml # This file customizes Forrest for your project. In it, you - # tell forrest the project name, logo, copyright info, etc - -sitemap.xmap # Optional. This sitemap is consulted before all core sitemaps. - # See http://forrest.apache.org/docs/project-sitemap.html diff --git a/src/docs/src/documentation/classes/CatalogManager.properties b/src/docs/src/documentation/classes/CatalogManager.properties deleted file mode 100644 index ac060b9a7aa..00000000000 --- a/src/docs/src/documentation/classes/CatalogManager.properties +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2002-2004 The Apache Software Foundation -# -# Licensed 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. - -#======================================================================= -# CatalogManager.properties -# -# This is the default properties file for Apache Forrest. -# This facilitates local configuration of application-specific catalogs. -# -# See the Apache Forrest documentation: -# http://forrest.apache.org/docs/your-project.html -# http://forrest.apache.org/docs/validation.html - -# verbosity ... level of messages for status/debug -# See forrest/src/core/context/WEB-INF/cocoon.xconf - -# catalogs ... list of additional catalogs to load -# (Note that Apache Forrest will automatically load its own default catalog -# from src/core/context/resources/schema/catalog.xcat) -# use full pathnames -# pathname separator is always semi-colon (;) regardless of operating system -# directory separator is always slash (/) regardless of operating system -# -#catalogs=/home/me/forrest/my-site/src/documentation/resources/schema/catalog.xcat -catalogs= - diff --git a/src/docs/src/documentation/content/xdocs/index.xml b/src/docs/src/documentation/content/xdocs/index.xml deleted file mode 100644 index 2b25a897a8a..00000000000 --- a/src/docs/src/documentation/content/xdocs/index.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - -
- HBase Documentation -
- - -

- The following documents provide concepts and procedures that will help you - get started using HBase. If you have more questions, you can ask the - mailing list or browse the archives. -

- - - - diff --git a/src/docs/src/documentation/content/xdocs/site.xml b/src/docs/src/documentation/content/xdocs/site.xml deleted file mode 100644 index 6a42647fc8f..00000000000 --- a/src/docs/src/documentation/content/xdocs/site.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/docs/src/documentation/content/xdocs/tabs.xml b/src/docs/src/documentation/content/xdocs/tabs.xml deleted file mode 100644 index 5af2a23142c..00000000000 --- a/src/docs/src/documentation/content/xdocs/tabs.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - diff --git a/src/docs/src/documentation/skinconf.xml b/src/docs/src/documentation/skinconf.xml deleted file mode 100644 index 04a8ce8ba10..00000000000 --- a/src/docs/src/documentation/skinconf.xml +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - true - - false - - true - - true - - - true - - - true - - - true - - - false - - - true - - - HBase - The Hadoop database - http://hadoop.apache.org/hbase/ - images/hbase_small.gif - - - Hadoop - Apache Hadoop - http://hadoop.apache.org/ - images/hadoop-logo.jpg - - - - - - - images/favicon.ico - - - 2009 - The Apache Software Foundation. - http://www.apache.org/licenses/ - - - - - - - - - - - - - - - - - - - p.quote { - margin-left: 2em; - padding: .5em; - background-color: #f0f0f0; - font-family: monospace; - } - - - - - - - - - - - - - - - - - - - - - - - - - 1in - 1in - 1.25in - 1in - - - - false - - - false - - - - - - Built with Apache Forrest - http://forrest.apache.org/ - images/built-with-forrest-button.png - 88 - 31 - - - - - - diff --git a/src/docs/status.xml b/src/docs/status.xml deleted file mode 100644 index 3ac3fda4098..00000000000 --- a/src/docs/status.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - - Initial Import - - - - - - - - - Customize this template project with your project's details. This - TODO list is generated from 'status.xml'. - - - Add lots of content. XML content goes in - src/documentation/content/xdocs, or wherever the - ${project.xdocs-dir} property (set in - forrest.properties) points. - - - Mail forrest-dev@xml.apache.org - with feedback. - - - - - - diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css new file mode 100644 index 00000000000..a88f052e773 --- /dev/null +++ b/src/site/resources/css/site.css @@ -0,0 +1,109 @@ +/* + * 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. + */ + +a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover { + background: none; + padding-right: 0; +} + +/* +body ul { + list-style-type: square; +} +*/ + +#downloadbox { + float: right; + margin: 0 10px 20px 20px; + padding: 5px; + border: 1px solid #999; + background-color: #eee; +} + +#downloadbox h5 { + color: #000; + margin: 0; + border-bottom: 1px solid #aaaaaa; + font-size: smaller; + padding: 0; +} + +#downloadbox p { + margin-top: 1em; + margin-bottom: 0; +} + +#downloadbox ul { + margin-top: 0; + margin-bottom: 1em; + list-style-type: disc; +} + +#downloadbox li { + font-size: smaller; +} + +/* +h4 { + padding: 0; + border: none; + color: #000; + margin: 0; + font-size: larger; + font-weight: bold; +} +*/ + +#banner { + background: none; +} + +#banner img { + margin: 10px; +} + +.frontpagebox { + float: left; + text-align: center; + width: 15em; + margin-left: 0.5em; + margin-right: 0.5em; + margin-top: 2em; +} + +.headline { + font-size: 120%; + font-weight: bold; + padding-top: 1px; + padding-bottom: 5px; + background-image: url(../images/breadcrumbs.jpg); + background-repeat: repeat-x; +} + +/* +#leftColumn { + display: none !important +} + +#bodyColumn { + margin-left: 1.5em; +} +*/ + + diff --git a/src/docs/src/documentation/resources/images/architecture.gif b/src/site/resources/images/architecture.gif similarity index 100% rename from src/docs/src/documentation/resources/images/architecture.gif rename to src/site/resources/images/architecture.gif diff --git a/src/site/resources/images/asf_logo_wide.png b/src/site/resources/images/asf_logo_wide.png new file mode 100644 index 0000000000000000000000000000000000000000..c584ebad9b419ddfa86bff74701dbd5ae8f27fd8 GIT binary patch literal 7090 zcmXwecU;oz`~DjcP(%a=iYrA$a1S&yEy#@{#BF9cFg43@(j3)cxN_w{BelXoscE5U zY3VsQDp#fE%Em{{EX&H4?Q_1I*X#HD>luH%U-$jo*YjN0b-z#1eccrh8VCRY6g)j# z7ytmqN#{1QkpFfPUrVHe%t5LT6#%Y|Y=;)EOV_xgt|3SLlVXn^i%ew!)R?3wmagaF z$b&2fD>5cCWt8Oz03bHqJHXY(#^&kMr&m~s4CKkL39b`xm(|tPckkZC$=ZE-ua^LAI?_E$( z&{>$a2-{V3#BRTro&&0^uQBQ_we=Jgx3;#n zHKm?Cdv@z(#Mc6!u0I^F(L(-~^Xi5e9XodHBHXAmh-?bADGeaIxVXf|#-6IXSoWvG zjH$(Uto6NN@4-7GGbxVu8MgOsU!Mn=b|U;n!GsrpSzusbUe&p8faTomWSz2Mi_>lq zXxn9M)?J8wC7f_qn-~_K+zocDks)7^j5NU9?-o*0PUiUTi%!fqsSMIsUtjM>6W*_` zy7+}Y9UuRzvo;(Tw9n%3qLRrpE}c_aWemvuVHGXz6%{Q5VFOXj$}5*IUyE|Vv?1nOzfKp80&1FLi(kAmPk!mSD9a0r^BU)(pa z6Ml>y+zN>T`^)o)7n4RxkQtX)y%L z7pu1u`?Cn!x0lLBqof(rm8n$BS8ELO(Q>T?fe^ZUW`DDH<{0pJEJD${CWvAroGC9` z4GX3{=YzI(@LIaMR8eLPXd|v9*#kEWW&_;fgUMFbuc@7-tw!R{YpKOsopK#=Q`3xG&m&dxg%sz*`Q?c*EE&ywUO0Y#(Yr)v)%bw7vV~E zvtrjAE|!2%3zZOCH`horhFeH>shTNwnHZOS8q=y#E3Zp}7!K6i1J7b(;8tjG)?Co} zEZM(7wyz}8Gt(I%Fdv@6Eay8Eq`S!T_bblyRjjq&)sO%n8O`;mgP%LNcVu`(HO+lT z-3o%cf=^(#UC2S?7Zz$BBZ{9a#a30lK&gOcjU}tgZ{HrNzVQAo-^Ftb_=AFi-}F;8 z?B{9R5ebopOGZ%BWit)=0gu=L)L(awAe6;!fv6HgL07Aen?4wOdPA3#zE>r;;E8ET zT&bnx$qTun8HU(Oy_7pF3vt1ut1+99WVmGf&x||p%lR&9kg#hyHP&rQ;r=swZn@)3hMRE?* z@H^e1PnsF3vTmxM)!J#AuC9l=ovgC3V^VN;8T^^gc?WEeAfkJw`}1vBY*nTgE=!gQ z+sc|iLu7TErc#(yQ3_{hDn2q7OMV2LB+(ZE0*cu?u)K!F!c6UAemir_7*u6?Zx;6K(qPA5Nf5pDA)lbVXY={}lzxNsj4;#O>f0Xe+g;?lR2s%Ks?FLXZ_>4(r(H~7@lVW~-A6wN zP?CsR3a}9nX0!Im+Df@s3c}w+Q{!bI2Oi zkdmvu3S7VD-5#KaaDBrBonE9_xO&*I^CNJRHQ5^;LpX{06t(4V^<)v!-@_pQI1ZXTDA<3vDF?eqDx9I=*Lqypg{LVt%oE_(9R&s77CnPJYHnY8VNyPS zhUKn3pL=_^zUiO3jtYur7^^o`%x-z;&-YBn-Bam0f2r9v%7cfAM46I1E+YMst05Ig zp&;g9zUtxT(mgs(lILLlqRc~(y+784=O@|K=gaywlH?fkU(=r2m0k8^!MAhx4BepET)7;IE+)H-TKD7 zz~Lh7nmFaw!jt)|y$A-(zOl9%zgX?kgiQ90CPQBY>U!;k8*|o(N{l@6nn30|3F43? zjet5PrQOebj9U9zRXz6H2tBOOLrWON3#Ar>fPV1w9G9Q7^vRWJI4zrdk*+Vkgehp&zS zZy~}Rh#lbMn}8XM=>W_H4V<;MT*Qg5V9xU+p$~^psuV>lHn3+eZdXEron7y#DZQzw ztm2km2yDSHsLhA%3h(*FgxNZLYr<3R`Au4e=!$E>iRF3R#m3mB`)x_0UXK5H#`$wi zP1i1nSdo#b;i;X9QzS^;E4|9oqB1OQVtE5uP;UxbJpwfIKg77dtJVFfYfHvkaR&W%PvGByZ9jOORRjw)(-vGaHPB51IAJ+=tl-D41 zu$gd+DBgic$N;iCI;ogD^}?+rCp*?kOPaVhRqI;%h#O zsWdU%TjUd1zl&F#;GF$?+5@69CrVpjz+zm+{WS~@7!|VofK>nM_YqMT`&VU*Jkl^D z-YMh^M(dyRo7Cgd3@#zV%_)0v>L~G^biM0*5bgl4YgF~u8cuJP+7(3oy(w8A{n z_gL%X2fcXH|6~u{KW}d)|4ell-zT%!Cy#ihTr(d*PLVL+Vk*MihO!QMq66)AU{@8U zG|Pxz0e0@ZJ)D-|VQqo#aVN^qtAGB9mt1cVz{D>Ze#^B7;tia=KRIi(tU|NLlnr4b z%padA{~M5Lo4QN!W5ABbX&hdpX*BLHuyn6dYd65UGT=DpnEVdfn+^xWBRl_a<%4lP zjHB>ZdbmRA83(9*!drPRN zc#0uuvY{bDTL;Qpzg=>A%t~iq!Dm@Yw6gpvThJD(WGKA9|0$0>>LNxuPA@AQKKTtY zj-*Bu7OWL#Y+l}Vjc;n{2q<`}bRMss3o%fbX(*~YZG zL7u>33DMk8_pq?j+VS_)EV5oIlaH2Um!LAL1jJ?4XTG)Kic&8?Ii(*}ePw5}B5y9W1C+Odh^&_slnEyN`bW-=qVtj!HY<9^YnBxGrKFTVCFb&^zmbvI(zTI zkdhLA$?ZHetsk6_PGrM&G_kwoQ|afoK~@>qrZIEPyIu%h!4>)GFU(+vwy2HOCSk%`5mmP z%2Amt*4Rd7HL)LG7*_$_UkqS4&Jv z3JOpmn2g^WL)4J`qy;ZYVb>@No4`KW&7+WjTOpJ@?}6y`G!0N44J(33_quPUXeT&$U%ZJnT<3k4+t^ z`QD5Bl9D)>>T7CRRS^}{?fL}IrE6d|lk{?{9oaA7 z&7Z)Df3jaIGvBCKzXyjs1hpRh)=Rxy+~5D3ntjg2Wy08mGF!-L@8SJrf76|!mVxNxd)0nI#q|<7yNHjgiVJ|2xQ1?)p zi;E1^a~MgMtY2)v*W)D$p>hIn4Gq-o$RWuD8ny~*2{z`e zbKSM-%-K1+E}3)q18+hvA>QAAUB$(6sS80u)uZB032pC9m9A7x7(H8p^l;SvhDT^m z_T{2R$nhbp=W-DOc{2Yg4Soq9^OAFYlct~6?-xEU8}{?XsbrP7d@~*y&k{O>o(7F` zu;_iXHv#1_ZJ#sR+l4c5>Gzlh`2XKGi>hLsYhy%TgLB%=5A>6 zDRvwku?*AS&a?v8@E~(GOOX~#rSdW`7GK6N!0Mk$PELlO<=nJ1enQ0y6I?xgEB!Hi z0~L&AS?vR3^eSvsUNEd7C~foYr)i-AAdZDw($kKr2P~T@^8IWgR$J#E zD(kgDY92t^#rcOP}# zANsa@GLq=}stP-6avOW#qAo5l$6MR^oa#}K?1D#pph@C0eQ7hWfMd^+94Xw}SzMRt znyVxp1=YAiRdsX-ot-R69(Q-#X{xTt_Bc(=m?5R+^Pp}&s#!pl$}0^^Xe@LRElaEt z2H15hF$_kAhar4(@(V2rG!HL!1665B$PL7+MMf-kg-?r7{i2MPX0b;~PM^;NAJjX_ zSum8Dc)F1$n)4uV+N7wBZaWinyIoelxShWLP)YbP&_i|8FJZjkXmO)`sA4r3SAV(S zsF+L=4Uhs9%dMAi5{%Bp&`bU_7X=ct8BW` zD0~hi{4H&IT&Z8WFK^PEIeITa3z5*&%AWQ>Y}@@eTCC3L+C{B2Sqg~KgSI6~SaRgE zF=ON7qoa=si%b?%Q&S5sL*#t+?a(zede6OaE|TSH$?|BtgF#T9-P0|Zp?vCUohL!B zQ(cx>2#dI+Vjb~G@yFqIS==UV-@cZHUQ{`D;Y(Ay`jTVdp^5Z7qIZyDpIM-a*GHbg z_9nc1<_Q5QVN;l)xLax=8vJ2BVUaP)ShejlGvs5cm=>9fXhYq%CM42XxHpMPF_3Lz z#jqgbE;9GPtWaJEOHU-*+-RZ;+L-p>1pj8|-=iw{$uSSf)CCzB7?@I6r~2wdj?VG> zwTZb4V;_K>;#5h)P_?`N!)j@Z;U{i4G0-Bl5)voqCRv`*Llk5M#@}&BXW|--OWZNw zkXfq?+8JpII*%P%TZ1mnZSpzTH_aqxjhAxU=ob3F@|s{nkC849ETwmaM1o8QMt+(K zd`Uj`)wgJdY`F;~$ayihKU53o&d3JFOLc=ie3W4cMeLyW?6nUNUI@q5n`mOvGgF3u z5~^iMOjQWYR0s;BpBvH}cwiy*1FOTgZy)B6oS#iIA|jqKd?S4KpSwFZmut*|&C%u_ zYDl5f$zudm-FWs;CBAED5wS2SbKMIKmBG3exas#4+!!R<2y48knlx7oX-Fk$Omd(; zYA@~;3uf^FJ}V9S6shrik#xFXIO)hnE1;wGI_@*$Go%d^n)W(53+8g@J zEK?Q=$NltJy4^Nq*PX2J7X8=UNP)C=8uhm}tm#>fNF|Ik~ z!28fbBi82JdcDGWhyHdxM?p5;^q(!6Zkq*6RkQ7fhqD04C1DJhFHO{?H=8wHZjO^R zHRH2=+zb^r>-zt`EcJ8S-Ym-}W@k_;3btn`*X|TQ1C>nGml^s)^JAqm)}Pq};Bl--!sK*N-@H-B1w88b z>_cyjn1LYMsE-8NnK!`t8S9rwA3e9J7d9=Yv_p<6+&Zew7z2`&b8c%v#4W_axPt{; z2a!Y2g1=k8>PURwT!VV`49^#`=YuAmwb@!tt8K+=IJ6F5_*WiHS#3hbje?*jY2P&p zQ9stwqXq`Hwg~Se4$zS9Z=N)6wQRPGD({D-WH<`EF;oED>LCaT@o~6}C7VIBHY8aK ztg!>KtrrM8FcH@B3fQ=w3hpoy2Qa$QlEr~DH@@hZv)I8_gDbA8erEGk`1@THFWiXp z?yT00=5CNhRs`%Ak8W+5hi~$Lv_BxbzN_UAo++Ml#;#Z6Tju;-BXYRa){^X3n5QU% z!y7?yC!If{uXa~;6CE=q`|{PKaLOb>)(q0^;=n0WvsIre16uif{Dy#A1)G@N2;m1=3sZ0enPvJUyd+2l<K)Z*FmT1nu_KBXj!=MUic9r*ronxq3arzQcJRUHb4J#=YqBMv|3l;lLu!-dz8p8 z&j%+ay-zYCz+TV7xJtza;w&pUnDs{xz)t4&yJ{hCGxoKbfFHsX#l|V(s)w^_ zkrmvuNB*ZkAl-G6+fYv(x^UxCQ&VKip%##-@rs#( zLLJ5Cd*=O$3L4GSR72u04C(R}Km|viP>rqy5Wm-)9sZdhsNEUQE-Yu#6TZ$7D0EU8Z!^LWgHjvDtn14 zIh9xcJe%Dol6J~ONhunZ%j)Xtu|L^WMnA=;tiOMc|0yf)EVIzEa&e$zjqAsM7gShS z5pP5RtR^QsC1J1`-x8jh;aKK}?{10agM-#LA3eHhKDL-UxeFCHh7urGD6gxeZQQEOR{vQvq9{fYDerTEmJ)Neu}0A5FR6TEgto_~a}V7wQ1t Xztelm;N7P5Zw}z;>g#f450m?U5x2|H literal 0 HcmV?d00001 diff --git a/src/docs/src/documentation/resources/images/favicon.ico b/src/site/resources/images/favicon.ico similarity index 100% rename from src/docs/src/documentation/resources/images/favicon.ico rename to src/site/resources/images/favicon.ico diff --git a/src/docs/src/documentation/resources/images/hadoop-logo.jpg b/src/site/resources/images/hadoop-logo.jpg similarity index 100% rename from src/docs/src/documentation/resources/images/hadoop-logo.jpg rename to src/site/resources/images/hadoop-logo.jpg diff --git a/src/docs/src/documentation/resources/images/hbase_logo_med.gif b/src/site/resources/images/hbase_logo_med.gif similarity index 100% rename from src/docs/src/documentation/resources/images/hbase_logo_med.gif rename to src/site/resources/images/hbase_logo_med.gif diff --git a/src/docs/src/documentation/resources/images/hbase_small.gif b/src/site/resources/images/hbase_small.gif similarity index 100% rename from src/docs/src/documentation/resources/images/hbase_small.gif rename to src/site/resources/images/hbase_small.gif diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 00000000000..bbce9ea920c --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,46 @@ + + + + + HBase + http://hbase.apache.org/images/hbase_logo_med.gif + http://hbase.apache.org/ + + + http://hbase.apache.org/images/asf_logo_wide.png + http://www.apache.org/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + org.apache.maven.skins + maven-stylus-skin + + + diff --git a/src/docs/src/documentation/content/xdocs/acid-semantics.xml b/src/site/xdoc/acid-semantics.xml similarity index 92% rename from src/docs/src/documentation/content/xdocs/acid-semantics.xml rename to src/site/xdoc/acid-semantics.xml index 83bf3df05ef..a7243cb86cb 100644 --- a/src/docs/src/documentation/content/xdocs/acid-semantics.xml +++ b/src/site/xdoc/acid-semantics.xml @@ -1,6 +1,6 @@ - + - - - - - - -
+ + Bulk Loads in HBase -
+ -
- Overview +

HBase includes several methods of loading data into tables. The most straightforward method is to either use the TableOutputFormat @@ -42,13 +37,11 @@ cluster.

-
- Bulk Load Architecture +

The HBase bulk load process consists of two main steps.

- - Preparing data via a MapReduce job +

The first step of a bulk load is to generate HBase data files from a MapReduce job using HFileOutputFormat. This output format writes @@ -67,9 +60,8 @@ which automatically sets up a TotalOrderPartitioner based on the current region boundaries of a table.

- - - Completing the data load +
+

After the data has been prepared using HFileOutputFormat, it is loaded into the cluster using a command line tool. This command line tool @@ -87,10 +79,9 @@ preparing a bulk load and importing it into the cluster, especially if other clients are simultaneously loading data through other means.

- +
-
- Preparing a bulk load using the <code>importtsv</code> tool +

HBase ships with a command line tool called importtsv. This tool is available by running hadoop jar /path/to/hbase-VERSION.jar importtsv. @@ -115,8 +106,7 @@ Other options that may be specified with -D include: -Dimporttsv.skip.bad.lines=false - fail if encountering an invalid line

-
- Importing the prepared data using the <code>completebulkload</code> tool +

After a data import has been prepared using the importtsv tool, the completebulkload tool is used to import the data into the running cluster. @@ -131,8 +121,7 @@ Other options that may be specified with -D include: the cluster.

-
- Advanced Usage +

Although the importtsv tool is useful in many cases, advanced users may want to generate data programatically, or import data from other formats. To get @@ -145,4 +134,4 @@ Other options that may be specified with -D include:

- \ No newline at end of file + diff --git a/src/docs/src/documentation/content/xdocs/cygwin.xml b/src/site/xdoc/cygwin.xml similarity index 96% rename from src/docs/src/documentation/content/xdocs/cygwin.xml rename to src/site/xdoc/cygwin.xml index 5630cff3ca3..2bdce12df85 100644 --- a/src/docs/src/documentation/content/xdocs/cygwin.xml +++ b/src/site/xdoc/cygwin.xml @@ -1,6 +1,6 @@ - + - - - - -
+ + Installing HBase on Windows using Cygwin -
+ -
-Introduction +

HBase is a distributed, column-oriented store, modeled after Google's BigTable. HBase is built on top of Hadoop for its MapReduce and distributed file system implementation. All these projects are open-source and part of the Apache Software Foundation.

As being distributed, large scale platforms, the Hadoop and HBase projects mainly focus on *nix environments for production installations. However, being developed in Java, both projects are fully portable across platforms and, hence, also to the Windows operating system. For ease of development the projects rely on Cygwin to have a *nix-like environment on Windows to run the shell scripts.

-
-Purpose +

This document explains the intricacies of running HBase on Windows using Cygwin as an all-in-one single-node installation for testing and development. The HBase Overview and QuickStart guides on the other hand go a long way in explaning how to setup HBase in more complex deployment scenario's.

-
-Installation +

For running HBase on Windows, 3 technologies are required: Java, Cygwin and SSH. The following paragraphs detail the installation of each of the aforementioned technologies.

-
-Java +

HBase depends on the Java Platform, Standard Edition, 6 Release. So the target system has to be provided with at least the Java Runtime Environment (JRE); however if the system will also be used for development, the Jave Development Kit (JDK) is preferred. You can download the latest versions for both from Sun's download page. Installation is a simple GUI wizard that guides you through the process.

-
-Cygwin +

Cygwin is probably the oddest technology in this solution stack. It provides a dynamic link library that emulates most of a *nix environment on Windows. On top of that a whole bunch of the most common *nix tools are supplied. Combined, the DLL with the tools form a very *nix-alike environment on Windows.

For installation, Cygwin provides the setup.exe utility that tracks the versions of all installed components on the target system and provides the mechanism for installing or updating everything from the mirror sites of Cygwin.

@@ -80,7 +73,7 @@
  • When needed, to uninstall Cygwin you can simply delete the Root and Local Package directory, and the shortcuts that were created during installation.
    • -
    SSH +

    HBase (and Hadoop) rely on SSH for interprocess/-node communication and launching remote commands. SSH will be provisioned on the target system via Cygwin, which supports running Cygwin programs as Windows services!

      @@ -98,18 +91,15 @@
    1. Wait for the install to complete and finish the installation.
    -
    -HBase +

    Download the latest release of HBase from the website. As the HBase distributable is just a zipped archive, installation is as simple as unpacking the archive so it ends up in its final installation directory. Notice that HBase has to be installed in Cygwin and a good directory suggestion is to use /usr/local/ (or [Root directory]\usr\local in Windows slang). You should end up with a /usr/local/hbase-<version> installation in Cygwin.

    This finishes installation. We go on with the configuration.
    -
    -Configuration +

    There are 3 parts left to configure: Java, SSH and HBase itself. Following paragraphs explain eacht topic in detail.

    -
    -Java +

    One important thing to remember in shell scripting in general (i.e. *nix and Windows) is that managing, manipulating and assembling path names that contains spaces can be very hard, due to the need to escape and quote those characters and strings. So we try to stay away from spaces in path names. *nix environments can help us out here very easily by using symbolic links.

      @@ -180,8 +170,7 @@ This finishes installation. We go on with the configuration.
    -
    -HBase +
    If all previous configurations are working properly, we just need some tinkering at the HBase config files to properly resolve on Windows/Cygwin. All files and paths referenced here start from the HBase [installation directory] as working directory.
    1. HBase uses the ./conf/hbase-env.sh to configure its dependencies on the runtime environment. Copy and uncomment following lines just underneath their original, change them to fit your environemnt. They should read something like: @@ -244,8 +233,7 @@ put 'test', 'row3', 'data:3', 'value3'

    -
    -Conclusion +

    Now your HBase server is running, start coding and build that next killer app on this particular, but scalable datastore!

    diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml new file mode 100644 index 00000000000..13c663b5532 --- /dev/null +++ b/src/site/xdoc/index.xml @@ -0,0 +1,50 @@ + + + + + HBase Home + + + +
    +

    HBase is the Hadoop database. Use it when you need random, realtime read/write access to your Big Data. + This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters + of commodity hardware. + +

    +
    +
    +

    June 30th, HBase Contributor Workshop (Day after Hadoop Summit)

    +

    May 10th, 2010: HBase graduates from Hadoop sub-project to Apache Top Level Project

    +

    Signup for HBase User Group Meeting, HUG10 hosted by Trend Micro, April 19th, 2010

    + +

    HBase User Group Meeting, HUG9 hosted by Mozilla, March 10th, 2010

    +

    Sign up for the HBase User Group Meeting, HUG8, January 27th, 2010 at StumbleUpon in SF

    +

    September 8th, 2010: HBase 0.20.0 is faster, stronger, slimmer, and sweeter tasting than any previous HBase release. Get it off the Releases page.

    +

    ApacheCon in Oakland: November 2-6th, 2009: + The Apache Foundation will be celebrating its 10th anniversary in beautiful Oakland by the Bay. Lots of good talks and meetups including an HBase presentation by a couple of the lads.

    +

    HBase at Hadoop World in NYC: October 2nd, 2009: A few of us will be talking on Practical HBase out east at Hadoop World: NYC.

    +

    HUG7 and HBase Hackathon: August 7th-9th, 2009 at StumbleUpon in SF: Sign up for the HBase User Group Meeting, HUG7 or for the Hackathon or for both (all are welcome!).

    +

    June, 2009 -- HBase at HadoopSummit2009 and at NOSQL: See the presentations

    +

    March 3rd, 2009 -- HUG6: HBase User Group 6

    +

    January 30th, 2009 -- LA Hbackathon:HBase January Hackathon Los Angeles at Streamy in Manhattan Beach

    +
    + + +     diff --git a/src/docs/src/documentation/content/xdocs/metrics.xml b/src/site/xdoc/metrics.xml similarity index 90% rename from src/docs/src/documentation/content/xdocs/metrics.xml rename to src/site/xdoc/metrics.xml index 83389e1ef94..89e0db72da4 100644 --- a/src/docs/src/documentation/content/xdocs/metrics.xml +++ b/src/site/xdoc/metrics.xml @@ -1,6 +1,6 @@ - + - - - - - - -
    + + HBase Metrics -
    + -
    - Introduction +

    HBase emits Hadoop metrics.

    @@ -64,16 +59,14 @@

    -
    - Using with JMX +

    In addition to the standard output contexts supported by the Hadoop metrics package, you can also export HBase metrics via Java Management Extensions (JMX). This will allow viewing HBase stats in JConsole or any other JMX client.

    -
    - Enable HBase stats collection +

    To enable JMX support in HBase, first edit $HBASE_HOME/conf/hadoop-metrics.properties to support @@ -95,8 +88,7 @@ rpc.class=org.apache.hadoop.metrics.spi.NullContextWithUpdateThread rpc.period=60

    -
    - Setup JMX remote access +

    For remote access, you will need to configure JMX remote passwords and access profiles. Create the files: @@ -120,8 +112,7 @@ controlRole readwrite

    -
    - Configure JMX in HBase startup +

    Finally, edit the $HBASE_HOME/conf/hbase-env.sh script to add JMX support: