Skip to content

Commit

Permalink
Update documentation for 0.9.3
Browse files Browse the repository at this point in the history
  • Loading branch information
dszeto committed May 20, 2015
1 parent 9393fe4 commit c860ad5
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 7 deletions.
17 changes: 14 additions & 3 deletions docs/manual/source/install/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,23 @@ Template](/start/download).
It is **very important** to meet the minimum version of the following
technologies that power PredictionIO.

* Apache Hadoop 2.4.0 (required only if YARN and HDFS are needed)
* Apache HBase 0.98.6
* Apache Hadoop 2.4.0 (optional, required only if YARN and HDFS are needed)
* Apache Spark 1.3.0 for Hadoop 2.4
* Elasticsearch 1.4.0
* Java SE Development Kit 7

and one of the following sets:

* PostgreSQL 9.1

or

* MySQL 5.1

or

* Apache HBase 0.98.6
* Elasticsearch 1.4.0

If you are running on a single machine, we recommend a minimum of 2GB memory.

INFO: If you are using Linux, Apache Spark local mode, which is the default
Expand Down
4 changes: 4 additions & 0 deletions docs/manual/source/install/install-linux.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,15 @@ $ mkdir PredictionIO-<%= data.versions.pio %>/vendors

#### Elasticsearch Setup

WARNING: You may skip this section if you are using PostgreSQL or MySQL.

<%= partial 'shared/install/elasticsearch' %>


#### HBase Setup<a class="anchor" name="hbase">&nbsp;</a>

WARNING: You may skip this section if you are using PostgreSQL or MySQL.

<%= partial 'shared/install/hbase' %>


Expand Down
4 changes: 4 additions & 0 deletions docs/manual/source/install/install-sourcecode.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,15 @@ $ mkdir PredictionIO-<%= data.versions.pio %>/vendors

#### Elasticsearch Setup

WARNING: You may skip this section if you are using PostgreSQL or MySQL.

<%= partial 'shared/install/elasticsearch' %>


#### <a name="hbase"></a>HBase Setup

WARNING: You may skip this section if you are using PostgreSQL or MySQL.

<%= partial 'shared/install/hbase' %>


Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
### Start PredictionIO and Dependent Services

WARNING: If you are using PostgreSQL or MySQL, skip `pio-start-all` and
`pio-stop-all`, and do `PredictionIO-<%= data.versions.pio %>/bin/pio eventserver &`
instead.

Simply do `PredictionIO-<%= data.versions.pio %>/bin/pio-start-all` and you
should see something similar to the following:

Expand Down
14 changes: 11 additions & 3 deletions docs/manual/source/partials/shared/quickstart/_install.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,24 @@ For convenience, add PredictionIO's binary command path to your `PATH`, i.e.
$ PATH=$PATH:/home/yourname/PredictionIO/bin; export PATH
```

NOTE: If you lauched **PredictionIO AWS instance**, the path is located at
NOTE: If you launched **PredictionIO AWS instance**, the path is located at
`/opt/PredictionIO/bin`.

Once you have completed the installation process, please make sure all the
components (PredictionIO Event Server, Elasticsearch, and HBase) are up and
running.

NOTE: If you lauched **PredictionIO AWS instance**, you can skip `pio-start-all`. All components should have been started automatically.
NOTE: If you launched **PredictionIO AWS instance**, you can skip `pio-start-all`. All components should have been started automatically.

Run the following to start all PrediciotnIO components:
If you are using PostgreSQL or MySQL, run the following to start PredictionIO
Event Server:

```
$ pio eventserver &
```

If instead you are running HBase and Elasticsearch, run the following to start
all PredictionIO Event Server, HBase, and Elasticsearch:

```
$ pio-start-all
Expand Down
12 changes: 12 additions & 0 deletions docs/manual/source/release-notes.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ INFO: For upgrade instructions please refer to [this page](/resources/upgrade/).

### What's New

0.9.3 Release | May 20th, 2015 | [Release Notes](https://predictionio.atlassian.net/jira/secure/ReleaseNote.jspa?projectId=10000&version=13600)

- Add support of developing prediction engines in Java

- Add support of PostgreSQL and MySQL

- Spark 1.3.1 compatibility fix

- Creation of specific app access keys

- Prevent a case where `pio build` accidentally removes PredictionIO core library

0.9.2 Release | April 14th, 2015 | [Release Notes](https://predictionio.atlassian.net/jira/secure/ReleaseNote.jspa?projectId=10000&version=13500)

- Channels in the Event Server
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/source/start/download.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ $ pio template get PredictionIO/template-scala-parallel-recommendation MyRecomme

NOTE: `pio` is a command available in the `bin/` of the installed PredictionIO directory. You may add the installed Prediction's bin/ directory path to you environment PATH.

Please browse the [PredictionIO template gallery]((http:https://templates.prediction.io/)) to choose an engine template.
Please browse the [PredictionIO template gallery](http:https://templates.prediction.io/) to choose an engine template.

0 comments on commit c860ad5

Please sign in to comment.