bookkeeper-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From eolive...@apache.org
Subject [bookkeeper] branch master updated: BOOKKEEPER-1027: Cleanup README
Date Thu, 20 Jul 2017 13:24:51 GMT
This is an automated email from the ASF dual-hosted git repository.

eolivelli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git


The following commit(s) were added to refs/heads/master by this push:
     new 2d992e3  BOOKKEEPER-1027: Cleanup README
2d992e3 is described below

commit 2d992e39da0fc121901a72849b424c86fb099f03
Author: Sijie Guo <sijie@apache.org>
AuthorDate: Thu Jul 20 15:24:34 2017 +0200

    BOOKKEEPER-1027: Cleanup README
    
    Descriptions of the changes in this PR:
    
    - Move README to README.md (written it in markdown syntax)
    - Organized the README as below:
      - what is bookkeeper and what it can be used for
      - getting started
      - documentation
      - contribution
    
    Author: Sijie Guo <sijie@apache.org>
    
    Reviewers: Enrico Olivelli, Jia Zhai
    
    This closes #248 from sijie/update_readme
---
 README               | 71 -------------------------------------------------
 README.md            | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 pom.xml              |  2 +-
 src/assemble/bin.xml |  2 +-
 src/assemble/src.xml |  2 +-
 5 files changed, 77 insertions(+), 74 deletions(-)

diff --git a/README b/README
deleted file mode 100644
index 654b370..0000000
--- a/README
+++ /dev/null
@@ -1,71 +0,0 @@
-Build instructions for BookKeeper
-
--------------------------------------------------------------------------------
-Requirements:
-
-* Unix System
-* JDK 1.6
-* Maven 3.0
-* Internet connection for first build (to fetch all dependencies)
-
--------------------------------------------------------------------------------
-The BookKeeper project contains:
-
- - bookkeeper-server            (BookKeeper server and client)
- - bookkeeper-benchmark         (Benchmark suite for testing BookKeeper performance)
- - bookkeeper-stats             (BookKeeper stats library)
- - bookkeeper-stats-providers   (BookKeeper stats providers)
-
-BookKeeper is a system to reliably log streams of records. It is designed to 
-store  write ahead logs, such as those found in database or database like 
-applications.
-
---------------------------------------------------------------------------------
-How do I build?
-
- BookKeeper uses maven as its build system. To build, run "mvn package" from the 
- top-level directory, or from within any of the submodules.
-
- Useful maven commands are:
-
- * Clean                     : mvn clean
- * Compile                   : mvn compile
- * Run tests                 : mvn test 
- * Create JAR                : mvn package
- * Run findbugs              : mvn compile findbugs:findbugs
- * Install JAR in M2 cache   : mvn install
- * Deploy JAR to Maven repo  : mvn deploy
- * Run Rat                   : mvn apache-rat:check
- * Build javadocs            : mvn compile javadoc:aggregate
- * Build distribution        : mvn package assembly:single
-
- Tests options:
-
- * Use -DskipTests to skip tests when running the following Maven goals:
-    'package',  'install', 'deploy' or 'verify'
- * -Dtest=<TESTCLASSNAME>,<TESTCLASSNAME#METHODNAME>,....
- * -Dtest.exclude=<TESTCLASSNAME>
- * -Dtest.exclude.pattern=**/<TESTCLASSNAME1>.java,**/<TESTCLASSNAME2>.java
-
---------------------------------------------------------------------------------
-How do I run the services?
-
- Running BookKeeper service, requires a running ZooKeeper service 
- (see http://zookeeper.apache.org). 
-
- To start a bookkeeper service quickly for testing, run:
-   
-   $ bookkeeper-server/bin/bookkeeper localbookie 10
-
- This will start a standalone, ZooKeeper instance and 10 BookKeeper bookies.
- Note that this is only useful for testing. Data is not persisted between runs.
-
- To start a real BookKeeper service, you must set up a ZooKeeper instance and
- run start a bookie on several machines. Modify bookkeeper-server/conf/bk_server.conf
- to point to your ZooKeeper instance. To start a bookie run:
-
-   $ bookkeeper-server/bin/bookkeeper bookie
-
- You can get more help on using these commands by running:
-
-   $ bookkeeper-server/bin/bookkeeper help
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd9c053
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+<img src="https://pbs.twimg.com/profile_images/545716709311520769/piLLa1iC_400x400.png"
alt="logo" style="width: 32px;"/>
+
+[![Build Status](https://travis-ci.org/apache/bookkeeper.svg?branch=master)](https://travis-ci.org/apache/bookkeeper)
+[![Build Status](https://builds.apache.org/buildStatus/icon?job=bookkeeper-master)](https://builds.apache.org/job/bookkeeper-master/)
+[![Coverage Status](https://coveralls.io/repos/github/apache/bookkeeper/badge.svg?branch=master)](https://coveralls.io/github/apache/bookkeeper?branch=master)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.bookkeeper/bookkeeper/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.bookkeeper/bookkeeper)
+
+# Apache BookKeeper
+
+Apache BookKeeper is a scalable, fault tolerant and low latency storage service optimized
for append-only workloads.
+
+It is suitable for being used in following scenerios:
+
+- WAL (Write-Ahead-Logging), e.g. HDFS NameNode.
+- Message Store, e.g. Apache Pulsar.
+- Offset/Cursor Store, e.g. Apache Pulsar.
+- Object/Blob Store, e.g. storing state machine snapshots.
+
+## Get Started
+
+* *Concepts*: Start with the [basic concepts](http://bookkeeper.apache.org/docs/master/bookkeeperOverview.html)
of Apache BookKeeper.
+  This will help you to fully understand the other parts of the documentation.
+* [Getting Started](http://bookkeeper.apache.org/docs/master/bookkeeperStarted.html) to setup
BookKeeper to write logs.
+
+## Documentation
+
+### Developers
+
+* [Programmer Guide](http://bookkeeper.apache.org/docs/master/bookkeeperProgrammer.html)
+* [Tutorial](http://bookkeeper.apache.org/docs/master/bookkeeperTutorial.html)
+* [Java API](http://bookkeeper.apache.org/docs/master/apidocs/)
+
+You can also read [Turning Ledgers into Logs](http://bookkeeper.apache.org/docs/master/bookkeeperLedgers2Logs.html)
to learn how to turn **ledgers** into continous **log streams**.
+If you are looking for a high level **log stream** API, you can checkout [DistributedLog](http://distributedlog.io).
+
+### Administrators
+
+* [Admin Guide](http://bookkeeper.apache.org/docs/master/bookkeeperConfig.html)
+* [Configuration Parameters](http://bookkeeper.apache.org/docs/master/bookieConfigParams.html)
+
+### Contributors
+
+* [BookKeeper Internals](http://bookkeeper.apache.org/docs/master/bookkeeperInternals.html)
+
+## Get In Touch
+
+### Report a Bug
+
+For filing bugs, suggesting improvements, or requesting new features, help us out by [opening
a Github issue](https://github.com/apache/bookkeeper/issues) or [opening an Apache jira](https://issues.apache.org/jira/browse/BOOKKEEPER).
+
+### Need Help?
+
+[Subscribe](mailto:user-subscribe@bookkeeper.apache.org) or [mail](mailto:user@bookkeeper.apache.org)
the [user@bookkeeper.apache.org](mailto:user@bookkeeper.apache.org) list - Ask questions,
find answers, and also help other users.
+
+[Subscribe](mailto:dev-subscribe@bookkeeper.apache.org) or [mail](mailto:dev@bookkeeper.apache.org)
the [dev@bookkeeper.apache.org](mailto:dev@bookkeeper.apache.org) list - Join developement
discussions, propose new ideas and connect with contributors.
+
+## Contributing
+
+We feel that a welcoming open community is important and welcome contributions.
+
+### Contributing Code
+
+1. See [Developer Setup](https://cwiki.apache.org/confluence/display/BOOKKEEPER/Developer+Setup)
to get your local environment setup.
+
+2. Take a look at our open issues: [JIRA Issues](https://issues.apache.org/jira/browse/BOOKKEEPER)
[Github Issues](https://github.com/apache/bookkeeper/issues).
+
+3. Review our [coding style](https://cwiki.apache.org/confluence/display/BOOKKEEPER/Coding+Guide)
and follow our [pull requests](https://github.com/apache/bookkeeper/pulls) to learn about
our conventions.
+
+4. Make your changes according to our [contribution guide](https://cwiki.apache.org/confluence/display/BOOKKEEPER/Contributing+to+BookKeeper).
+
+### Improving Website and Documentation
+
+1. See [Building the website and documentation](https://cwiki.apache.org/confluence/display/BOOKKEEPER/Building+the+website+and+documentation)
on how to build the website and documentation.
+
diff --git a/pom.xml b/pom.xml
index 85c7f8a..67af2c7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -149,7 +149,7 @@
             <exclude>**/target/**/*</exclude>
             <exclude>**/.svn/**/*</exclude>
             <exclude>CHANGES.txt</exclude>
-            <exclude>**/README</exclude>
+            <exclude>**/README.md</exclude>
             <exclude>**/apidocs/*</exclude>
             <exclude>test-patch/**/*</exclude>
             <exclude>**/.classpath</exclude>
diff --git a/src/assemble/bin.xml b/src/assemble/bin.xml
index 47edf5c..b505a74 100644
--- a/src/assemble/bin.xml
+++ b/src/assemble/bin.xml
@@ -51,7 +51,7 @@
       <fileMode>644</fileMode>
     </file>
     <file>
-      <source>../README</source>
+      <source>../README.md</source>
       <outputDirectory>/</outputDirectory>
       <fileMode>644</fileMode>
     </file>
diff --git a/src/assemble/src.xml b/src/assemble/src.xml
index 395f2b3..7031e06 100644
--- a/src/assemble/src.xml
+++ b/src/assemble/src.xml
@@ -27,7 +27,7 @@
       <directory>.</directory>
       <useDefaultExcludes>true</useDefaultExcludes>
       <includes>
-        <include>**/README</include>
+        <include>**/README.md</include>
         <include>**/LICENSE</include>
         <include>**/NOTICE</include>
         <include>**/pom.xml</include>

-- 
To stop receiving notification emails like this one, please contact
['"commits@bookkeeper.apache.org" <commits@bookkeeper.apache.org>'].

Mime
View raw message