From a4fddb9870d3de80361a62d3f4caa20933a715a8 Mon Sep 17 00:00:00 2001 From: Fabio Sinibaldi Date: Fri, 8 Jul 2022 17:25:00 +0200 Subject: [PATCH] Doc fixes --- geoportal-service/pom.xml | 24 ++----------------- .../src/site/sphinx/lifecycle.rst | 5 ++-- geoportal-service/src/site/sphinx/project.rst | 2 +- 3 files changed, 6 insertions(+), 25 deletions(-) diff --git a/geoportal-service/pom.xml b/geoportal-service/pom.xml index f95b123..e176eb7 100644 --- a/geoportal-service/pom.xml +++ b/geoportal-service/pom.xml @@ -252,34 +252,14 @@ ${project.build.directory}/docs true - - - - - - - - - - - - copy-sphinx-docs - process-resources - - copy-resources - - - target - - ${project.build.directory}/${project.artifactId}-${project.version}/docs/wiki + ${project.build.directory}/${project.artifactId}-${project.version}/wiki ${project.build.directory}/wiki - false + true - diff --git a/geoportal-service/src/site/sphinx/lifecycle.rst b/geoportal-service/src/site/sphinx/lifecycle.rst index a4c5270..5be7469 100644 --- a/geoportal-service/src/site/sphinx/lifecycle.rst +++ b/geoportal-service/src/site/sphinx/lifecycle.rst @@ -19,7 +19,7 @@ However they may change, each **project** lifecycle starts from the predefined ` .. figure:: _static/imgs/2phase_lc.png :alt: PHASES and STEPS - A :ref:`2phase` lifecycle. + A 2-phase lifecycle. In the figure above is represented a 2-PHASES lifecycle. In green, STEPS and PHASES defined by the lifecycle itself. @@ -88,7 +88,8 @@ Registering / Unregistering FileSets :ref:`filesets` are sets of files representing a single entity, which need to be handled together (e.g. a dataset and its index, a file and its crc). Each :ref:`filesets` is (un)registered at a particular path of the :ref:`document` with requests with the following information : -.. warning:: Filesets fields need to be defined in :ref:`ucd` in order to be registered. + +.. warning:: Filesets fields need to be defined in :doc:`ucd` in order to be registered. - field Name : **fileset** target field name - parent path : the path of the target parent for the *fileset* diff --git a/geoportal-service/src/site/sphinx/project.rst b/geoportal-service/src/site/sphinx/project.rst index 11ad7c4..d7ed37c 100644 --- a/geoportal-service/src/site/sphinx/project.rst +++ b/geoportal-service/src/site/sphinx/project.rst @@ -139,7 +139,7 @@ Filesets can be processed in various way by exploiting gCube Applications capabi - ... Either by deploying a dataset onto specific engine or by generating other resources by processing the fileset, we register this new information as a fileset **manifestation**. -The :ref:`suite` relies on :ref:`plugins` in order to deal with specific tasks (dealing with DataMiner, publishing on SDI, pushing to gCat..). +The :doc:`suite` relies on :doc:`plugins` in order to deal with specific tasks (dealing with DataMiner, publishing on SDI, pushing to gCat..). A manifestation contains at least the following information :