Docs

geoportal-service/docs/conf.py

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'gCube CMS Suite'
+copyright = '2022, Fabio Sinibaldi ISTI - CNR'
+author = 'Fabio Sinibaldi'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

geoportal-service/docs/index.rst

@@ -8,9 +8,9 @@
 ###############
 gCube CMS Suite
 ###############
-.. note:: gCube CMS Suite is a gCube Application. Check out more about `gCube`_ |:smile:| .
+.. note:: gCube CMS Suite is a gCube Application. Check out more about 'gCube'_.
 
-**gCube CMS Suite** is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure (see wiki `wiki`_).
+**gCube CMS Suite** is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure (see `wiki`_).
 
 .. figure:: _static/imgs/suite.png
    :alt: CMS Suite overall concept
@@ -26,18 +26,18 @@ It can manage the entire lifecycle of Projects, from their creation to access in
 
 The gCube CMS Suite key features are :
 
-- Support for publication lifecycle
+* Support for publication lifecycle
-  -By supporting complex Data (Meta + Payloads) archives known as :doc:`project`
+  *By supporting complex Data (Meta + Payloads) archives known as :doc:`project`
-  -By enabling versioning, workflows, access policies
+  *By enabling versioning, workflows, access policies
-  -By supporting several manifestations (GIS, Databases, ...)
+  *By supporting several manifestations (GIS, Databases, ...)
-  -By managing indexes (Meta catalogues, Index GIS layers)
+  *By managing indexes (Meta catalogues, Index GIS layers)
-- Maximise re-usability
+* Maximise re-usability
-  - By providing an extensible marketplace of plugins
+  * By providing an extensible marketplace of plugins
-  - By allowing for configurable behaviour
+  * By allowing for configurable behaviour
-  - By supporting a generic meta-model
+  * By supporting a generic meta-model
-  - By offering configurable GUIs (Management grid, Insert/Edit Form, Data Viewers)
+  * By offering configurable GUIs (Management grid, Insert/Edit Form, Data Viewers)
-- External Data Integration
+* External Data Integration
-  - By exploiting OGC standards.
+  * By exploiting OGC standards.
 
 Contents of this guide :
 *************************
@@ -51,5 +51,4 @@ Contents of this guide :
    plugins
    ucd
    quickstart
-   example
+   example
-   md

geoportal-service/pom.xml

@@ -199,9 +199,10 @@
 				<artifactId>sphinx-maven-plugin</artifactId>
 				<version>2.10.0</version>
 				<configuration>
-					<outputDirectory>${project.build.directory}/wiki</outputDirectory>
+					<outputDirectory>${project.build.directory}/${project.artifactId}-${project.version}/docs</outputDirectory>
 					<builder>html</builder>
-					<configDirectory>src/site/sphinx</configDirectory>
+					<configDirectory>${basedir}/docs</configDirectory>
+					<sourceDirectory>${basedir}/docs</sourceDirectory>
 				</configuration>
 				<executions>
 					<execution>
@@ -214,8 +215,6 @@
 			</plugin>
 
 
-
-
 			<!-- Copy Enunciate Documentation from your-application/docs to your-application.war -->
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
@@ -236,11 +235,6 @@
 									<directory>${project.build.directory}/docs</directory>
 									<filtering>true</filtering>
 								</resource>
-								<resource>
-									<targetPath>${project.build.directory}/${project.artifactId}-${project.version}/docs/wiki</targetPath>
-									<directory>${project.build.directory}/wiki</directory>
-									<filtering>true</filtering>
-								</resource>
 							</resources>
 						</configuration>
 					</execution>

geoportal-service/src/site/sphinx/conf.py

@@ -1,31 +0,0 @@
-# -*- coding: utf-8 -*-
-import sys, os
-
-project = u'gCube CMS Suite'
-copyright = u'This software is part of the gCube Framework https://www.gcube-system.org/'
-version = '1.0'
-release = '1.0.0'
-
-# General options
-# themes https://sphinx-themes.org/
-needs_sphinx = '1.0'
-master_doc = 'suite'
-pygments_style = 'tango'
-add_function_parentheses = True
-
-extensions = ['recommonmark', 'sphinx.ext.autodoc', 'sphinxcontrib.plantuml','sphinxemoji','sphinxcontrib.redoc']
-
-templates_path = ['_templates']
-exclude_trees = ['.build']
-source_encoding = 'utf-8-sig'
-
-# HTML options
-html_theme = 'sphinx_rtd_theme'
-html_short_title = "gcube-cms-suite"
-htmlhelp_basename = 'gcube-cms-suite-docs'
-html_use_index = True
-html_show_sourcelink = True
-html_static_path = ['_static']
-
-# PlantUML options
-plantuml = os.getenv('plantuml')

geoportal-service/src/site/sphinx/md.md

@@ -1,70 +0,0 @@
-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)
-
-[<img src="https://gcube.wiki.gcube-system.org/images_gcube/e/e4/Geo_Portale%281%29.png">](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);
-