From fb8cdec9e2cb4d0f844c52057b879697294efd60 Mon Sep 17 00:00:00 2001 From: Fabio Sinibaldi Date: Tue, 26 Jul 2022 12:32:14 +0200 Subject: [PATCH] Doc fixes --- geoportal-service/src/site/sphinx/md.md | 70 +++++++++++++++++++++ geoportal-service/src/site/sphinx/suite.rst | 1 + 2 files changed, 71 insertions(+) create mode 100644 geoportal-service/src/site/sphinx/md.md diff --git a/geoportal-service/src/site/sphinx/md.md b/geoportal-service/src/site/sphinx/md.md new file mode 100644 index 0000000..f6b2dfb --- /dev/null +++ b/geoportal-service/src/site/sphinx/md.md @@ -0,0 +1,70 @@ +gCube CMS Suite +-------------------------------------------------- + +gCube CMS Suite is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure. Check wiki [here](https://sublime-and-sphinx-guide.readthedocs.io) + +[](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 re-usability. + +The suite comes with a set of pre-built plugins and GUIs that communities can easily extend and / or reuse. + + +## Documentation +* [Dedicated Wiki](https://sublime-and-sphinx-guide.readthedocs.io) - 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 +* [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 +* [Enunciate] (http://enunciate.webcohesion.com/) - API Documentation + + +## 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. + +## About the gCube Framework +This software is part of the [gCubeFramework](https://www.gcube-system.org/ "gCubeFramework"): an +open-source software toolkit used for building and operating Hybrid Data +Infrastructures enabling the dynamic deployment of Virtual Research Environments +by favouring the realisation of reuse oriented policies. + +The projects leading to this software have received funding from a series of European Union programmes including: + +- the Sixth Framework Programme for Research and Technological Development + - DILIGENT (grant no. 004260). +- the Seventh Framework Programme for research, technological development and demonstration + - D4Science (grant no. 212488); + - D4Science-II (grant no.239019); + - ENVRI (grant no. 283465); + - iMarine(grant no. 283644); + - EUBrazilOpenBio (grant no. 288754). +- the H2020 research and innovation programme + - SoBigData (grant no. 654024); + - PARTHENOS (grant no. 654119); + - EGIEngage (grant no. 654142); + - ENVRIplus (grant no. 654182); + - BlueBRIDGE (grant no. 675680); + - PerformFish (grant no. 727610); + - AGINFRAplus (grant no. 731001); + - DESIRA (grant no. 818194); + - ARIADNEplus (grant no. 823914); + - RISIS2 (grant no. 824091); + diff --git a/geoportal-service/src/site/sphinx/suite.rst b/geoportal-service/src/site/sphinx/suite.rst index 9bba601..e2001cb 100644 --- a/geoportal-service/src/site/sphinx/suite.rst +++ b/geoportal-service/src/site/sphinx/suite.rst @@ -52,3 +52,4 @@ Contents of this guide : ucd quickstart example + md \ No newline at end of file