gCubeSystem
/
gcube-cms-suite
15
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation

This commit is contained in:
Fabio Sinibaldi 2022-07-06 18:54:55 +02:00
parent 3b9f49529f
commit 63b0e0356e
3 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
use-cases/src/site/sphinx/conf.py
View File

@ -13,7 +13,7 @@ master_doc = 'suite'
pygments_style = 'tango' pygments_style = 'tango'
add_function_parentheses = True add_function_parentheses = True
extensions = ['recommonmark', 'sphinx.ext.autodoc', 'sphinxcontrib.plantuml'] extensions = ['recommonmark', 'sphinx.ext.autodoc', 'sphinxcontrib.plantuml','sphinxemoji','sphinxcontrib-redoc']
templates_path = ['_templates'] templates_path = ['_templates']
exclude_trees = ['.build'] exclude_trees = ['.build']

30
use-cases/src/site/sphinx/project.rst
View File

@ -8,7 +8,8 @@ Project Model
:doc:`suite` allows to manage the publication lifecycle of complex documents called **Projects** , i.e. documents made by : :doc:`suite` allows to manage the publication lifecycle of complex documents called **Projects** , i.e. documents made by :
* A lot of different set of files (pdf, docs, imgs, GIS data, csv...) * A lot of different set of files (pdf, docs, imgs, GIS data, csv...)
* A custom metadata model (title, author, repetible complex fields..) * A custom metadata model (mixed information, data description, repetible complex fields..)
* Common publication management metadata (author, creation date, version, publication phase, moderation messages, operation log)
.. image:: _static/imgs/project.png .. image:: _static/imgs/project.png
:alt: Project :alt: Project
@ -16,27 +17,32 @@ Project Model
.. note:: Every **Project** is associated to a :doc:`ucd` that defines among other things its structure, its lifecycle, access rules etc.. .. note:: Every **Project** is associated to a :doc:`ucd` that defines among other things its structure, its lifecycle, access rules etc..
Each Project is defined as a JSON Document having the following sections *****************
Project structure
*****************
A **Project** is a JSON Document with the following sections :
****************
================
Core Information Core Information
**************** ================
********************* =====================
Lifecycle Information Lifecycle Information
********************* =====================
********************** ======================
Accounting Information Accounting Information
********************** ======================
************ ============
The Document The Document
************ ============
========
FileSets FileSets
======== ********
Manifestations Manifestations

4
use-cases/src/site/sphinx/suite.rst
View File

@ -2,12 +2,12 @@
.. _wiki: https://gcube.wiki.gcube-system.org/gcube/GeoPortal .. _wiki: https://gcube.wiki.gcube-system.org/gcube/GeoPortal
.. _gWiki: https://gcube.wiki.gcube-system.org/gcube/GeoPortal .. _gWiki: https://gcube.wiki.gcube-system.org/gcube/GeoPortal
.. _gCube: https://www.gcube-system.org
############### ###############
gCube CMS Suite gCube CMS Suite
############### ###############
.. note:: gCube CMS Suite is a gCube Application. Check more about gCube `here<https://www.gcube-system.org/>`_. .. note:: gCube CMS Suite is a gCube Application. Check out more about `gCube`_ |:smile:| .
**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 `wiki`_).