Merge branch 'M7-2019'

source/appendices.rst

@@ -8,7 +8,6 @@ The following is the list of appendices.
    :numbered: 1
    :maxdepth: 4
 
-   guidelines
    glossary
    licenses
 

source/conf.py

@@ -92,8 +92,9 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['replace.rst', 'dtp.rst', 'datasets', 'domains.rst', 'architecture.rst', 'howto/tourism/access.rst'] 
-
+exclude_patterns = ['replace.rst', 'dtp.rst', 'datasets', 'domains.rst',
+                    'architecture.rst', 'howto/tourism/access.rst',
+                    'guidelines', 'contributors.rst'] 
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

source/contribute.rst

@@ -88,12 +88,11 @@ tasks to be carried out:
 
 
 #. Learn how to successfully integrate your code with the existing
-   code-base and how to interact with the |odh| team.
-
-   In other words, you need to read and accept the
-   :ref:`devel-guidelines`, summarised there and available in two
-   separate parts: :doc:`guidelines/platform` and
-   :doc:`guidelines/database`.
+   code-base and how to interact with the |odh| team.  In other words,
+   you need to read and accept the :ref:`devel-guidelines` (click on
+   the link for a summary), which are available in two extended,
+   separate parts: :ref:`platform-guidelines` and
+   :ref:`db-guidelines`.
 
 #. Understand the :ref:`architecture-odh`.
 #. Learn about the :ref:`dtp-env`.
@@ -102,17 +101,13 @@ tasks to be carried out:
    including PostgreSQL with postgis extension, JDK, git.
 #. Set up all the services needed (database, application server, and
    so on).
-#. Clone our git repositories.
-
-   To successfully complete these tasks, please read the
-   :ref:`development` tutorial, which guides you stepwise through all
-   the required set up and configuration, along with some
-   troubleshooting advice.
-
+#. Clone our git repositories.  To successfully complete these tasks,
+   please read the :ref:`development` tutorial, which guides you
+   stepwise through all the required set up and configuration, along
+   with some troubleshooting advice.
 
-#. Coding.
 
-   That's the funniest part, enjoy!
+#. Coding. That's the funniest part, enjoy!
 
 To support the installation tasks and ease the set up of your
 workstation, we are developing a script the you will do the job for

source/contributors.rst

@@ -34,6 +34,7 @@ Before starting the development, you need to fork the original
    username and password.
 
    .. figure:: /images/contributors/fork.png
+      :scale: 90%
 
       Fork the repository.
 
@@ -50,7 +51,8 @@ Before starting the development, you need to fork the original
    .. _checkout-pic:
 
    .. figure:: /images/contributors/checkout.png
-
+      :scale: 90%
+
       Clone the repository.
 
 Create a pull request
@@ -92,7 +94,8 @@ you need to follow the following steps.
    .. _create-pr:
 
    .. figure:: /images/contributors/create-pull-request-development.png
-
+      :scale: 90%
+
       Create a pull request.
 
    You can write some description as well, to describe your changes.
@@ -106,7 +109,8 @@ you need to follow the following steps.
    .. _pr-ok:
 
    .. figure:: /images/contributors/show-pull-request-ok-development.png
-
+      :scale: 90%
+
       Show outcome of a pull request.
 
 8. In addition, the detailed logs can be viewed under
@@ -189,9 +193,9 @@ shown in :numref:`merge-conflict-picture`.
 
 .. _merge-conflict-picture:
 
-.. figure::
-   /images/contributors/merge-conflicts-conflicts-development.png
-
+.. figure:: /images/contributors/merge-conflicts-conflicts-development.png
+   :scale: 90%
+	   
    A Merge Conflict.
 
 To resolve merge conflicts, the following steps must be performed.
@@ -219,19 +223,19 @@ To resolve merge conflicts, the following steps must be performed.
 
    .. _merge-conflict-output:
 
-   .. figure::
-      /images/contributors/merge-conflicts-output-development.png
-
+   .. figure:: /images/contributors/merge-conflicts-output-development.png
+      :scale: 90%
+	      
       Merge conflicts output.
 
 4. Go the the listed files of the previous output and resolve all
    merge conflicts. The conflicts in the files begin with
    :literal:`<<<<<<<` and end with :literal:`>>>>>>>`. The
    :literal:`=======` separates the two versions.
 
-   .. figure::
-      /images/contributors/merge-conflicts-solving-development.png
-
+   .. figure:: /images/contributors/merge-conflicts-solving-development.png
+      :scale: 90%
+	      
       Solving a merge conflicts.
 
    You can resolve a conflict by simply deleting one of the two
@@ -256,9 +260,9 @@ To resolve merge conflicts, the following steps must be performed.
 6. After resolving the merge conflicts, the pull request can be
    accepted.
 
-   .. figure::
-      /images/contributors/merge-conflicts-resolved-development.png 
-
+   .. figure:: /images/contributors/merge-conflicts-resolved-development.png 
+      :scale: 90%
+	      
       A solved merge conflict. 
 
 A more detailed description can be found in the online Github help: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/.

source/guidelines.rst

@@ -3,17 +3,15 @@
 Resources for Developers
 =========================
 
-This appendix contains all information that are necessary to
+This section contains all information that are necessary to
 developers that want to collaborate with the |odh| team (e.g.,
 developers that send pull requests to the |odh| repositories) or are
 contracted to write code for the |odh| project (|odh| Core Hacker) or
 app
 
-.. toctree::
-   :maxdepth: 2
 
-   guidelines/introduction
-   guidelines/platform
-   guidelines/database
-   guidelines/dtp
-   contributors
+.. include:: /guidelines/introduction.rst
+.. include:: /guidelines/platform.rst
+.. include:: /guidelines/database.rst
+.. include:: /guidelines/dtp.rst
+.. include:: /contributors.rst

source/guidelines/platform.rst

@@ -442,4 +442,4 @@ the database from Java or JavaScript:
 Database Design and Usage
 _________________________
 
-This section is moved into its own document, :doc:`database`.
+This section has been moved into its own document, :ref:`db-guidelines`.

source/index.rst

@@ -14,6 +14,7 @@ Welcome to |odh| Documentation Repository!
    Introduction & Project Overview <intro>
    datasets
    contribute
+   guidelines
    howto
    applist
    faq