src/main/asciidoc/book.adoc

   1 ////
   2 /**
   3  *
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20 ////
  21
  22 = Apache HBase (TM) Reference Guide
  23 :Author: Apache HBase Team
  24 :Email: <hbase-dev@lists.apache.org>
  25 :doctype: book
  26 :Version: {docVersion}
  27 :revnumber: {docVersion}
  28 // Logo for PDF -- doesn't render in HTML
  29 :title-logo-image: image:hbase_logo_with_orca.png[pdfwidth=4.25in,align=center]
  30 :numbered:
  31 :toc: left
  32 :toclevels: 1
  33 :toc-title: Contents
  34 :sectanchors:
  35 :icons: font
  36 :iconsdir: icons
  37 :linkcss:
  38 :experimental:
  39 :source-language: java
  40 :leveloffset: 0
  41 :stem:
  42
  43 // Logo for HTML -- doesn't render in PDF
  44 ifdef::backend-html5[]
  45 ++++
  46 <div>
  47   <a href="https://hbase.apache.org"><img src="images/hbase_logo_with_orca.png" alt="Apache HBase Logo" /></a>
  48 </div>
  49 ++++
  50 endif::[]
  51
  52 // The directory is called _chapters because asciidoctor skips direct
  53 // processing of files found in directories starting with an _. This
  54 // prevents each chapter being built as its own book.
  55
  56 include::_chapters/preface.adoc[]
  57
  58 include::_chapters/getting_started.adoc[]
  59 include::_chapters/configuration.adoc[]
  60 include::_chapters/upgrading.adoc[]
  61 include::_chapters/shell.adoc[]
  62 include::_chapters/datamodel.adoc[]
  63 include::_chapters/schema_design.adoc[]
  64 include::_chapters/mapreduce.adoc[]
  65 include::_chapters/security.adoc[]
  66 include::_chapters/architecture.adoc[]
  67 include::_chapters/hbase_mob.adoc[]
  68 include::_chapters/snapshot_scanner.adoc[]
  69 include::_chapters/inmemory_compaction.adoc[]
  70 include::_chapters/offheap_read_write.adoc[]
  71 include::_chapters/backup_restore.adoc[]
  72 include::_chapters/sync_replication.adoc[]
  73 include::_chapters/hbase_apis.adoc[]
  74 include::_chapters/external_apis.adoc[]
  75 include::_chapters/thrift_filter_language.adoc[]
  76 include::_chapters/spark.adoc[]
  77 include::_chapters/cp.adoc[]
  78 include::_chapters/performance.adoc[]
  79 include::_chapters/profiler.adoc[]
  80 include::_chapters/troubleshooting.adoc[]
  81 include::_chapters/case_studies.adoc[]
  82 include::_chapters/ops_mgt.adoc[]
  83 include::_chapters/developer.adoc[]
  84 include::_chapters/unit_testing.adoc[]
  85 include::_chapters/protobuf.adoc[]
  86 include::_chapters/pv2.adoc[]
  87 include::_chapters/amv2.adoc[]
  88 include::_chapters/zookeeper.adoc[]
  89 include::_chapters/community.adoc[]
  90 include::_chapters/hbtop.adoc[]
  91 include::_chapters/tracing.adoc[]
  92 include::_chapters/store_file_tracking.adoc[]
  93
  94 = Appendix
  95
  96 include::_chapters/appendix_contributing_to_documentation.adoc[]
  97 include::_chapters/faq.adoc[]
  98 include::_chapters/appendix_acl_matrix.adoc[]
  99 include::_chapters/compression.adoc[]
 100 include::_chapters/sql.adoc[]
 101 include::_chapters/ycsb.adoc[]
 102 include::_chapters/appendix_hfile_format.adoc[]
 103 include::_chapters/other_info.adoc[]
 104 include::_chapters/hbase_history.adoc[]
 105 include::_chapters/asf.adoc[]
 106 include::_chapters/orca.adoc[]
 107 include::_chapters/rpc.adoc[]
 108 include::_chapters/appendix_hbase_incompatibilities.adoc[]