http://git-wip-us.apache.org/repos/asf/hbase/blob/cb77a925/src/main/asciidoc/hbase.css ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/hbase.css b/src/main/asciidoc/hbase.css new file mode 100644 index 0000000..68d418b --- /dev/null +++ b/src/main/asciidoc/hbase.css @@ -0,0 +1,400 @@ +/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ +/* Remove the comments around the @import statement below when using this as a custom stylesheet */ +/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} +audio,canvas,video{display:inline-block} +audio:not([controls]){display:none;height:0} +[hidden],template{display:none} +script{display:none!important} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +body{margin:0} +a{background:transparent} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +dfn{font-style:italic} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} +input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +#map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +.antialiased,body{-webkit-font-smoothing:antialiased} +img{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:none} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#990000;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ul.no-bullet{list-style:none} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite:before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7;font-weight:bold} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} +.clearfix:after,.float-group:after{clear:both} +*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} +pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} +.keyseq{color:rgba(51,51,51,.8)} +kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menu{color:rgba(0,0,0,.8)} +b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} +b.button:before{content:"[";padding:0 3px 0 2px} +b.button:after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} +#header:after,#content:after,#footnotes:after,#footer:after{clear:both} +#content{margin-top:1.25em} +#content:before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} +#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span:before{content:"\00a0\2013\00a0"} +#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark:before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber:after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +@media only screen and (min-width:768px){#toctitle{font-size:1.375em} +body.toc2{padding-left:15em;padding-right:0} +#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{width:20em} +#toc.toc2 #toctitle{font-size:1.375em} +#toc.toc2>ul{font-size:.95em} +#toc.toc2 ul ul{padding-left:1.25em} +body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +#content #toc>:first-child{margin-top:0} +#content #toc>:last-child{margin-bottom:0} +#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} +#footer-text,#footer_nav{color:rgba(255,255,255,.8);line-height:1.44} +#footer a{color: #990000} +.sect1{padding-bottom:.625em} +@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#990000;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} +.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} +.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.listingblock>.content{position:relative} +.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]:before{display:block} +.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} +table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} +table.pyhltable td.code{padding-left:.75em;padding-right:0} +pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} +pre.pygments .lineno{display:inline-block;margin-right:.25em} +table.pyhltable .linenodiv{background:none!important;padding-right:0!important} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} +.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} +.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} +.quoteblock .quoteblock blockquote:before{display:none} +.verseblock{margin:0 1em 1.25em 1em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} +.quoteblock.abstract{margin:0 0 1.25em 0;display:block} +.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} +.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} +table.tableblock{max-width:100%;border-collapse:separate} +table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} +table.spread{width:100%} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} +table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} +table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} +table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} +table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} +table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} +table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot{border-width:1px 0} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +td>div.verse{white-space:pre} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} +ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px} +ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} +ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} +ul.inline>li>*{display:block} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1{padding-right:.75em;font-weight:bold} +td.hdlist1,td.hdlist2{vertical-align:top} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} +.colist>table tr>td:last-of-type{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} +.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none} +span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} +span.footnote a,span.footnoteref a{text-decoration:none} +span.footnote a:active,span.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} +#footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background-color:#00fafa} +.black{color:#000} +.black-background{background-color:#000} +.blue{color:#0000bf} +.blue-background{background-color:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background-color:#fa00fa} +.gray{color:#606060} +.gray-background{background-color:#7d7d7d} +.green{color:#006000} +.green-background{background-color:#007d00} +.lime{color:#00bf00} +.lime-background{background-color:#00fa00} +.maroon{color:#600000} +.maroon-background{background-color:#7d0000} +.navy{color:#000060} +.navy-background{background-color:#00007d} +.olive{color:#606000} +.olive-background{background-color:#7d7d00} +.purple{color:#600060} +.purple-background{background-color:#7d007d} +.red{color:#bf0000} +.red-background{background-color:#fa0000} +.silver{color:#909090} +.silver-background{background-color:#bcbcbc} +.teal{color:#006060} +.teal-background{background-color:#007d7d} +.white{color:#bfbfbf} +.white-background{background-color:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background-color:#fafa00} +span.icon>.fa{cursor:default} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]:after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +h1,h2{letter-spacing:-.01em} +dt,th.tableblock,td.content{text-rendering:optimizeLegibility} +p,td.content{letter-spacing:-.01em} +p strong,td.content strong{letter-spacing:-.005em} +p,blockquote,dt,td.content{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} +.print-only{display:none!important} +@media print{@page{margin:1.25cm .75cm} +*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} +a{color:inherit!important;text-decoration:underline!important} +a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} +a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} +abbr[title]:after{content:" (" attr(title) ")"} +pre,blockquote,tr,img{page-break-inside:avoid} +thead{display:table-header-group} +img{max-width:100%!important} +p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} +h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} +#toc,.sidebarblock,.exampleblock>.content{background:none!important} +#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} +.sect1{padding-bottom:0!important} +.sect1+.sect1{border:0!important} +#header>h1:first-child{margin-top:1.25rem} +body.book #header{text-align:center} +body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} +body.book #header .details{border:0!important;display:block;padding:0!important} +body.book #header .details span:first-child{margin-left:0!important} +body.book #header .details br{display:block} +body.book #header .details br+span:before{content:none!important} +body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} +body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} +.listingblock code[data-lang]:before{display:block} +#footer{background:none!important;padding:0 .9375em} +#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} +.hide-on-print{display:none!important} +.print-only{display:block!important} +.hide-for-print{display:none!important} +.show-for-print{display:inherit!important}} \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/hbase/blob/cb77a925/src/main/docbkx/appendix_acl_matrix.xml ---------------------------------------------------------------------- diff --git a/src/main/docbkx/appendix_acl_matrix.xml b/src/main/docbkx/appendix_acl_matrix.xml deleted file mode 100644 index a0d4695..0000000 --- a/src/main/docbkx/appendix_acl_matrix.xml +++ /dev/null @@ -1,662 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<appendix version="5.0" xml:id="appendix_acl_matrix" - 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>Access Control Matrix</title> - <para>The following matrix shows the minimum permission set required to perform operations in - HBase. Before using the table, read through the information about how to interpret it.</para> - <variablelist> - <title>Interpreting the ACL Matrix Table</title> - <para>The following conventions are used in the ACL Matrix table:</para> - <varlistentry> - <term>Scopes</term> - <listitem> - <para>Permissions are evaluated starting at the widest scope and working to the - narrowest scope. A scope corresponds to a level of the data model. From broadest to - narrowest, the scopes are as follows::</para> - <itemizedlist> - <listitem><para>Global</para></listitem> - <listitem><para>Namespace (NS)</para></listitem> - <listitem><para>Table</para></listitem> - <listitem><para>Column Family (CF)</para></listitem> - <listitem><para>Column Qualifier (CQ)</para></listitem> - <listitem><para>Cell</para></listitem> - </itemizedlist> - <para>For instance, a permission granted at table level dominates any grants done at - the Column Family, Column Qualifier, or cell level. The user can do what that - grant implies at any location in the table. A permission granted at global scope - dominates all: the user is always allowed to take that action everywhere.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>Permissions</term> - <listitem> - <para>Possible permissions include the following:</para> - <itemizedlist> - <listitem><para>Superuser - a special user that belongs to group "supergroup" and has - unlimited access</para></listitem> - <listitem><para>Admin (A)</para></listitem> - <listitem><para>Create (C)</para></listitem> - <listitem><para>Write (W)</para></listitem> - <listitem><para>Read (R)</para></listitem> - <listitem><para>Execute (X)</para></listitem> - </itemizedlist> - </listitem> - </varlistentry> - </variablelist> - - <para>For the most part, permissions work in an expected way, with the following caveats:</para> - <itemizedlist> - <listitem> - <para>Having Write permission does not imply Read permission. It is possible and sometimes - desirable for a user to be able to write data that same user cannot read. One such example - is a log-writing process.</para> - </listitem> - <listitem> - <para>The <systemitem>hbase:meta</systemitem> table is readable by every user, regardless - of the user's other grants or restrictions. This is a requirement for HBase to - function correctly.</para> - </listitem> - <listitem> - <para><code>CheckAndPut</code> and <code>CheckAndDelete</code> operations will fail if - the user does not have both Write and Read permission.</para> - </listitem> - <listitem> - <para><code>Increment</code> and <code>Append</code> operations do not require Read - access.</para> - </listitem> - </itemizedlist> - - <para>The following table is sorted by the interface that provides each operation. In case the - table goes out of date, the unit tests which check for accuracy of permissions can be found - in - <filename>hbase-server/src/test/java/org/apache/hadoop/hbase/security/access/TestAccessController.java</filename>, - and the access controls themselves can be examined in - <filename>hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java</filename>.</para> - - <table frame="all"> - <title>ACL Matrix</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Interface</entry> - <entry>Operation</entry> - <entry>Minimum Scope</entry> - <entry>Minimum Permission</entry> - </row> - </thead> - <tbody> - <row> - <entry morerows="27"> - <!-- incrememt this if you add another "master" operation --> - <para>Master</para> - </entry> - <entry> - <para>createTable</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>C</para> - </entry> - </row> - <row> - <entry> - <para>modifyTable</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>deleteTable</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>truncateTable</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>addColumn</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>modifyColumn</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>deleteColumn</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>disableTable</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>disableAclTable</para> - </entry> - <entry> - <para>None</para> - </entry> - <entry> - <para>Not allowed</para> - </entry> - </row> - <row> - <entry> - <para>enableTable</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>move</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>assign</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>unassign</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>regionOffline</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>balance</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>balanceSwitch</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>shutdown</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>stopMaster</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>snapshot</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>clone</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>restore</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>deleteSnapshot</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>createNamespace</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>deleteNamespace</para> - </entry> - <entry> - <para>Namespace</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>modifyNamespace</para> - </entry> - <entry> - <para>Namespace</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>flushTable</para> - </entry> - <entry> - <para>Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>getTableDescriptors</para> - </entry> - <entry> - <para>Global|Table</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>mergeRegions</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry morerows="24">Region</entry> - <!-- Incrememt this if you add any more Region - operations --> - <entry>open</entry> - <entry>Global</entry> - <entry>A</entry> - </row> - <row> - <entry> - <para>openRegion</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry>close</entry> - <entry>Global</entry> - <entry>A</entry> - </row> - <row> - <entry> - <para>closeRegion</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>stopRegionServer</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>rollHLog</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>mergeRegions</para> - </entry> - <entry> - <para>Global</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry>append</entry> - <entry>Table|CF|CQ</entry> - <entry>W</entry> - </row> - <row> - <entry>delete</entry> - <entry>Table|CF|CQ|Cell (if the user has write permission for all cells)</entry> - <entry>W</entry> - </row> - <row> - <entry>exists</entry> - <entry>Table|CF|CQ</entry> - <entry>R</entry> - </row> - <row> - <entry>get</entry> - <entry>Table|CF|CQ</entry> - <entry>R</entry> - </row> - <row> - <entry>getClosestRowBefore</entry> - <entry>Table|CF|CQ</entry> - <entry>R</entry> - </row> - <row> - <entry>increment</entry> - <entry>Table|CF|CQ</entry> - <entry>W</entry> - </row> - <row> - <entry>put</entry> - <entry>Table|CF|CQ</entry> - <entry>W</entry> - </row> - <row> - <entry> - <para>flush</para> - </entry> - <entry> - <para>Global|Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry> - <para>split</para> - </entry> - <entry> - <para>Global|Table</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>compact</para> - </entry> - <entry> - <para>Global|Table</para> - </entry> - <entry> - <para>A|C</para> - </entry> - </row> - <row> - <entry>bulkLoadHFile</entry> - <entry>Table</entry> - <entry>W</entry> - </row> - <row> - <entry>prepareBulkLoad</entry> - <entry>Table</entry> - <entry>C</entry> - </row> - <row> - <entry>cleanupBulkLoad</entry> - <entry>Table</entry> - <entry>W</entry> - </row> - <row> - <entry>checkAndDelete</entry> - <entry>Table|CF|CQ</entry> - <entry>RW</entry> - </row> - <row> - <entry>checkAndPut</entry> - <entry>Table|CF|CQ</entry> - <entry>RW</entry> - </row> - <row> - <entry>incrementColumnValue</entry> - <entry>Table|CF|CQ</entry> - <entry>RW</entry> - </row> - <row> - <entry>scannerClose</entry> - <entry>Table</entry> - <entry>R</entry> - </row> - <row> - <entry>scannerNext</entry> - <entry>Table</entry> - <entry>R</entry> - </row> - <row> - <entry>scannerOpen</entry> - <entry>Table|CQ|CF</entry> - <entry>R</entry> - </row> - <row> - <entry> - <para>Endpoint</para> - </entry> - <entry> - <para>invoke</para> - </entry> - <entry>Endpoint</entry> - <entry> - <para>X</para> - </entry> - </row> - <row> - <entry morerows="3"> - <para>AccessController</para> - </entry> - <entry> - <para>grant</para> - </entry> - <entry>Global|Table|NS</entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>revoke</para> - </entry> - <entry>Global|Table|NS</entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>getUserPermissions</para> - </entry> - <entry> - <para>Global|Table|NS</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - <row> - <entry> - <para>checkPermissions</para> - </entry> - <entry> - <para>Global|Table|NS</para> - </entry> - <entry> - <para>A</para> - </entry> - </row> - </tbody> - </tgroup> - </table> -</appendix> http://git-wip-us.apache.org/repos/asf/hbase/blob/cb77a925/src/main/docbkx/appendix_contributing_to_documentation.xml ---------------------------------------------------------------------- diff --git a/src/main/docbkx/appendix_contributing_to_documentation.xml b/src/main/docbkx/appendix_contributing_to_documentation.xml deleted file mode 100644 index 2f19c7b..0000000 --- a/src/main/docbkx/appendix_contributing_to_documentation.xml +++ /dev/null @@ -1,426 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<appendix version="5.0" xml:id="appendix_contributing_to_documentation" - 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>Contributing to Documentation</title> - <para>The Apache HBase project welcomes contributions to all aspects of the project, including - the documentation. In HBase, documentation includes the following areas, and probably some - others:</para> - <itemizedlist> - <listitem> - <para>The <link xlink:href="http://hbase.apache.org/book.html";>HBase Reference - Guide</link> (this book)</para> - </listitem> - <listitem> - <para>The <link xlink:href="http://hbase.apache.org/";>HBase website</link>e</para> - </listitem> - <listitem> - <para>The <link xlink:href="http://wiki.apache.org/hadoop/Hbase";>HBase - Wiki</link></para> - </listitem> - <listitem> - <para>API documentation</para> - </listitem> - <listitem> - <para>Command-line utility output and help text</para> - </listitem> - <listitem> - <para>Web UI strings, explicit help text, context-sensitive strings, and others</para> - </listitem> - <listitem> - <para>Log messages</para> - </listitem> - <listitem> - <para>Comments in source files, configuration files, and others</para> - </listitem> - <listitem> - <para>Localization of any of the above into target languages other than English</para> - </listitem> - </itemizedlist> - <para>No matter which area you want to help out with, the first step is almost always to - download (typically by cloning the Git repository) and familiarize yourself with the HBase - source code. The only exception in the list above is the HBase Wiki, which is edited online. - For information on downloading and building the source, see <xref linkend="developer" - />.</para> - - <section> - <title>Getting Access to the Wiki</title> - <para>The HBase Wiki is not well-maintained and much of its content has been moved into the - HBase Reference Guide (this guide). However, some pages on the Wiki are well maintained, - and it would be great to have some volunteers willing to help out with the Wiki. To - request access to the Wiki, register a new account at <link - xlink:href="https://wiki.apache.org/hadoop/Hbase?action=newaccount"; - >https://wiki.apache.org/hadoop/Hbase?action=newaccount</link>. Contact one of the - HBase committers, who can either give you access or refer you to someone who can.</para> - </section> - <section> - <title>Contributing to Documentation or Other Strings</title> - <para> If you spot an error in a string in a UI, utility, script, log message, or elsewhere, - or you think something could be made more clear, or you think text needs to be added - where it doesn't currently exist, the first step is to file a JIRA. Be sure to set the - component to <literal>Documentation</literal> in addition any other involved components. - Most components have one or more default owners, who monitor new issues which come into - those queues. Regardless of whether you feel able to fix the bug, you should still file - bugs where you see them.</para> - <para>If you want to try your hand at fixing your newly-filed bug, assign it to yourself. - You will need to clone the HBase Git repository to your local system and work on the - issue there. When you have developed a potential fix, submit it for review. If it - addresses the issue and is seen as an improvement, one of the HBase committers will - commit it to one or more branches, as appropriate.</para> - <procedure xml:id="submit_doc_patch_procedure"> - <title>Suggested Work flow for Submitting Patches</title> - <para>This procedure goes into more detail than Git pros will need, but is included in - this appendix so that people unfamiliar with Git can feel confident contributing to - HBase while they learn.</para> - <step> - <para>If you have not already done so, clone the Git repository locally. You only - need to do this once.</para> - </step> - <step> - <para>Fairly often, pull remote changes into your local repository by using the - <code>git pull</code> command, while your master branch is checked - out.</para> - </step> - <step> - <para>For each issue you work on, create a new branch. One convention that works - well for naming the branches is to name a given branch the same as the JIRA it - relates to:</para> - <screen language="bourne">$ git checkout -b HBASE-123456</screen> - </step> - <step> - <para>Make your suggested changes on your branch, committing your changes to your - local repository often. If you need to switch to working on a different issue, - remember to check out the appropriate branch.</para> - </step> - <step> - <para>When you are ready to submit your patch, first be sure that HBase builds - cleanly and behaves as expected in your modified branch. If you have made - documentation changes, be sure the documentation and website builds.</para> - <note> - <para>Before you use the <literal>site</literal> target the very first time, be - sure you have built HBase at least once, in order to fetch all the Maven - dependencies you need.</para> - </note> - <screen language="bourne">$ mvn clean install -DskipTests # Builds HBase</screen> - <screen language="bourne">$ mvn clean site -DskipTests # Builds the website and documentation</screen> - <para>If any errors occur, address them.</para> - </step> - <step> - <para>If it takes you several days or weeks to implement your fix, or you know that - the area of the code you are working in has had a lot of changes lately, make - sure you rebase your branch against the remote master and take care of any - conflicts before submitting your patch.</para> - <screen language="bourne"> -$ git checkout HBASE-123456 -$ git rebase origin/master - </screen> - </step> - <step> - <para>Generate your patch against the remote master. Run the following command from - the top level of your git repository (usually called - <literal>hbase</literal>):</para> - <screen language="bourne">$ git diff --no-prefix origin/master > HBASE-123456.patch</screen> - <para>The name of the patch should contain the JIRA ID. Look over the patch file to - be sure that you did not change any additional files by accident and that there - are no other surprises. When you are satisfied, attach the patch to the JIRA and - click the <guibutton>Patch Available</guibutton> button. A reviewer - will review your patch. If you need to submit a new version of the patch, leave - the old one on the JIRA and add a version number to the name of the new - patch.</para> - </step> - <step> - <para>After a change has been committed, there is no need to keep your local branch - around. Instead you should run <command>git pull</command> to get the new change - into your master branch.</para> - </step> - </procedure> - </section> - - <section> - <title>Editing the HBase Website</title> - <para>The source for the HBase website is in the HBase source, in the - <filename>src/main/site/</filename> directory. Within this directory, source for the - individual pages is in the <filename>xdocs/</filename> directory, and images referenced - in those pages are in the <filename>images/</filename> directory. This directory also - stores images used in the HBase Reference Guide.</para> - <para>The website's pages are written in an HTML-like XML dialect called xdoc, which has a - reference guide at <link - xlink:href="http://maven.apache.org/archives/maven-1.x/plugins/xdoc/reference/xdocs.html"; - >http://maven.apache.org/archives/maven-1.x/plugins/xdoc/reference/xdocs.html</link>. - You can edit these files in a plain-text editor, an IDE, or an XML editor such as - XML Mind XML Editor (XXE) or Oxygen XML Author. </para> - <para>To preview your changes, build the website using the <command>mvn clean site - -DskipTests</command> command. The HTML output resides in the - <filename>target/site/</filename> directory. When you are satisfied with your - changes, follow the procedure in <xref linkend="submit_doc_patch_procedure"/> to submit - your patch.</para> - </section> - - <section> - <title>Editing the HBase Reference Guide</title> - <para>The source for the HBase Reference Guide is in the HBase source, in the - <filename>src/main/docbkx/</filename> directory. It is written in <link - xlink:href="http://www.docbook.org/";>Docbook</link> XML. Docbook can be - intimidating, but you can typically follow the formatting of the surrounding file to get - an idea of the mark-up. You can edit Docbook XML files using a plain-text editor, an - XML-aware IDE, or a specialized XML editor.</para> - <para>Docbook's syntax can be picky. Before submitting a patch, be sure to build the output - locally using the <command>mvn site</command> command. If you do not get any build - errors, that means that the XML is well-formed, which means that each opening tag is - balanced by a closing tag. Well-formedness is not exactly the same as validity. Check - the output in <filename>target/docbkx/</filename> for any surprises before submitting a - patch.</para> - </section> - - <section> - <title>Auto-Generated Content</title> - <para>Some parts of the HBase Reference Guide, most notably <xref linkend="config.files"/>, - are generated automatically, so that this area of the documentation stays in sync with - the code. This is done by means of an XSLT transform, which you can examine in the - source at <filename>src/main/xslt/configuration_to_docbook_section.xsl</filename>. This - transforms the <filename>hbase-common/src/main/resources/hbase-default.xml</filename> - file into a Docbook output which can be included in the Reference Guide. Sometimes, it - is necessary to add configuration parameters or modify their descriptions. Make the - modifications to the source file, and they will be included in the Reference Guide when - it is rebuilt.</para> - <para>It is possible that other types of content can and will be automatically generated - from HBase source files in the future.</para> - </section> - - <section> - <title>Multi-Page and Single-Page Output</title> - <para>You can examine the <literal>site</literal> target in the Maven - <filename>pom.xml</filename> file included at the top level of the HBase source for - details on the process of building the website and documentation. The Reference Guide is - built twice, once as a single-page output and once with one HTML file per chapter. The - single-page output is located in <filename>target/docbkx/book.html</filename>, while the - multi-page output's index page is at <filename>target/docbkx/book/book.html</filename>. - Each of these outputs has its own <filename>images/</filename> and - <filename>css/</filename> directories, which are created at build time.</para> - </section> - - <section> - <title>Images in the HBase Reference Guide</title> - <para>You can include images in the HBase Reference Guide. For accessibility reasons, it is - recommended that you use a <figure> Docbook element for an image. This allows - screen readers to navigate to the image and also provides alternative text for the - image. The following is an example of a <figure> element.</para> - <programlisting language="xml"><![CDATA[<figure> - <title>HFile Version 1</title> - <mediaobject> - <imageobject> - <imagedata fileref="timeline_consistency.png" /> - </imageobject> - <textobject> - <phrase>HFile Version 1</phrase> - </textobject> - </mediaobject> -</figure>]]> - </programlisting> - <para>The <textobject> can contain a few sentences describing the image, rather than - simply reiterating the title. You can optionally specify alignment and size options in - the <imagedata> element.</para> - <para>When doing a local build, save the image to the - <filename>src/main/site/resources/images/</filename> directory. In the - <imagedata> element, refer to the image as above, with no directory component. The - image will be copied to the appropriate target location during the build of the - output.</para> - <para>When you submit a patch which includes adding an image to the HBase Reference Guide, - attach the image to the JIRA. If the committer asks where the image should be committed, - it should go into the above directory.</para> - </section> - - <section> - <title>Adding a New Chapter to the HBase Reference Guide</title> - <para>If you want to add a new chapter to the HBase Reference Guide, the easiest way is to - copy an existing chapter file, rename it, and change the ID and title elements near the - top of the file. Delete the existing content and create the new content. Then open the - <filename>book.xml</filename> file, which is the main file for the HBase Reference - Guide, and use an <xi:include> element to include your new chapter in the - appropriate location. Be sure to add your new file to your Git repository before - creating your patch. Note that the <filename>book.xml</filename> file currently contains - many chapters. You can only include a chapter at the same nesting levels as the other - chapters in the file. When in doubt, check to see how other files have been - included.</para> - </section> - - <section> - <title>Docbook Common Issues</title> - <para>The following Docbook issues come up often. Some of these are preferences, but others - can create mysterious build errors or other problems.</para> - <qandaset> - <qandaentry> - <question> - <para>What can go where?</para> - </question> - <answer> - <para>There is often confusion about which child elements are valid in a given - context. When in doubt, <link - xlink:href="http://docbook.org/tdg/en/html/docbook.html";>Docbook: The - Definitive Guide</link> is the best resource. It has an appendix which - is indexed by element and contains all valid child and parent elements of - any given element. If you edit Docbook often, a schema-aware XML editor - makes things easier.</para> - </answer> - </qandaentry> - <qandaentry> - <question> - <para>Paragraphs and Admonitions</para> - </question> - <answer> - <para>It is a common pattern, and it is technically valid, to put an admonition - such as a <note> inside a <para> element. Because admonitions - render as block-level elements (they take the whole width of the page), it - is better to mark them up as siblings to the paragraphs around them, like - this:</para> - <programlisting language="xml"><![CDATA[<para>This is the paragraph.</para> -<note> - <para>This is an admonition which occurs after the paragraph.</para> -</note>]]></programlisting> - </answer> - </qandaentry> - <qandaentry> - <question> - <para>Wrap textual <listitem> and <entry> contents in <para> - elements.</para> - </question> - <answer> - <para>Because the contents of a <listitem> (an element in an itemized, - ordered, or variable list) or an <entry> (a cell in a table) can - consist of things other than plain text, they need to be wrapped in some - element. If they are plain text, they need to be inclosed in <para> - tags. This is tedious but necessary for validity.</para> - <programlisting language="xml"><![CDATA[<itemizedlist> - <listitem> - <para>This is a paragraph.</para> - </listitem> - <listitem> - <screen>This is screen output.</screen> - </listitem> -</itemizedlist>]]></programlisting> - </answer> - </qandaentry> - <qandaentry> - <question> - <para>When to use <command>, <code>, <programlisting>, - <screen></para> - </question> - <answer> - <para>The first two are in-line tags, which can occur within the flow of - paragraphs or titles. The second two are block elements.</para> - <para>Use <command> to mention a command such as <command>hbase - shell</command> in the flow of a sentence. Use <code> for other - inline text referring to code. Incidentally, use <literal> to specify - literal strings that should be typed or entered exactly as shown. Within a - <screen> listing, it can be helpful to use the <userinput> and - <computeroutput> elements to mark up the text further.</para> - <para>Use <screen> to display input and output as the user would - <emphasis>see</emphasis> it on the screen, in a log file, etc. Use - <programlisting> only for blocks of code that occur within a file, - such as Java or XML code, or a Bash shell script.</para> - </answer> - </qandaentry> - <qandaentry> - <question> - <para>How to escape XML elements so that they show up as XML</para> - </question> - <answer> - <para>For one-off instances or short in-line mentions, use the &lt; and - &gt; encoded characters. For longer mentions, or blocks of code, enclose - it with <![CDATA[<![CDATA[]]>]]>, which is much easier to maintain and - parse in the source files..</para> - </answer> - </qandaentry> - <qandaentry> - <question> - <para>Tips and tricks for making screen output look good</para> - </question> - <answer> - <para>Text within <screen> and <programlisting> elements is shown - exactly as it appears in the source, including indentation, tabs, and line - wrap.</para> - <itemizedlist> - <listitem> - <para>Indent the starting and closing XML elements, but do not indent - the content. Also, to avoid having an extra blank line at the - beginning of the programlisting output, do not put the CDATA - element on its own line. For example:</para> - <programlisting language="bourne"><![CDATA[ <programlisting> -case $1 in - --cleanZk|--cleanHdfs|--cleanAll) - matches="yes" ;; - *) ;; -esac - </programlisting>]]></programlisting> - </listitem> - <listitem> - <para>After pasting code into a programlisting, fix the indentation - manually, using two <emphasis>spaces</emphasis> per desired - indentation. For screen output, be sure to include line breaks so - that the text is no longer than 100 characters.</para> - </listitem> - </itemizedlist> - </answer> - </qandaentry> - <qandaentry> - <question> - <para>Isolate Changes for Easy Diff Review.</para> - </question> - <answer> - <para>Be careful with pretty-printing or re-formatting an entire XML file, even - if the formatting has degraded over time. If you need to reformat a file, do - that in a separate JIRA where you do not change any content. Be careful - because some XML editors do a bulk-reformat when you open a new file, - especially if you use GUI mode in the editor.</para> - </answer> - </qandaentry> - <qandaentry> - <question> - <para>Syntax Highlighting</para> - </question> - <answer> - <para>The HBase Reference Guide uses the <link - xlink:href="http://sourceforge.net/projects/xslthl/files/xslthl/2.1.0/"; - >XSLT Syntax Highlighting</link> Maven module for syntax highlighting. - To enable syntax highlighting for a given <programlisting> or - <screen> (or possibly other elements), add the attribute - <literal>language=<replaceable>LANGUAGE_OF_CHOICE</replaceable></literal> - to the element, as in the following example:</para> - <programlisting language="xml"><![CDATA[ -<programlisting language="xml"> - <foo>bar</foo> - <bar>foo</bar> -</programlisting>]]></programlisting> - <para>Several syntax types are supported. The most interesting ones for the - HBase Reference Guide are <literal>java</literal>, <literal>xml</literal>, - <literal>sql</literal>, and <literal>bourne</literal> (for BASH shell - output or Linux command-line examples).</para> - </answer> - </qandaentry> - </qandaset> - </section> -</appendix> - - \ No newline at end of file
