From 5c8d476e56a283ccdb151662db100297fc78a1cb Mon Sep 17 00:00:00 2001 From: Fabio Sinibaldi Date: Tue, 5 Jul 2022 17:22:22 +0200 Subject: [PATCH] Documentation --- README.md | 26 ++++++++++++++++++++++---- sdi-plugins/README.md | 19 ++++++++----------- use-cases/README.md | 14 ++++++++------ 3 files changed, 38 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 85dd719..f827736 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ gCube CMS Suite -------------------------------------------------- -gCube CMS Suite is a set of components designed to manage complex space-temporal Documents defined by metadata Profiles. +gCube CMS Suite is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure. Check wiki [here]() + +[](https://www.sphinx-doc.org/en/master/) + + +Rationale : + +Publication involves lots of common features as well as custom behaviour and formats. The service implements the basic common logic, delegating to installed plugin both cutom and configurable functions ranging from validation, data manifestazion, indexing and lifecycle management. +Lifecycle management is itself an extension allowing for both common and complex ad-hoc workflows. +High modularity of plugins allows for the composition of ad hoc use cases with maximized reusability. + +The suite comes with a set of pre-built plugins and GUIs that comunuties can easily extend and / or reuse. + + +## Documentation +* [Dedicated Wiki]() - TBD Powered by [Sphynx] (https://www.sphinx-doc.org/en/master/) +* [Service Interactive API]() -TBD Powered by [Enunciate] (http://enunciate.webcohesion.com/) +* [Gcube System Wiki] - (https://gcube.wiki.gcube-system.org/gcube/GeoPortal). +* [Guide Notebooks](use-cases) - Powered by [Jupyter] (https://jupyter.org/) +* [Service Wiki src] (use-cases/src/site/suite.rst) + ## Built with * [gCube SmartGears] (https://gcube.wiki.gcube-system.org/gcube/SmartGears) - The gCube SmartGears framework @@ -9,10 +29,8 @@ gCube CMS Suite is a set of components designed to manage complex space-temporal * [JAX-RS](https://github.com/eclipse-ee4j/jaxrs-api) - Java™ API for RESTful Web Services * [Jersey](https://jersey.github.io/) - JAX-RS runtime * [Maven](https://maven.apache.org/) - Dependency Management +* [Enunciate] (http://enunciate.webcohesion.com/) - API Documentation -## Documentation - -Documentation can be found [here](https://gcube.wiki.gcube-system.org/gcube/GeoPortal_Service). ## Change log diff --git a/sdi-plugins/README.md b/sdi-plugins/README.md index 85dd719..e91c7f9 100644 --- a/sdi-plugins/README.md +++ b/sdi-plugins/README.md @@ -1,23 +1,20 @@ -gCube CMS Suite +gCube CMS Suite : SDI Plugins -------------------------------------------------- -gCube CMS Suite is a set of components designed to manage complex space-temporal Documents defined by metadata Profiles. - -## Built with -* [gCube SmartGears] (https://gcube.wiki.gcube-system.org/gcube/SmartGears) - The gCube SmartGears framework -* [OpenJDK](https://openjdk.java.net/) - The JDK used -* [JAX-RS](https://github.com/eclipse-ee4j/jaxrs-api) - Java™ API for RESTful Web Services -* [Jersey](https://jersey.github.io/) - JAX-RS runtime -* [Maven](https://maven.apache.org/) - Dependency Management +[gCube CMS Suite](../README.md) module containing references, documentation, guides ad utilities. + ## Documentation +* [Dedicated Wiki]() - TBD Powered by [Sphynx] (https://www.sphinx-doc.org/en/master/) +* [Service Interactive API]() -TBD Powered by [Enunciate] (http://enunciate.webcohesion.com/) +* [Gcube System Wiki] - (https://gcube.wiki.gcube-system.org/gcube/GeoPortal). +* [Guide Notebooks](use-cases) - Powered by [Jupyter] (https://jupyter.org/) +* [Service Wiki src] (use-cases/src/site/suite.rst) -Documentation can be found [here](https://gcube.wiki.gcube-system.org/gcube/GeoPortal_Service). ## Change log See [CHANGELOG.md](CHANGELOG.md). - ## License This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details. diff --git a/use-cases/README.md b/use-cases/README.md index b80f923..3948e63 100644 --- a/use-cases/README.md +++ b/use-cases/README.md @@ -1,14 +1,16 @@ -GeoPortal - Client +gCube CMS Suite : Use cases -------------------------------------------------- -GeoPortal - Client is the java library wrapping Geoportal REST Service - -## Built with -* [Maven](https://maven.apache.org/) - Dependency Management +[gCube CMS Suite](../README.md) module containing references, documentation, guides ad utilities. + ## Documentation +* [Dedicated Wiki]() - TBD Powered by [Sphynx] (https://www.sphinx-doc.org/en/master/) +* [Service Interactive API]() -TBD Powered by [Enunciate] (http://enunciate.webcohesion.com/) +* [Gcube System Wiki] - (https://gcube.wiki.gcube-system.org/gcube/GeoPortal). +* [Guide Notebooks](use-cases) - Powered by [Jupyter] (https://jupyter.org/) +* [Service Wiki src] (use-cases/src/site/suite.rst) -Documentation can be found [here](https://gcube.wiki.gcube-system.org/gcube/GeoPortal). ## Change log