accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktur...@apache.org
Subject svn commit: r1680095 - /accumulo/site/trunk/content/release_notes/README_1.7.0.mdtext
Date Mon, 18 May 2015 20:58:09 GMT
Author: kturner
Date: Mon May 18 20:58:09 2015
New Revision: 1680095

URL: http://svn.apache.org/r1680095
Log:
ACCUMULO-3737 Test adding 1.7.0 README

Added:
    accumulo/site/trunk/content/release_notes/README_1.7.0.mdtext   (with props)

Added: accumulo/site/trunk/content/release_notes/README_1.7.0.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/content/release_notes/README_1.7.0.mdtext?rev=1680095&view=auto
==============================================================================
--- accumulo/site/trunk/content/release_notes/README_1.7.0.mdtext (added)
+++ accumulo/site/trunk/content/release_notes/README_1.7.0.mdtext Mon May 18 20:58:09 2015
@@ -0,0 +1,114 @@
+Title:
+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.
+
+Apache Accumulo
+===============
+
+The [Apache Accumulo™][1] sorted, distributed key/value store is a robust,
+scalable, high performance data storage and retrieval system.  Apache Accumulo
+is based on Google's [BigTable][4] design and is built on top of Apache
+[Hadoop][5], [Zookeeper][6], and [Thrift][7]. Apache Accumulo features a few
+novel improvements on the BigTable design in the form of cell-based access
+control and a server-side programming mechanism that can modify key/value pairs
+at various points in the data management process. Other notable improvements
+and feature are outlined [here][8].
+
+To install and run an Accumulo binary distribution, follow the [install][2]
+instructions.
+  
+Documentation
+-------------
+
+Accumulo provides the following documentation :
+
+ * **User Manual** : In-depth developer and administrator documentation.
+ * **Examples** : Code with corresponding readme files that give step by step
+                  instructions for running example code.
+
+This documentation is available on the [Accumulo site][1].  In the source and
+binary distributions of Accumulo, the documentation is at different locations.
+
+In the Accumulo binary distribution, all documentation is in the `docs`
+directory.  The binary distribution does not include example source code, but
+it does include a jar with the compiled examples.   This examples jar makes it
+easy to step through the example readmes, after following the [install][2]
+instructions.
+
+In the Accumulo source, documentations is found at the following locations.
+
+ * [Example Source](examples/simple/src/main/java/org/apache/accumulo/examples/simple)
+ * [Example Readmes](docs/src/main/resources/examples)
+ * [User Manual Source](docs/src/main/asciidoc)
+
+Building 
+--------
+
+Accumulo uses [Maven][9] to compile, [test][3], and package its source.  The
+following command will build the binary tar.gz from source.  Note, these
+instructions will not work for the Accumulo binary distribution as it does not
+include source.
+
+    mvn package -P assemble
+
+This command produces a file at the following location.
+
+    assemble/target/accumulo-X.Y.Z-SNAPSHOT-bin.tar.gz
+
+This will not include documentation, adding the `-P docs` option to the maven
+command will build documentation.
+
+API
+---
+
+The public Accumulo API is composed of :
+
+All public types in the following packages and their subpackages excluding
+those named *impl*, *thrift*, or *crypto*. 
+
+   * org.apache.accumulo.core.client
+   * org.apache.accumulo.core.data
+   * org.apache.accumulo.core.security
+   * org.apache.accumulo.minicluster
+
+A type is a class, interface, or enum.  Anything with public or protected
+acccess in an API type is in the API.  This includes, but is not limited to:
+methods, members classes, interfaces, and enums.  Package-private types in
+the above packages are *not* considered public API.
+
+The following regex matches imports that are *not* Accumulo public API.  This
+regex can be used with [RegexpSingleline][13] to automatically find suspicious
+imports in a project using Accumulo. 
+
+    import\s+org\.apache\.accumulo\.(.*\.(impl|thrift|crypto)\..*|(?!core|minicluster).*|core\.(?!client|data|security).*)
+
+The Accumulo project maintains binary compatibility across this API within a
+major release, as defined in the Java Language Specification 3rd ed. Starting
+with Accumulo 1.6.2 and 1.7.0 all API changes will follow [semver 2.0][12]
+
+[1]: http://accumulo.apache.org
+[2]: INSTALL.md
+[3]: TESTING.md
+[4]: http://research.google.com/archive/bigtable.html
+[5]: http://hadoop.apache.org
+[6]: http://zookeeper.apache.org
+[7]: http://thrift.apache.org/
+[8]: http://accumulo.apache.org/notable_features.html
+[9]: http://maven.apache.org/
+[12]: http://semver.org/spec/v2.0.0.html
+[13]: http://checkstyle.sourceforge.net/config_regexp.html
+

Propchange: accumulo/site/trunk/content/release_notes/README_1.7.0.mdtext
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message