From 178436292375b4615e1969f85a1ac4e2fd003832 Mon Sep 17 00:00:00 2001 From: Didier Vojtisek Date: Tue, 28 Jun 2022 18:00:02 +0200 Subject: [PATCH] Improve documentation (#266) * improved links to dev readme * add info about the continuous integration * added a section about the current protocol generator Signed-off-by: Didier Vojtisek --- README.md | 5 +- dev_support/jenkins/README.asciidoc | 57 +++++++++++++++++++ .../pomfirst_full_compilation/README.asciidoc | 2 + .../tycho_full_compilation/README.asciidoc | 3 +- docs/org.eclipse.gemoc.studio.doc/pom.xml | 4 ++ .../dev/Protocols_headContent.asciidoc | 3 +- .../src/main/asciidoc/master.asciidoc | 4 +- 7 files changed, 73 insertions(+), 5 deletions(-) create mode 100644 dev_support/jenkins/README.asciidoc diff --git a/README.md b/README.md index 84d6b213..1dc51954 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,9 @@ If you wish to contribute to the project, you'll find some guidance and tip and Development ============ -- Instructions about how to build locally the eclipse studio are available in this readme page https://github.com/eclipse/gemoc-studio/tree/master/dev_support/tycho_full_compilation or in the [studio documentation](http://download.eclipse.org/gemoc/docs/nightly/_contributing.html#_compilation_of_the_complete_gemoc_studio). -- Instructions about how to build locally the pomfirst components are available in this readme page https://github.com/eclipse/gemoc-studio/tree/master/dev_support/pomfirst_full_compilation. +A dedicated section is available in the [documentation](http://download.eclipse.org/gemoc/docs/nightly/_contributing.html). +- Instructions about how to build locally the eclipse studio are available in this readme page https://github.com/eclipse/gemoc-studio/tree/master/dev_support/tycho_full_compilation (or in the [documentation](http://download.eclipse.org/gemoc/docs/nightly/_contributing.html#_compilation_of_the_complete_gemoc_studio)). +- Instructions about how to build locally the pomfirst components are available in this readme page https://github.com/eclipse/gemoc-studio/tree/master/dev_support/pomfirst_full_compilation (or in the [documentation](https://download.eclipse.org/gemoc/docs/nightly/_contributing.html#_compilation_of_the_pom_first_jar)). - Continuous integration on [Eclipse CI](https://ci.eclipse.org/gemoc/job/gemoc-studio/) diff --git a/dev_support/jenkins/README.asciidoc b/dev_support/jenkins/README.asciidoc new file mode 100644 index 00000000..c6c483a0 --- /dev/null +++ b/dev_support/jenkins/README.asciidoc @@ -0,0 +1,57 @@ +//////////////////////////////////////////////////////////////// +// Reproduce title only if not included in master documentation +//////////////////////////////////////////////////////////////// +ifndef::includedInMaster[] + += Developer Guide +== Contributing + +endif::[] + +=== Continuous integration + +footnote:[asciidoc source of this page: https://github.com/eclipse/gemoc-studio/tree/master/dev_support/jenkins] + + +==== Introduction + +The continuous integration of the project uses an integration repository with git submodules in order +to have a complete build + +Some synchronization jobs allow to automate the management of the git submodules. +It uses a branch naming schema in order to automatically associate branches having the same names. +(it uses https://github.com/gemoc/git-sync-tools) +See the readme in https://github.com/gemoc/gemoc-studio-eclipse-integration/ for links to the synchronization jobs. + +==== Eclipse organization continuous integration + +This is the official continuous integration for preparing new official releases. + +- https://github.com/gemoc/gemoc-studio-eclipse-integration/ : Integration repository (with sub modules) containing the branches that will be built. +- https://ci.eclipse.org/gemoc/job/gemoc-studio-integration/ : Jenkins build for all branches of GEMOC projects in github Eclipse organisation + +==== Community (GEMOC organization) continuous integration + +[TIP] +==== +In order to prepare pull request, even if you aren't an official eclipse commiter, +if you wish to have a CI support to make sure that your contribution will +work smoothly before proposing it to Eclipse organization, you can ask to be part of the GEMOC initiative. + +This initiative manages a fork of Eclipse GEMOC projects and a dedicated CI working on these +forked repositories. +==== + +The forked repositories are hosted in the https://github.com/gemoc organization. +The associated CI is hosted by one of the initiative partner at https://ci.inria.fr/gemoc/job/gemoc-studio-eclipseforks-integration/ + +It works using the similar synchronization jobs as the main Eclipse integration. + +As its goal is to help prepare pull request to the official repositories, the _master_ branches of the community repositories are +automatically synched using Eclipse repositories _master_ branches. + +- https://github.com/gemoc/gemoc-studio-eclipseforks-integration/ : Integration repository (sub modules) for the community + + + + diff --git a/dev_support/pomfirst_full_compilation/README.asciidoc b/dev_support/pomfirst_full_compilation/README.asciidoc index b84e9d89..dcb19f85 100644 --- a/dev_support/pomfirst_full_compilation/README.asciidoc +++ b/dev_support/pomfirst_full_compilation/README.asciidoc @@ -11,6 +11,8 @@ endif::[] === Compilation of the pom first jar +footnote:[asciidoc source of this page: https://github.com/eclipse/gemoc-studio/tree/master/dev_support/pomfirst_full_compilation] + ==== Introduction Some of the components provided as part of the GEMOC Studio are now available as pomfirst. This means that the jar are compiled and provided using diff --git a/dev_support/tycho_full_compilation/README.asciidoc b/dev_support/tycho_full_compilation/README.asciidoc index 4a2c4a3c..06463b25 100644 --- a/dev_support/tycho_full_compilation/README.asciidoc +++ b/dev_support/tycho_full_compilation/README.asciidoc @@ -8,9 +8,10 @@ ifndef::includedInMaster[] endif::[] - === Compilation of the complete GEMOC Studio +footnote:[asciidoc source of this page: https://github.com/eclipse/gemoc-studio/tree/master/dev_support/tycho_full_compilation] + ==== Introduction The source code of the [GEMOC Studio](http://gemoc.org/studio/) is currently spread among different git repositories in Eclipse organization. diff --git a/docs/org.eclipse.gemoc.studio.doc/pom.xml b/docs/org.eclipse.gemoc.studio.doc/pom.xml index b001ef9c..3332d738 100644 --- a/docs/org.eclipse.gemoc.studio.doc/pom.xml +++ b/docs/org.eclipse.gemoc.studio.doc/pom.xml @@ -172,6 +172,10 @@ ${basedir}/../../../gemoc-studio-modeldebugging/commons/docs/dev/images images + ${basedir}/../../../gemoc-studio-modeldebugging/protocols/engine_addon_protocol/docs/images images diff --git a/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/dev/Protocols_headContent.asciidoc b/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/dev/Protocols_headContent.asciidoc index 9f4a7981..74725d9c 100644 --- a/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/dev/Protocols_headContent.asciidoc +++ b/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/dev/Protocols_headContent.asciidoc @@ -17,7 +17,8 @@ For consistency, these protocols are defined using the same mechanism as LSP. However, in order to be deployed internally in web browsers, instead of defining a socket or a port for each protocol, most implementation in the studio use websockets. -For convenience, an extensible websocket server is provided as an eclipse plugin. This allows to deploy a new endpoint in any eclipse based application or IDE, +For convenience, an extensible websocket server is provided as an eclipse plugin (see <>). +This allows deploying new endpoints in any eclipse based application or IDE, simply by adding a plugin extension. <> shows an overview of the components that offer or use the protocols in the Eclipse Studio. diff --git a/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/master.asciidoc b/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/master.asciidoc index 2b97b5ca..92f44e7f 100644 --- a/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/master.asciidoc +++ b/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/master.asciidoc @@ -320,13 +320,15 @@ include::../../../../../../gemoc-studio-execution-ale/docs/dev/ALEExecution.asci include::dev/Protocols_headContent.asciidoc[] +include::../../../../../../gemoc-studio-modeldebugging/protocols/generators/docs/ProtocolGenerators.asciidoc[] + include::../../../../../../gemoc-studio-modeldebugging/protocols/engine_addon_protocol/docs/EngineAddonProtocol.asciidoc[] == Contributing - include::../../../../../../gemoc-studio/dev_support/tycho_full_compilation/README.asciidoc[] include::../../../../../../gemoc-studio/dev_support/pomfirst_full_compilation/README.asciidoc[] +include::../../../../../../gemoc-studio/dev_support/jenkins/README.asciidoc[] === Developing new features