Update developer documentation

Jürgen Knödlseder
1 parent 5490d91b
Showing 8 changed files with 71 additions and 53 deletions
doc/source/develop/contributing.rst
doc/source/develop/index.rst
doc/source/develop/releasing/check.png
doc/source/develop/releasing/check.rst
doc/source/develop/releasing/index.rst
doc/source/develop/releasing/pipeline.png
doc/source/develop/releasing/release.png
doc/source/develop/releasing/pipeline.rst → doc/source/develop/releasing/release.rst
-.. _dev_contributing:
-
-Contributing to GammaLib
-========================
-
-GammaLib is an open source projet and you are highly welcome to contribute
-to the development.
-Contributions can come in any areas: writing C++ code, contributing Python 
-scripts, writing documentation, testing code, etc.
-
-We manage the GammaLib source code using `GitLab <https://cta-gitlab.irap.omp.eu>`_.
-We also have a `Redmine <https://cta-redmine.irap.omp.eu/projects/gammalib/>`_
-development platform to track issues.
-We use a continuous integration system based on
-`Jenkins <https://cta-jenkins.irap.omp.eu>`_
-and we monitor our code quality with
-`SonarQube <https://cta-sonar.irap.omp.eu/overview?id=612>`_.
-
-You may also want to get in the GammaLib information flow by subscribing to 
-the ctools@irap.omp.eu mailing list.
-To subscribe simply send an e-mail to ctools-subscribe@irap.omp.eu.
-
-We are organising regular `Coding sprints <https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Coding_sprints>`_
-to allow newcomers to get familiar with the code base and the coding practices.
-You are highly invited to join one of the next coding sprints.
-
-You can also follow `@gammalib <https://twitter.com/gammalib>`_ on
-twitter to get informed about new releases of GammaLib.
-
-Below some useful links:
-
-* `GitLab <https://cta-gitlab.irap.omp.eu/gammalib/gammalib>`_
-* `GitHub <https://github.com/gammalib/gammalib>`_
-* `Redmine <https://cta-redmine.irap.omp.eu/projects/gammalib>`_
-* `Open HUB <https://www.openhub.net/p/gammalib>`_
-* `Source code documentation (Doxygen) <../doxygen/index.html>`_
-
-.. image:: https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=gammalib-integrate-os
-   :target: https://cta-jenkins.irap.omp.eu/job/gammalib-integrate-os
-   :alt: Build Status
-
-.. image:: https://cta-sonar.irap.omp.eu/api/badges/gate?key=gammalib
-   :target: https://cta-sonar.irap.omp.eu/dashboard/index/gammalib
-   :alt: Quality Gate
@@ -3,12 +3,53 @@
 Developer documentation
 =======================
  
+GammaLib is an open source projet and you are highly welcome to contribute
+to the development.
+Contributions can come in any areas: writing C++ code, contributing Python 
+scripts, writing documentation, testing code, etc.
+
+We manage the GammaLib source code using `GitLab <https://cta-gitlab.irap.omp.eu>`_.
+We also have a `Redmine <https://cta-redmine.irap.omp.eu/projects/gammalib/>`_
+development platform to track issues.
+We use a continuous integration system based on
+`Jenkins <https://cta-jenkins.irap.omp.eu>`_
+and we monitor our code quality with
+`SonarQube <https://cta-sonar.irap.omp.eu/overview?id=612>`_.
+
+You may also want to get in the GammaLib information flow by subscribing to 
+the ctools@irap.omp.eu mailing list.
+To subscribe simply send an e-mail to ctools-subscribe@irap.omp.eu.
+
+We are organising regular `Coding sprints <https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Coding_sprints>`_
+to allow newcomers to get familiar with the code base and the coding practices.
+You are highly invited to join one of the next coding sprints.
+
+You can also follow `@gammalib <https://twitter.com/gammalib>`_ on
+twitter to get informed about new releases of GammaLib.
+
+Below some useful links:
+
 .. toctree::
    :maxdepth: 1
  
-   contributing
-   howto/index
    git/index
    coding/index
+   howto/index
    profiling/index
    releasing/index
+
+Links:
+
+* `GitLab <https://cta-gitlab.irap.omp.eu/gammalib/gammalib>`_
+* `GitHub <https://github.com/gammalib/gammalib>`_
+* `Redmine <https://cta-redmine.irap.omp.eu/projects/gammalib>`_
+* `Open HUB <https://www.openhub.net/p/gammalib>`_
+* `Source code documentation (Doxygen) <../doxygen/index.html>`_
+
+.. image:: https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=gammalib-integrate-os
+   :target: https://cta-jenkins.irap.omp.eu/job/gammalib-integrate-os
+   :alt: Build Status
+
+.. image:: https://cta-sonar.irap.omp.eu/api/badges/gate?key=gammalib
+   :target: https://cta-sonar.irap.omp.eu/dashboard/index/gammalib
+   :alt: Quality Gate
+.. _dev_releasing_check:
+
+Launch the release check pipeline
+=================================
+
+Once you have checked that the code is complete and unit tests were added
+for all new code, connect to
+`Jenkins <https://cta-jenkins.irap.omp.eu/view/Release/job/release-check-gammalib/>`_
+and launch the GammaLib release check pipeline by clicking on the
+``Build with Parameters`` link:
+
+.. figure:: check.png
+   :width: 600px
+   :align: center
+
+   *GammaLib release check pipeline*
+
+In case that any errors occur during running the release check pipeline, you
+should fix the errors and re-run the pipeline until it terminates with success.
@@ -9,7 +9,8 @@ To create a new GammaLib release you have to go through the following steps:
    :maxdepth: 1
  
    create
-   pipeline
+   check
+   release
    tag
    merge
    devel
@@ -3,16 +3,17 @@
 Launch the release pipeline
 ===========================
  
-Now you should connect to
-`Jenkins <https://cta-jenkins.irap.omp.eu>`_
-and launch the GammaLib release pipeline by clicking on the dedicated
-button:
+Once you have made a final check that all the User documentation is updated
+and accurate, connect to
+`Jenkins <https://cta-jenkins.irap.omp.eu/view/Release/job/release-gammalib/>`_
+and launch the GammaLib release pipeline by clicking on the
+``Build with Parameters`` link:
  
-.. figure:: pipeline.png
+.. figure:: release.png
    :width: 600px
    :align: center
  
    *GammaLib release pipeline*
  
 In case that any errors occur during running the release pipeline, you should
-fix the errors and rerun the pipeline until it terminates with success.
+fix the errors and re-run the pipeline until it terminates with success.