From 63b0e0356ea41dda91966ebcca03d646fc26db97 Mon Sep 17 00:00:00 2001 From: Fabio Sinibaldi Date: Wed, 6 Jul 2022 18:54:55 +0200 Subject: [PATCH] Documentation --- use-cases/src/site/sphinx/conf.py | 2 +- use-cases/src/site/sphinx/project.rst | 30 ++++++++++++++++----------- use-cases/src/site/sphinx/suite.rst | 4 ++-- 3 files changed, 21 insertions(+), 15 deletions(-) diff --git a/use-cases/src/site/sphinx/conf.py b/use-cases/src/site/sphinx/conf.py index ebbcff3..ca964f7 100644 --- a/use-cases/src/site/sphinx/conf.py +++ b/use-cases/src/site/sphinx/conf.py @@ -13,7 +13,7 @@ master_doc = 'suite' pygments_style = 'tango' add_function_parentheses = True -extensions = ['recommonmark', 'sphinx.ext.autodoc', 'sphinxcontrib.plantuml'] +extensions = ['recommonmark', 'sphinx.ext.autodoc', 'sphinxcontrib.plantuml','sphinxemoji','sphinxcontrib-redoc'] templates_path = ['_templates'] exclude_trees = ['.build'] diff --git a/use-cases/src/site/sphinx/project.rst b/use-cases/src/site/sphinx/project.rst index 5a5c916..ec08d40 100644 --- a/use-cases/src/site/sphinx/project.rst +++ b/use-cases/src/site/sphinx/project.rst @@ -8,7 +8,8 @@ Project Model :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 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 :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.. -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 -**************** +================ -********************* +===================== Lifecycle Information -********************* +===================== -********************** +====================== Accounting Information -********************** +====================== -************ +============ The Document -************ +============ + -======== FileSets -======== +******** Manifestations diff --git a/use-cases/src/site/sphinx/suite.rst b/use-cases/src/site/sphinx/suite.rst index 1ef1bb4..43be54b 100644 --- a/use-cases/src/site/sphinx/suite.rst +++ b/use-cases/src/site/sphinx/suite.rst @@ -2,12 +2,12 @@ .. _wiki: 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 ############### -.. note:: gCube CMS Suite is a gCube Application. Check more about gCube `here`_. +.. 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`_).