Improve the documentation about the E-Maj installation. Separate the …

…installation on Linux and Windows. Describe the use of the pgxn client. Distinguish more clearly the software installation and the extension creation or upgrade. Also improve the final message in the emaj_uninstall.sql script.
dalibo · Aug 6, 2017 · 6ace319 · 6ace319
1 parent 3cdefab
commit 6ace319
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 238 deletions.
diff --git a/docs/en/download.rst b/docs/en/download.rst
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -23,7 +23,7 @@ Welcome to the E-Maj's documentation!
    :maxdepth: 1
    :caption: How to install E-Maj:
 
-   download
+   install
    setup
    upgrade
    uninstall
@@ -72,6 +72,7 @@ Welcome to the E-Maj's documentation!
    :caption: Appendix:
 
    functionsList
+   content
 
 Indices and tables
 ==================

diff --git a/docs/en/setup.rst b/docs/en/setup.rst
@@ -1,7 +1,7 @@
 E-Maj extension setup
 =====================
 
-If E-Maj is already installed in the database, you may need to :doc:`upgrade <upgrade>` it.
+If an extension already exists in the database, but in an old E-Maj version, you need to :doc:`upgrade <upgrade>` it.
 
 Otherwise, some preliminary operations are required.
 
@@ -27,10 +27,10 @@ Optionally, if the E-Maj administrator wants to store E-Maj technical tables int
    SET default_tablespace = <tablespace.name>;
 
 
-E-Maj components installation
------------------------------
+Creating the E-Maj extension
+----------------------------
 
-The E-Maj components can now be installed into the database, by executing the SQL command::
+The E-Maj extension can now be created into the database, by executing the SQL command::
 
    CREATE EXTENSION emaj;
 

diff --git a/docs/en/uninstall.rst b/docs/en/uninstall.rst
@@ -1,5 +1,5 @@
-E-Maj uninstall
-===============
+Uninstalling an E-Maj extension from a database
+===============================================
 
 To uninstall E-Maj from a database, the user must log on this database with *psql*, as a superuser.
 
@@ -32,5 +32,5 @@ The uninstallation script execution displays::
    psql:sql/emaj_uninstall.sql:203: WARNING:  emaj_uninstall: emaj_adm and emaj_viewer roles have been dropped.
    DO
    SET
-   >>> E-maj successfully uninstalled
+   >>> E-maj successfully uninstalled from this database
 
diff --git a/docs/en/upgrade.rst b/docs/en/upgrade.rst
@@ -4,7 +4,9 @@ Upgrade an existing E-Maj version
 General approach
 ----------------
 
-The process to update E-Maj version depends on the already installed E-Maj version. 
+The first step consists in :doc:`installing the new version of the E-Maj software <install>`. Keep the old E-Maj version directory at least until the end of the upgrade. Some files may be needed.
+
+Then the process to upgrade an E-Maj extension in a database depends on the already installed E-Maj version.
 
 For E-Maj versions prior 0.11.0, there is no particular update procedure. A simple  E-Maj deletion and then re-installation has to be done. This approach can also be used for any E-Maj version, even though it has a drawback: all log contents are deleted, resulting in no further way to rollback or look at the recorded updates.  
 

diff --git a/docs/fr/download.rst b/docs/fr/download.rst