From 00413f47b3e442f05ab90ec107daaeb8e458cefb Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Fri, 24 May 2019 13:52:02 +0200 Subject: [PATCH] Update developer documentation --- doc/source/develop/contributing.rst | 44 -------------------------------------------- doc/source/develop/index.rst | 45 +++++++++++++++++++++++++++++++++++++++++++-- doc/source/develop/releasing/check.png | Bin 0 -> 392770 bytes doc/source/develop/releasing/check.rst | 19 +++++++++++++++++++ doc/source/develop/releasing/index.rst | 3 ++- doc/source/develop/releasing/pipeline.png | Bin 447816 -> 0 bytes doc/source/develop/releasing/pipeline.rst | 18 ------------------ doc/source/develop/releasing/release.png | Bin 0 -> 396804 bytes doc/source/develop/releasing/release.rst | 19 +++++++++++++++++++ 9 files changed, 83 insertions(+), 65 deletions(-) delete mode 100644 doc/source/develop/contributing.rst create mode 100644 doc/source/develop/releasing/check.png create mode 100644 doc/source/develop/releasing/check.rst delete mode 100644 doc/source/develop/releasing/pipeline.png delete mode 100644 doc/source/develop/releasing/pipeline.rst create mode 100644 doc/source/develop/releasing/release.png create mode 100644 doc/source/develop/releasing/release.rst diff --git a/doc/source/develop/contributing.rst b/doc/source/develop/contributing.rst deleted file mode 100644 index d946e0a..0000000 --- a/doc/source/develop/contributing.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _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 `_. -We also have a `Redmine `_ -development platform to track issues. -We use a continuous integration system based on -`Jenkins `_ -and we monitor our code quality with -`SonarQube `_. - -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 `_ -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 `_ on -twitter to get informed about new releases of GammaLib. - -Below some useful links: - -* `GitLab `_ -* `GitHub `_ -* `Redmine `_ -* `Open HUB `_ -* `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 diff --git a/doc/source/develop/index.rst b/doc/source/develop/index.rst index 79f8d6d..6ea227d 100644 --- a/doc/source/develop/index.rst +++ b/doc/source/develop/index.rst @@ -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 `_. +We also have a `Redmine `_ +development platform to track issues. +We use a continuous integration system based on +`Jenkins `_ +and we monitor our code quality with +`SonarQube `_. + +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 `_ +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 `_ 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 `_ +* `GitHub `_ +* `Redmine `_ +* `Open HUB `_ +* `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 diff --git a/doc/source/develop/releasing/check.png b/doc/source/develop/releasing/check.png new file mode 100644 index 0000000..82992d4 Binary files /dev/null and b/doc/source/develop/releasing/check.png differ diff --git a/doc/source/develop/releasing/check.rst b/doc/source/develop/releasing/check.rst new file mode 100644 index 0000000..fa3608d --- /dev/null +++ b/doc/source/develop/releasing/check.rst @@ -0,0 +1,19 @@ +.. _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 `_ +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. diff --git a/doc/source/develop/releasing/index.rst b/doc/source/develop/releasing/index.rst index a532905..3e6deb2 100644 --- a/doc/source/develop/releasing/index.rst +++ b/doc/source/develop/releasing/index.rst @@ -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 diff --git a/doc/source/develop/releasing/pipeline.png b/doc/source/develop/releasing/pipeline.png deleted file mode 100644 index 54f4188..0000000 Binary files a/doc/source/develop/releasing/pipeline.png and /dev/null differ diff --git a/doc/source/develop/releasing/pipeline.rst b/doc/source/develop/releasing/pipeline.rst deleted file mode 100644 index 8d19807..0000000 --- a/doc/source/develop/releasing/pipeline.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _dev_releasing_pipeline: - -Launch the release pipeline -=========================== - -Now you should connect to -`Jenkins `_ -and launch the GammaLib release pipeline by clicking on the dedicated -button: - -.. figure:: pipeline.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. diff --git a/doc/source/develop/releasing/release.png b/doc/source/develop/releasing/release.png new file mode 100644 index 0000000..d649a30 Binary files /dev/null and b/doc/source/develop/releasing/release.png differ diff --git a/doc/source/develop/releasing/release.rst b/doc/source/develop/releasing/release.rst new file mode 100644 index 0000000..bddadc4 --- /dev/null +++ b/doc/source/develop/releasing/release.rst @@ -0,0 +1,19 @@ +.. _dev_releasing_pipeline: + +Launch the release pipeline +=========================== + +Once you have made a final check that all the User documentation is updated +and accurate, connect to +`Jenkins `_ +and launch the GammaLib release pipeline by clicking on the +``Build with Parameters`` link: + +.. 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 re-run the pipeline until it terminates with success. -- libgit2 0.21.4