PDIO-398 More instructions for Storage layer

data/src/main/scala/storage/EngineInstances.scala

@@ -44,7 +44,7 @@ import org.json4s.native.Serialization
  * @param multipleMetricsResultsHTML HTML results of metrics on all data sets.
  * @param multipleMetricsResultsJSON JSON results of metrics on all data sets.
  */
-case class EngineInstance(
+private[prediction] case class EngineInstance(
  id: String,
  status: String,
  startTime: DateTime,

data/src/main/scala/storage/EngineManifests.scala

@@ -30,7 +30,7 @@ import org.json4s._
  * @param files Paths to engine files.
  * @param engineFactory Engine's factory class name.
  */
-case class EngineManifest(
+private[prediction] case class EngineManifest(
  id: String,
  version: String,
  name: String,

data/src/main/scala/storage/package.scala

@@ -0,0 +1,21 @@
+/** Copyright 2014 TappingStone, Inc.
+ *
+ * Licensed 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:https://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.
+ */
+
+package io.prediction.data
+
+/** Provides convenient tools to interface with the Event Store from within a
+ * prediction engine. The common entry point is [[Storage]].
+ */
+package object storage {}

docs/scaladoc/rootdoc.txt

@@ -1,4 +1,5 @@
 This is the API documentation of PredictionIO.
 
 If you are building a prediction engine, the most interesting package would be
-[[io.prediction.controller]].
+[[io.prediction.controller]]. If your prediction engine uses Event Store, you
+may also want to look at [[io.prediction.data.storage]].

project/plugins.sbt

@@ -2,7 +2,7 @@ addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.3.2")
 
 addSbtPlugin("com.typesafe.sbt" % "sbt-pgp" % "0.8.3")
 
-addSbtPlugin("com.typesafe.sbt" % "sbt-twirl" % "1.0.2")
+addSbtPlugin("com.typesafe.sbt" % "sbt-twirl" % "1.0.3")
 
 addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.7.4")