Repository: bookkeeper Updated Branches: refs/heads/master 0d6a65d3b -> afbab15ad
BOOKKEEPER-830: Documentation has no structure (ivank via fpj) Project: http://git-wip-us.apache.org/repos/asf/bookkeeper/repo Commit: http://git-wip-us.apache.org/repos/asf/bookkeeper/commit/afbab15a Tree: http://git-wip-us.apache.org/repos/asf/bookkeeper/tree/afbab15a Diff: http://git-wip-us.apache.org/repos/asf/bookkeeper/diff/afbab15a Branch: refs/heads/master Commit: afbab15ad6778f1010b726b7f765a47417fbbed0 Parents: 0d6a65d Author: fpj <[email protected]> Authored: Mon Jan 19 21:01:43 2015 +0000 Committer: fpj <[email protected]> Committed: Mon Jan 19 21:01:43 2015 +0000 ---------------------------------------------------------------------- CHANGES.txt | 2 ++ doc/hedwigDocs.textile | 31 +++++++++++++++++++++++++++ doc/index.textile | 52 +++++++++++++++++++++++---------------------- 3 files changed, 60 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bookkeeper/blob/afbab15a/CHANGES.txt ---------------------------------------------------------------------- diff --git a/CHANGES.txt b/CHANGES.txt index a61fbb4..f231cc8 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -48,6 +48,8 @@ Trunk (unreleased changes) BOOKKEEPER-827: change throttle in GarbageCollector to use either "by entry" or "by byte" (Jia Zhai via fpj) + + BOOKKEEPER-830: Documentation has no structure (ivank via fpj) bookkeeper-client: http://git-wip-us.apache.org/repos/asf/bookkeeper/blob/afbab15a/doc/hedwigDocs.textile ---------------------------------------------------------------------- diff --git a/doc/hedwigDocs.textile b/doc/hedwigDocs.textile new file mode 100644 index 0000000..06075c0 --- /dev/null +++ b/doc/hedwigDocs.textile @@ -0,0 +1,31 @@ +Title: Hedwig Documentation +Notice: 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. + +h1. Apache Hedwig documentation + +* "Building Hedwig, or how to set up Hedwig":./hedwigBuild.html +* "User's Guide, or how to program against the Hedwig API and how to run it":./hedwigUser.html +* "Developer's Guide, or Hedwig internals and hacking details":./hedwigDesign.html +* "Configuration parameters":./hedwigParams.html +* "Message Filtering":./hedwigMessageFilter.html +* "Hedwig Metadata Management":./hedwigMetadata.html + +h2. Hedwig Admin & Ops + +* "Hedwig Console":./hedwigConsole.html +* "Hedwig JMX":./hedwigJMX.html http://git-wip-us.apache.org/repos/asf/bookkeeper/blob/afbab15a/doc/index.textile ---------------------------------------------------------------------- diff --git a/doc/index.textile b/doc/index.textile index ae5e08f..a885bea 100644 --- a/doc/index.textile +++ b/doc/index.textile @@ -16,37 +16,39 @@ Notice: Licensed to the Apache Software Foundation (ASF) under one specific language governing permissions and limitations under the License. -h1. Apache BookKeeper documentation +How to start with BookKeeper depends on who you are... -* "Overview":./bookkeeperOverview.html -* "Getting started":./bookkeeperStarted.html -* "Programmer's Guide":./bookkeeperProgrammer.html -* "Bookie Server Configuration Parameters":./bookieConfigParams.html -* "BookKeeper Configuration Parameters":./bookkeeperConfigParams.html -* "BookKeeper Internals":./bookkeeperInternals.html -* "Bookie Recovery":./bookieRecovery.html -* "Using BookKeeper stream library":./bookkeeperStream.html -* "BookKeeper Metadata Management":./bookkeeperMetadata.html +*Developers* who are new to BookKeeper should start with the "BookKeeper Tutorial":./bookkeeperTutorial.html. The tutorial shows you how to build a basic distributed system using BookKeeper. "Turning ledgers into logs":./bookkeeperLedgers2Logs.html gives a briefer description of the principles behind the logs used in the tutorial. -h2. BookKeeper Admin & Ops +Once familiar with the basic concepts, developers can consult the "BookKeeper Java API documentation":./apidocs. -* "Admin Guide":./bookkeeperConfig.html -* "BookKeeper JMX":./bookkeeperJMX.html +*Administrators* will be more interested in the "BookKeeper Admin guide":./bookkeeperConfig.html. It describes the steps involved in setting up and maintaining a cluster. The available configuration parameters can be found "here":./bookieConfigParams.html. An important aspect of BookKeeper is how it deals with the failure of storage nodes. This is covered in "Bookie Recovery":./bookieRecovery.html. -h1. Apache Hedwig documentation +*Contributor* documentation is less organized, "BookKeeper Internals":./bookkeeperInternals.html is a good place to start. From there you can check out our "wiki":https://cwiki.apache.org/confluence/display/BOOKKEEPER/Index and ask questions on our "mailing lists":/lists.html or "IRC":/irc.html. -* "Building Hedwig, or how to set up Hedwig":./hedwigBuild.html -* "User's Guide, or how to program against the Hedwig API and how to run it":./hedwigUser.html -* "Developer's Guide, or Hedwig internals and hacking details":./hedwigDesign.html -* "Configuration parameters":./hedwigParams.html -* "Message Filtering":./hedwigMessageFilter.html -* "Hedwig Metadata Management":./hedwigMetadata.html +Hedwig documentation can be found "here":./hedwigDocs.html. -h2. Hedwig Admin & Ops +h3. All documents -* "Hedwig Console":./hedwigConsole.html -* "Hedwig JMX":./hedwigJMX.html +* Overview +** "Getting started":./bookkeeperStarted.html +** "Overview":./bookkeeperOverview.html -h1. Metastore documentation +* Developers +** "BookKeeper Tutorial":./bookkeeperTutorial.html +** "Turning ledgers into logs":./bookkeeperLedgers2Logs.html +** "BookKeeper Java API documentation":./apidocs +** "Programmer's Guide (old)":./bookkeeperProgrammer.html +** "BookKeeper Configuration Parameters (old)":./bookkeeperConfigParams.html -* "Metastore Interface":./metastore.textile + +* Administrators +** "Admin Guide":./bookkeeperConfig.html +** "BookKeeper JMX":./bookkeeperJMX.html +** "Bookie Server Configuration Parameters (old)":./bookieConfigParams.html +** "Bookie Recovery":./bookieRecovery.html + +* Contributors +** "BookKeeper Internals":./bookkeeperInternals.html +** "BookKeeper Metadata Management":./bookkeeperMetadata.html +** "Metastore Interface":./metastore.textile
