From 9c41f06b30811b8f2d21a3fb5032ad5f2ecb2682 Mon Sep 17 00:00:00 2001 From: "riccardo.sisto" Date: Thu, 9 Mar 2017 17:19:31 +0100 Subject: Add verigraph documentation Add design doc and installation instructions (pointing to Readme in code base). User manual will be provided in next release Change-Id: I5118894e80a36c1fc0dc29b6e6c3b59637e1b6d0 Signed-off-by: riccardo.sisto --- .../installation/installation.instruction.rst | 26 ++++++++++++++++++++++ docs/release/release-notes/release-notes.rst | 4 ++++ 2 files changed, 30 insertions(+) (limited to 'docs/release') diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index 999080c..de6956a 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -105,3 +105,29 @@ Step 2: Install the policy2tosca module. python setup.py install +Parser verigraph installation +============================= + +In the present release, verigraph requires that the following software is also installed: + +- Java 1.8 (with javac compiler) +- Apache Tomcat 8 +- Microsoft Z3 (https://github.com/Z3Prover/bin/tree/master/releases) +- Neo4J (https://neo4j.org) + +Please follow the below installation steps to install verigraph. + +Step 1: Clone the parser project. + +.. code-block:: bash + + git clone https://gerrit.opnfv.org/gerrit/parser + +Step 2: Go to the verigraph directory. + +.. code-block:: bash + + cd parser/verigraph + +Step3: Follow the instructions in README.rst for downloading verigraph +dependencies and for installing verigraph. diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index c5360f9..5d62b74 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -94,6 +94,10 @@ Feature additions +--------------------------------------+--------------------------------------+ | | | +--------------------------------------+--------------------------------------+ +| PARSER-111 | Verigraph Code Base | +| | | ++--------------------------------------+--------------------------------------+ + Bug corrections ~~~~~~~~~~~~~~~~~~~~~ -- cgit 1.2.3-korg