Add doc.

ESPRI-Mod · Sep 19, 2016 · b5220fe · b5220fe
1 parent 091069f
commit b5220fe
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 16 deletions.
diff --git a/sdp/README.md b/sdp/README.md
@@ -15,6 +15,6 @@ compute farm freeing the resources.
 
 ## Version
 
-* Stable: 1.0
+* Stable: 1.1
 
-* Testing: 1.1
+* Testing: 1.2
diff --git a/sdp/doc/changelog b/sdp/doc/changelog
@@ -1,4 +1,5 @@
-- Version 1.1 - 20160717
+- Version 1.2 - 
+- Version 1.1 - 20160919
 	- add CORDEX support.
 	- add pexec support.
 	- add multivalues support for job_class option.

diff --git a/sdp/doc/deb_install.md b/sdp/doc/deb_install.md
@@ -8,11 +8,11 @@ This documents contains instructions to install *sdp* from DEB package.
 
 *sdp* DEB package is available for Debian, Ubuntu and Mint.
 
-## Naming
+## Terminology
 
 * *synda* is the application name
-* *sdp* is the module name
-* *synda-pp* is the package name
+* *sdp* is the module name (synda is made of several modules)
+* *synda-pp* is the Debian package name
 
 ## Installation
 
@@ -33,7 +33,7 @@ If you need a distro/version that is not listed, you can open a github issue so
 
 Note: DEB packages are currently only available for 64 bits architecture
 
-Once repository is added, run command below to update package list.
+Once repository is added, run command below to update the package list.
 
 ```
 sudo apt-get update
@@ -47,6 +47,8 @@ sudo apt-get install synda-pp --force-yes -y
 
 ## Configuration
 
+* Edit */etc/synda/sdp/sdp.conf* file
+
 * Restart service with
 
 ```

diff --git a/sdp/doc/rpm_install.md b/sdp/doc/rpm_install.md
@@ -10,11 +10,11 @@ This documents contains instructions to install *sdp* from RPM package.
 
 On RHEL5, *sdp* can only be installed from source.
 
-## Naming
+## Terminology
 
 * *synda* is the application name
-* *sdp* is the module name
-* *synda-pp* is the package name
+* *sdp* is the module name (synda is made of several modules)
+* *synda-pp* is the RPM package name
 
 ## Installation
 
@@ -29,7 +29,8 @@ sudo yum install epel-release -y
 To install *sdp* RPM package, use
 
 ```
-sudo yum install http://sd-53687.dedibox.fr/synda/sdp/rpm/<package-name> -y
+wget http://sd-53687.dedibox.fr/synda/sdp/rpm/<package-name>
+sudo yum install -y <package-name>
 ```
 
 where &lt;package-name&gt; can be one of
@@ -59,6 +60,8 @@ Note: RPM packages are currently only available for 64 bits architecture
 
 ## Configuration
 
+* Edit */etc/synda/sdp/sdp.conf* file
+
 * Restart service with
 
 ```

diff --git a/sdp/doc/src_install.md b/sdp/doc/src_install.md
@@ -1,12 +1,8 @@
 # *sdp* installation from source guide
 
-## Introduction
-
-This document describes how to install and configure sdp module.
-
 ## Synopsis
 
-This documents contains instructions to install *sdp* from source.
+This documents contains instructions to install synda *sdp* module from source.
 
 ## Requirements
 

diff --git a/sdp/doc/upgrade_deb.md b/sdp/doc/upgrade_deb.md
@@ -8,6 +8,12 @@ This document contains instructions to upgrade *sdp* version using Debian packag
 
 ### Pre-upgrade
 
+Stop service with
+
+```
+sudo service sdp stop
+```
+
 Backup folders below
 
     /etc/synda/sdp

diff --git a/sdp/doc/upgrade_rpm.md b/sdp/doc/upgrade_rpm.md
@@ -8,6 +8,12 @@ This document contains instructions to upgrade *sdp* version using RPM package.
 
 ### Pre-upgrade
 
+Stop service with
+
+```
+sudo service sdp stop
+```
+
 Backup folders below
 
     /etc/synda/sdp

diff --git a/sdp/doc/upgrade_src.md b/sdp/doc/upgrade_src.md
@@ -8,6 +8,12 @@ This document contains instructions to install new *sdp* version.
 
 ### Pre-upgrade
 
+Stop daemon with
+
+```
+spdaemon stop
+```
+
 Backup $HOME/sdp folder
 
 ### Upgrade
@@ -28,3 +34,9 @@ username, password..).
 
 Note: you can use a diff program to compare post-upgrade configuration files
 over pre-upgrade configuration files (from the backup).
+
+Start daemon with
+
+```
+spdaemon start
+```