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

Doc fixes

This commit is contained in:
Fabio Sinibaldi 2022-07-08 17:25:00 +02:00
parent 50979dee03
commit a4fddb9870
3 changed files with 6 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
geoportal-service/pom.xml
View File

@ -252,34 +252,14 @@
<directory>${project.build.directory}/docs</directory> <directory>${project.build.directory}/docs</directory>
<filtering>true</filtering> <filtering>true</filtering>
</resource> </resource>
<!-- <resource>-->
<!-- <targetPath>${project.build.directory}/${project.artifactId}-${project.version}/wiki</targetPath>-->
<!-- <directory>${project.build.directory}/wiki</directory>-->
<!-- <filtering>true</filtering>-->
<!-- </resource>-->
</resources>
</configuration>
</execution>
<!-- COPY SPHINX GENERATED SITE INTO WAR -->
<execution>
<id>copy-sphinx-docs</id>
<phase>process-resources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>target</outputDirectory>
<resources>
<resource> <resource>
<targetPath>${project.build.directory}/${project.artifactId}-${project.version}/docs/wiki</targetPath> <targetPath>${project.build.directory}/${project.artifactId}-${project.version}/wiki</targetPath>
<directory>${project.build.directory}/wiki</directory> <directory>${project.build.directory}/wiki</directory>
<filtering>false</filtering> <filtering>true</filtering>
</resource> </resource>
</resources> </resources>
</configuration> </configuration>
</execution> </execution>
</executions> </executions>
</plugin> </plugin>

5
geoportal-service/src/site/sphinx/lifecycle.rst
View File

@ -19,7 +19,7 @@ However they may change, each **project** lifecycle starts from the predefined `
.. figure:: _static/imgs/2phase_lc.png .. figure:: _static/imgs/2phase_lc.png
:alt: PHASES and STEPS :alt: PHASES and STEPS
A :ref:`2phase` lifecycle. A 2-phase lifecycle.
In the figure above is represented a 2-PHASES lifecycle. In the figure above is represented a 2-PHASES lifecycle.
In green, STEPS and PHASES defined by the lifecycle itself. 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). :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 : 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 - field Name : **fileset** target field name
- parent path : the path of the target parent for the *fileset* - parent path : the path of the target parent for the *fileset*

2
geoportal-service/src/site/sphinx/project.rst
View File

@ -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**. 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 : A manifestation contains at least the following information :