Documentation Validation procedure

From Gcube Wiki
Revision as of 10:59, 9 September 2013 by Massimiliano.assante (Talk | contribs) (→‎Status of Wikidoc Validation)

Jump to: navigation, search

This page provides information about the procedure that must be followed for the validation of the documentation content and the status of this procedure . This procedure is essential for maintaining high quality documentation in the Administrator's [1], the Developer's [2] and the User's [3] guide. The actors in the procedure are the authors of each section in the aforementioned guides, and the reviewers, which are recipients of the information provided in the content for which they are responsible.

Validation Procedure

Wikidoc Validation

Procedure

Each review process workflow consists of four stages

  1. Whenever a documentation section becomes eligible for review, the Review Process Status should be changed from orange (pending) to blue (eligible for review). The Documentation Editor will then open a ticket to the assigned reviewer of the aforementioned section and place a link to that ticket in the Related Ticket column.
  2. The assigned reviewer of the section performs the review, classifying this section into APPROVED - MINOR CHANGES - MAJOR CHANGES, and sets one of these three options into the Content Status column. This classification will give an overall estimation for the situation of the given section and will help each author understand how extensive the changes in his content should be. Reviewers should also provide more detailed comments to authors, in order to inform them about parts that have not clear meaning or must be described in more detail, parts that should be extended to broaden their scope and include more information and missing parts. During this first stage of the review process, the Initial Comments column of the Review Process Status field has yellow color (in progress). This stage finishes when the reviewer reassigns the ticket to the author (or the person responsible for the corresponding subsystem if the section is written by more than one authors), to provide him with the detailed comments of his review. The reviewer then changes the Initial Comments column of the Review Process Status field to green (accomplished) and the Address Comments column to yellow (in progress).
  3. The author/maintainer(s) of the section must perform the changes needed to address the initial comments of the reviewer. When this stage is completed the latter changes the Address Comments column of the Review Process Status field to green (accomplished) and the Approval column to yellow (in progress).
  4. The reviewer of a specific section must check that the changes performed by the author, addressed his comments. Additional comments can be provided to the author by the reviewer, through the open ticket, in order to help the author address the initial comments. When this stage is completed the reviewer must change the Approval column of the Review Process Status field to green (accomplished), place APPROVED into the Content Status column and close the open ticket.
Above process in simple steps

Pre-review process:

  1. Define a reviewer for your documentation.
  2. Reassign him the ticket.
  3. Add his name to the Reviewer column.

Reviewing process steps:

Reviewer:

  1. Changes the Initial Comments column of the Review Process Status field color to yellow.
  2. Performs the review.
  3. Classifies the section into {APPROVED, MINOR CHANGES, MAJOR CHANGES} and set one of these three options into the Content Status column.
  4. Provides more detailed comments to authors, in order to inform them about parts that have not clear meaning or must be described in more detail, parts that should be extended to broaden their scope and include more information and missing parts.
  5. Reassigns ticket to author.
  6. Changes the Initial Comments column of the Review Process Status field to green (accomplished) and the Address Comments column to yellow (in progress).

Maintener/Author:

  1. Performs the changes needed to address the initial comments of the reviewer.
  2. When above is complete, he changes the Address Comments column of the Review Process Status field to green (accomplished) and the Approval column to yellow (in progress).
  3. Reassigns the ticket back to reviewer.

Reviewer:

  1. Checks whether the changes performed by the author addressed his comments.Additional comments can be provided to the author by the reviewer, through the open ticket, in order to help the author address the initial comments.
  2. If all completed, changes the Approval column of the Review Process Status field to green (accomplished), place APPROVED into the Content Status column and close the open ticket.

Reasons to Review

A new review for a specific section is indicated by inserting a new line, in one of the tables below, beneath the lines that correspond to previous reviews for this section. The reason for a new review can be:

  • An extended change in the contents of a section(if this change involves only a specific subsection of this section then the name of this subsection is placed into the SubSection column). In this case the new line should be inserted by the author of the section, who is also responsible for informing the corresponding reviewer about the initiation of a new review procedure for this section.
  • A minor release closure. In this case the responsible for initiating the procedure is the Documentation Editor.
  • Some other reason that demands validation of some parts in the three guides.

The reason must be placed into the Reason to review column.

Deadlines

The Due Date depends on the reason for which the review is performed, being 5 weeks in case of a Major Review and 4 weeks in case of a minor release closure. The Initial Comments should be provided to the author by the reviewer in about one weeks' time after the initial ticket creation by the Documentation Editor. The documentation update should be performed in 3 weeks' time in case of a Major Review or other reason and in 2 weeks' time in case of a minor release closure. The final review should be performed in an additional one weeks' time. Each subsequent review/update cycle, if any, should be performed in one weeks' time for each action. In this case, the Due date should be updated accordingly by the reviewer to 2 weeks past the previous date.

If a review process fails to be completed within the Due Date, the reviewer must place the red color (expired) to the appropriate stage in the Review Process Status field. The reviewer can change the Content Status column during the third stage of a review process(i.e. he may decide that a section that needed MAJOR CHANGES, still needs some minor changes after the second stage). If the reviewer considers a section as APPROVED after the first stage, then this review process for this section, is considered to be completed without any actions taken by the author.

Distribution Validation

Description

Distribution validation is an additional documentation validation procedure defined from the distribution point of view instead of the documentation point of view. Its purpose is to complement the Wikidoc Validation procedure by

  • Making it easier to identify software lacking documentation
  • Facilitating access to documentation by correcting documentation-related issues in the distribution
  • Eliminating all possibilities of confusion by ensuring that all documentation links point to the project's current Wiki

The documentation issues are identified by the Documentation Editor and fall into three categories

  • Components lacking documentation. This category in turn includes
    • Components for which documentation exists, but don't include a link to that documentation. The expected action for such components is simply to include the link to the existing documentation.
    • Components which contain documentation links pointing to empty documentation pages or sections. The expected action for such components is to produce the required documentation.
    • Components which neither contain documentation links nor there exists documentation for them. The expected action for such components is both to produce the required documentation and to include the link the latter.
  • Components containing documentation links pointing to the old Wiki. This is a fairly common distribution issue which can generate confusion, especially when the correct page is updated often. This category includes
    • Components for which a corresponding documentation page or section already exists in the current Wiki. The expected action for such components is simply to update the documentation link included in the component.
    • Components for which a corresponding documentation page or section does not exist in the current Wiki. The expected actions for such components is to produce the required documentation and to update the documentation link included in the component.
  • Components containing problematic documentation links. This category includes all components with documentation link issues which cannot be classified into the previous two categories. In this case, a description of the identified issue is included.

Procedure

The procedure workflow consists of three stages

  1. The party in charge of the procedure (either the Documentation Editor, or an associate of them) opens a ticket (Type: defect, Defect Category: Documentation) for the issue to the Developer responsible for the component, describing the issue category. The former then changes the Ticket Creation column of the Issue Resolution Status field to green (accomplished) and the Resolution in HEAD column to yellow (in progress).
  2. Once the issue is resolved and the corresponding HEAD configuration is updated in ETICS, the Developer updates the ticket in order to notify the party in charge of the procedure of the progress made. The latter then updates the Resolution in HEAD to green (accomplished) and the Component Release column to yellow (in progress). If the changes made do not require a component release, the latter also updates the Component Release to green and closes the ticket, signifying that the procedure was successfully completed.
  3. If the changes made require a component release and once the component is released, the Developer updates the ticket in order to notify the party in charge of the procedure and the latter updates the Component Release column to green and closes the ticket, signifying that the procedure was successfully completed.

n Note: The component validation procedure is designed to address mainly distribution-related issues and it is expected that there will be no major overlaps with the Wikidoc Validation procedure. However, if such overlaps occur, the author responsible for the documentation section under review is expected to add a link to the related ticket in order to make the monitoring of the two procedures more efficient as they run simultaneously.

Status of Wikidoc Validation

Developer's Guide

Section Subsection Author Reviewer Reason to review Due Date Content Status Related Ticket Review Process Status
1 2 3
Initial Comments Address Comments Approval
Introduction All Leonardo Candela Pasquale Pagano Doc Validation 31 Oct 2013 Revised #1946
Reference Model All Leonardo Candela Doc Validation 31 Oct 2013 Assigned to author #1948
gCube Architecture All Leonardo Candela Doc Validation 31 Oct 2013 Assigned to author #1947
Glossary All --- Doc Validation 31 Oct 2013
Developing a Service All Fabio Simeoni Doc Validation 31 Oct 2013
Profile Specification All Roberto Cirillo Doc Validation 31 Oct 2013 Assigned to author #2095
Software Archive Specification All Lucio Lelii Doc Validation 31 Oct 2013 Assigned to author #2096
Testing Services with Maven and My Container All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #2097
Maven Bill of Materials All Andrea Manzi Doc Validation 31 Oct 2013 Assigned to author #2098
Developing gCube Portlets Guide All Massimiliano Assante Francesco Mangiacrapa Doc Validation 31 Oct 2013 Assigned to author #2099
Create a new Mavenized gCube GWT Portlet Guide (NEW) All Massimiliano Assante Angela Italiano Doc Validation 31 Oct 2013 Assigned to author #2100
Adding a Quick tour guide to your portlet All Massimiliano Assante Valentina Marioli Doc Validation 31 Oct 2013 Assigned to author #2101
Publish App News in User Feeds (Social Portal) All Massimiliano Assante Fabio Sinibaldi Doc Validation 31 Oct 2013 Assigned to author #2102
GCube Widgets Library - General guidelines about Portlet StyleSheets All Massimiliano Assante Francesco Mangiacrapa Doc Validation 31 Oct 2013 Assigned to author #2103
GCube Portlets common icon set Giota Koltsida Doc Validation 31 Oct 2013
Inter Portlet Subscription/Notification Mechanism (Client side) All Massimiliano Assante Francesco Mangicrapa Doc Validation 31 Oct 2013 Assigned to author #2104
Building your gCube Portlet in ETICS All Gabriele Giammatteo Doc Validation 31 Oct 2013 Assigned to author #2105
Featherweight Client Stack All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #1959
common-gcore-stubs All Fabio Simeoni Andrea Manzi Doc Validation 31 Oct 2013 Assigned to reviewer #2116
common-gcore-resources All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #2117
discovery-client/ic-client All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #2106
registry-publisher All Roberto.cirillo Doc Validation 31 Oct 2013 Assign to author #2118
common-scope All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #2119
How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework) All Andrea Manzi Doc Validation 31 Oct 2013 Assigned to author #2120
Implementation of Algorithms for the Statistical Manager Service All Angela Italiano Doc Validation 31 Oct 2013 Assigned to author #2121
How to integrate legacy applications and offer them via WPS All Fabrice Brito Doc Validation 31 Oct 2013 Assigned to author #2122
How to publish ISO-compliant metadata in the gCube SDI All Fabio Sinibaldi Doc Validation 31 Oct 2013 Assigned to author #2123
Data e-Infrastructure Management Facilities All Luigi Fortunati (Manuele.simi) Doc Validation 31 Oct 2013 #2124
Information System All Luigi Fortunati (Manuele.simi) Doc Validation 31 Oct 2013 Assigned to author #2125
VRE Management All Roberto Cirillo Doc Validation 31 Oct 2013 Assigned to author #1954
Messaging Infrastructure All Andrea Manzi Doc Validation 31 Oct 2013 Assigned to author #1957
common-utils-encryption All Roberto Cirillo Doc Validation 31 Oct 2013 Assigned to author #1960
common-encryption All Roberto Cirillo Doc Validation 31 Oct 2013 Assigned to author #1961
common-accounting-model All Ermanno Travaglino Doc Validation 31 Oct 2013 Assigned to author #1962
common-accounting All Ermanno Travaglino Doc Validation 31 Oct 2013 Assigned to author #1963
Common Messaging Endpoints Library All Andrea Manzi Doc Validation 31 Oct 2013 Assigned to author #1958
database-resource All Luigi Fortunati Doc Validation 31 Oct 2013 Assigned to author #2126
Data e-Infrastructure Policy-oriented Security Facilities All Luigi Fortunati Doc Validation 31 Oct 2013 Assigned to author #2127
Virtual Organisation Management All Roberto Cirillo Doc Validation 31 Oct 2013 Assigned to author #1950
SOA3 Authentication Service All Ciro Formisano Doc Validation 31 Oct 2013 Assigned to author #2107
SOA3 Authorization Service All Ciro Formisano Doc Validation 31 Oct 2013 Assigned to author #2108
User Management Service All Ciro Formisano Doc Validation 31 Oct 2013 Assigned to author #2128
SOA3 Policy Management Service All Ciro Formisano Doc Validation 31 Oct 2013 Assigned to author #2129
Workflow Management Facilities All John Gerbesiotis Doc Validation 31 Oct 2013 Assigned to author #2109
Workflow Engine All John Gerbesiotis Doc Validation 31 Oct 2013 Assigned to author #1956
Execution Engine All John Gerbesiotis Doc Validation 31 Oct 2013 Assigned to author #1955
Data Access and Storage Facilities All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #2130
Storage Manager All Roberto Cirillo Doc Validation 31 Oct 2013 Assigned to author #1965
Tree-Based Access All Valentina Marioli Doc Validation 31 Oct 2013 Assigned to author #2115
Tree Manager Framework All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #1966
Tree Library All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #1967
Tree Manager Library All Fabio Simeoni Doc Validation 31 Oct 2013 Assigned to author #1968
OAI TM Plugin All Valentina Marioli Doc Validation 31 Oct 2013 Assigned to author #1969
Species TM Plugin All Valentina Marioli Doc Validation 31 Oct 2013 Assigned to author #1970
FIGIS TM Plugin All Valentina Marioli Doc Validation 31 Oct 2013 Assigned to author #1971
Species Product Discovery Client Library All Lucio Lelii Doc Validation 31 Oct 2013 Assigned to author #2111
Species Product Discovery Objects All Valentina Marioli Doc Validation 31 Oct 2013 Assigned to author #2112
Darwin Core Terms All Valentina Marioli Doc Validation 31 Oct 2013 Assigned to author #2113
Species Product Discovery TestSuite All Federico Defaveri Doc Validation 31 Oct 2013 Assigned to author #2114
gCube ResultSet 2 (gRS2) All Alex Antoniadis Doc Validation 31 Oct 2013 Assigned to author #1973
gRS2 Broker All Alex Antoniadis Doc Validation 31 Oct 2013 Assigned to author #1974
Data Transfer Agent All Andrea Manzi Doc Validation 31 Oct 2013 Assigned to author #2131
Data Transfer Scheduler All Andrea Manzi Doc Validation 31 Oct 2013 Assigned to author #2132
The Data Transfer Portlet All Andrea Manzi Doc Validation 31 Oct 2013
The Data Transfer Common Messaging Interface All Andrea Manzi Doc Validation 31 Oct 2013
URI resolver All Andrea Manzi Doc Validation 31 Oct 2013
Data Assessment, Harmonisation, and Certification Facilities. All Leonardo Candela Doc Validation 31 Oct 2013
Tabular Data Flow Manager All Gianpaolo Coro Doc Validation 31 Oct 2013
Tabular Data Manager All Lucio Lelii Doc Validation 31 Oct 2013
Time Series Management and Analysis All Lucio Lelii Doc Validation 31 Oct 2013
gCube SDMX Statistical Data Dissemination System All Luigi Fortunati Doc Validation 31 Oct 2013
Time Series All Lucio Lelii Doc Validation 31 Oct 2013
Codelist Manager All Lucio Lelii Doc Validation 31 Oct 2013
Occurrence Data Reconciliation All Gianpaolo Coro Doc Validation 31 Oct 2013
Occurrence Data Enrichment Service All Gianpaolo Coro Doc Validation 31 Oct 2013
Taxon Names Reconciliation Service All Gianpaolo Coro Doc Validation 31 Oct 2013
Search 2 Framework (NEW) All Alex Antoniadis Doc Validation 31 Oct 2013 Assigned to author #1975
OpenSearch Framework All Alex Antoniadis Doc Validation 31 Oct 2013 Assigned to author #1976
Index Management Framework All Alex Antoniadis Panagiotis Liakos Doc Validation 31 Oct 2013 Revised #1977
Personalisation All Panagiota Koltsida Doc Validation 31 Oct 2013 Assigned to author #1979
Data Transformation All John Gerbesiotis Doc Validation 31 Oct 2013 Assigned to author #1978
Signal Processing All Gianpaolo Coro Doc Validation 31 Oct 2013 Assigned to author #2133
GeoExplorer Data Visualization Plugins All Nikolas Laskaris Doc Validation 31 Oct 2013 Assigned to author #2135
X-Search All Yannis.marketakis Doc Validation 31 Oct 2013 Assigned to author #2136
Client Libraries Framework Specification All Fabio Simeoni Doc Validation 31 Oct 2013
Integration and Interoperability Facilities Framework: Client Libraries Design Model All Fabio Simeoni Doc Validation 31 Oct 2013
Integration and Interoperability Facilities Framework: Client Libraries Framework All Fabio Simeoni Doc Validation 31 Oct 2013
Integration and Interoperability Facilities Framework: Client Libraries Management Model All --- Doc Validation 31 Oct 2013
Application Service Layer Framework Specification All Nikolas Laskaris Doc Validation 31 Oct 2013
HTTP API Framework Specification All Nikolas Laskaris Doc Validation 31 Oct 2013
Application Support Layer All Nikolas Laskaris Doc Validation 31 Oct 2013
gCube Portal Engine All Giota Koltsida Doc Validation 31 Oct 2013 Assigned to author #2134
ASL HTTP Front End All Nikolas Laskaris Doc Validation 31 Oct 2013 Assigned to author #2137
Social Networking Library All Massimiliano Assante Luigi Fortunati Doc Validation 31 Oct 2013 Assigned to author #2138
GeoNetwork library All Fabio Sinibaldi Doc Validation 31 Oct 2013 Assigned to author #2139
GIS Interface All Fabio Sinibaldi Doc Validation 31 Oct 2013 Assigned to author #2140
GIS Publisher service All Fabio Sinibaldi Doc Validation 31 Oct 2013 Assigned to author #2141
Environment Explorer: Features for Retrieving environmental data associated to a set of coordinates All Gianpaolo Coro Doc Validation 31 Oct 2013
Geo Spatial Data Processing: Features for processing geo-spatial data All Gianpaolo Coro Doc Validation 31 Oct 2013
gCube GeoExplorer Portlet: A web interface for performing discovery of layers in a distributed GeoServer network All Gianpaolo Coro Doc Validation 31 Oct 2013
How to publish ISO-compliant metadata in the gCube SDI All Fabio Sinibaldi Doc Validation 31 Oct 2013

User's Guide

Section Subsection Author Reviewer Reason to review Due Date Content Status Related Ticket Review Process Status
1 2 3
Initial Comments Address Comments Approval
1 Introduction All Leonardo Candela Major Review
2 Basic Concepts All Leonardo Candela Major Review
3 Common Functionality All Massimiliano Assante Major Review
3.1 Workspace Environment All Francesco Mangiacrapa Major Review
3.2 Login to a VO/VRE All Panagiota Koltsida Major Review
3.3 Search All Panagiota Koltsida Major Review
3.3.1 Select Collections All Panagiota Koltsida Major Review
3.3.2 Search All Panagiota Koltsida Major Review
3.3.3 Quick & Google Search All Panagiota Koltsida Major Review
3.3.4 Geospatial Search All Panagiota Koltsida Major Review
3.4 Result Browsing All Panagiota Koltsida Major Review
3.4.1 Common Browsing Activities All Panagiota Koltsida Major Review
3.4.2 The Basket All Massimiliano Assante Major Review
3.5 Annotations All Major Review
3.6 Content Viewer All Panagiota Koltsida Major Review
3.7 User Profile Management All Panagiota Koltsida Major Review
3.7.1 User Profile Editing All Panagiota Koltsida Major Review
3.8 Report Management All Massimiliano Assante Major Review
3.8.1 Template Creation All Massimiliano Assante Major Review
3.8.2 Report Generation All Massimiliano Assante Major Review
3.9 Course Management All Panagiota Koltsida Major Review
3.10 Document Workflows All Massimiliano Assante Major Review
3.10.1 Workflow Editor : Create and Manage workflow templates All Massimiliano Assante Major Review
3.10.2 Document Workflow Manager : Create and Manage document workflows All Massimiliano Assante Major Review
3.10.3 My Document Workflows : Edit and View your document workflows All Massimiliano Assante Major Review
3.11 Time Series All Federico Defaveri Major Review
3.12 AquaMaps : Species Distribution and Biodiversity Maps All Fabio Sinibaldi Major Review
3.12.1 Species Explorer All Fabio Sinibaldi Major Review
3.12.2 Data Management Facility All Major Review
3.13 GeoExplorer : a visualization portlet for geo-spatial data All Gianpaolo Coro Major Review
3.14.1 Web Application Management All Federico Defaveri Major Review
3.14.2 WAR Management All Federico Defaveri Major Review
3.15.1 Scheduler Portlet All Nikolaos Drakopoulos, Andrea Manzi Major Review
3.15.2 Storage Manager Portlet All Nikolaos Drakopoulos, Andrea Manzi Major Review
4.1 Login to a portal instance and select a VRE All Panagiota Koltsida Major Review
4.2 Perform a search and view the metadata of a record All Panagiota Koltsida Major Review
4.3 Annotating Information Objects All Panagiota Koltsida Major Review
4.4 Send a workspace area item to another user All Federico Defaveri Major Review
4.5 Access workspace from Desktop All Massimiliano Assante Major Review
Ontology Editing Portlet All Panagiota Koltsida Major Review

Administrator's Guide

Section Subsection Author Reviewer Reason to review Due Date Content Status Related Ticket Review Process Status
1 2 3
Initial Comments Address Comments Approval
1. Introduction All Leonardo Candela Major Review
1.1 Intended Readership All Leonardo Candela Major Review
1.2 Purpose All Leonardo Candela Major Review
1.3 Related Documents All Leonardo Candela Major Review
1.4 Problem Reporting All Leonardo Candela Major Review
2 gCube Overview All Manuele Simi, Leonardo Candela Major Review
3. How to set up a gCube infrastructure All Manuele Simi, Leonardo Candela Major Review
4. Monitoring a gCube infrastructure with Nagios All Andrea Manzi Major Review
5.1 gCube Hosting Node (gHN) Installation All Manuele Simi Major Review
5.2 Adding Virtual Platforms to a gHN All Manuele Simi Major Review
5.2.1 Adding the Tomcat Virtual Platform to a gHN All Manuele Simi Major Review
5.3.1 GHN Security Configuration All Ciro Formisano Major Review
5.3.2 Security Plugins Table All Ciro Formisano Major Review
6. Core Services Installation All Ermanno Travaglino Major Review
6.1 Information System Installation All Lucio Lelli Major Review
6.2 VRE Management Services Installation All Andrea Manzi Major Review
6.3 Usage-Tracker Installation All Ermanno Travaglino Major Review
6.4.1 SOA3 services configuration All Ciro Formisano Major Review
6.4.2 Shibboleth and gCube All Ciro Formisano Major Review
6.4.3 Argus Installation All Ciro Formisano Major Review
7.1 Installing the Virtual Organization enabling services All Leonardo Candela Major Review
7.2 Configuring the Virtual Organization All Leonardo Candela Major Review
7.3 Verifying the Virtual Organization correctness All Leonardo Candela Major Review
7.4 VO Resources All Leonardo Candela Major Review
7.5 VO Services Deployment and Configuration All Leonardo Candela Major Review
7.6 Monitoring the Virtual Organization All Leonardo Candela Major Review
7.7 Managing the Virtual Organization All Leonardo Candela Major Review
7.8 Creating Indices at the VO Level All Leonardo Candela Major Review
7.9.1 Runtime Resource Registration All Fabio Sinibaldi Major Review
7.9.2 Runtime Resource Classification All Fabio Sinibaldi Major Review
8. How to create a Virtual Research Environment All Massimiliano Assante Major Review
8.1 Defining the Virtual Research Environment All Massimiliano Assante Major Review
8.2 Approving the Virtual Research Environment All Massimiliano Assante Major Review
8.3 Verifying the Virtual Research Environment correctness All Leonardo Candela Major Review
8.4 Managing the Virtual Research Environment All Leonardo Candela Major Review
8.4.1 Creating the Virtual Research Environment Layout All Leonardo Candela Major Review
8.4.2 Editing the Virtual Research Environment Information Space All Leonardo Candela Major Review
8.4.3 Managing Virtual Research Environment Users All Leonardo Candela Major Review
8.4.4 Monitoring the Virtual Research Environment through the Information System All Leonardo Candela Major Review
9.1 Install and Configure GeoNetwork All Fabio Sinibaldi Major Review
9.2 Install and Configure GeoServer All Fabio Sinibaldi Major Review
9.3 Install and Configure THREDDS Data Server All Gianpaolo Coro Major Review
9.4 Install and Configure 52° North Web Processing Service All Gianpaolo Coro Major Review
9.5 Install and Configure GDAL; All Gianpaolo Coro Major Review
10.1 gCube Portal Installation All Massimiliano Assante Major Review
10.2 Social Portal Extension Setup All Andrea Manzi Major Review
10.3 Configure Portal with LDAP All Massimiliano Assante Major Review
10.4 Authentication management with Certificates and https All Major Review
10.5 Policy Management Portlet All Ciro Formisano Major Review
10.6 Portal Administration Functionality All Panagiota Koltsida Major Review
10.6.1 Search Fields' Management All Panagiota Koltsida Major Review
10.6.2 Roles' Management All Panagiota Koltsida Major Review
10.6.3 Users' Management All Panagiota Koltsida Major Review
10.6.4 Profiles' Management All Panagiota Koltsida Major Review
10.6.5 Information Space Editor All Panagiota Koltsida Major Review
10.6.6 Resource Management All Luigi Fortunati Major Review
10.6.7 Index Management All Alex Antoniadis Major Review
10.6.8 IR Bootstrapper All Panagiota Koltsida Major Review
10.6.9 DataTransformationAdminPortlet All Panagiota Koltsida Major Review
10.6.10 Task Manager All Panagiota Koltsida Major Review
10.6.11 About inter-portlet referring All Massimiliano Assante Major Review
10.6.12 Upload of new Software All Luigi Fortunati Major Review
10.7 Monitoring System All Massimiliano Assante Major Review
10.8 Jackrabbit Repository Installation & Configuration All Leonardo Candela Major Review
11 Programmatic Administration Interface All Manuele Simi Major Review

Status of Distribution Validation

Components Lacking Documentation

Component Owner Related Ticket Issue Resolution Status
1 2 3
Ticket Creation Resolution in HEAD Component Release
org.gcube.data.publishing.sdmx-publisher Luigi Fortunati
org.gcube.portletsuser.sessionlibrary Massimiliano Asante
org.gcube.application.authorextract
org.gcube.portlets.admin.ishealth-monitor-widget Massimiliano Asante
org.gcube.common.eolusclient Lucio Lelli
org.gcube.common.hibernate-patched Gianpaolo Coro
org.gcube.contentmanagement.statisticsextractor Gianpaolo Coro
org.gcube.execution.reportingframeworklibrary John Gerbesiotis
org.gcube.portlets.user.wsmail-widget Massimiliano Asante
org.gcube.applicationsupportlayer.asl-http-infrastructure-login Nikolaos Laskaris
org.gcube.execution.grsbridge Not Found
org.gcube.dbinterface.h2interface Not Found
org.gcube.applicationsupportlayer.aslresourcemanagement Nikolaos Laskaris
org.gcube.contentmanagement.codelistmanager Lucio Lelli
org.gcube.data.harmonization.occurrence-reconciliation Fabio Sinibaldi
org.gcube.portlets.user.share-updates Massimiliano Assante
org.gcube.applicationsupportlayer.asl-http-information-retrieval Nikolas Laskaris
org.gcube.execution.environmentproviderlibrary Not Found
org.gcube.contentmanagement.time-series-geotools Gianpaolo Coro
org.gcube.common.rapidminer-custom Caselyn Aldemita
org.gcube.portal.gcube-reporting-library Not Found
org.gcube.portal.social-networking-library Massimiliano Assante
org.gcube.data-transfer.scheduler-portlet Nikolaos Drakopoulos
org.gcube.messaging.accounting.portal.AccountingPortlet Not Found
org.gcube.portlets.admin.bdwmsuite-support-library Not Found
org.gcube.portlets.user.messages Francesco Mangiacrapa
org.gcube.search.search-client-library Alex Antoniadis
org.gcube.execution.madgiknotificationhandlinglibrary John Gerbesiotis
org.gcube.externalsoftware.gwt-ext-patched Not Found
org.gcube.execution.jmsenvironmentproviderlibrary John Gerbesiotis
org.gcube.data-publishing.sdmx-datasource-client Luigi Fortunati
org.gcube.common.exist-library Lucio Lelli
org.gcube.data-access.species-products-discovery-service Lucio Lelli
org.gcube.portlets.user.joinnew Massimiliano Assante
org.gcube.common.bitlet Alex Antoniadis
org.gcube.applicationsupportlayer.aslvre Nikolas Laskaris
org.gcube.dbinterface.postgres Not Found
org.gcube.data-publishing.sdmx-registry-client Luigi Fortunati
org.gcube.portlets.admin.resource-sweeper-widget
org.gcube.portlets.user.timeseriescharts Massimiliano Assante
org.gcube.application.refextract Not Found
org.gcube.application.quantitativepropertiesvisualisation Nikolas Laskaris
org.gcube.execution.gcubeenvironmentproviderlibrary John Gerbesiotis
org.gcube.application.refextract-script Not Found
org.gcube.content-management.ecologicalmodelling Gianpaolo Coro
org.gcube.data-access.queueManager Antonio Gioia
org.gcube.content-management.lexicalmatcheruser Gianpaolo Coro
org.gcube.execution.informationsystemlibrary John Gerbesiotis
org.gcube.applicationsupportlayer.aslstoragemanagement Massimiliano Assante
org.gcube.execution.urlresolutionlibrary Alex Antoniadis
org.gcube.applicationsupportlayer.aslup Nikolas Laskaris
org.gcube.portlets.user.guided-tour-widget Massimiliano Assante
org.gcube.portlets.user.workspace-application-handler Francesco Mangiacrapa
org.gcube.portlets.user.social-profile Massimiliano Assante
org.gcube.execution.queueableexecutionengine John Gerbesiotis
org.gcube.portlets.user.notifications Massimiliano Assante
org.gcube.portlets.user.webapplicationmanagementportlet Federico Defaveri
org.gcube.common.dbinterface Lucio Lelli
org.gcube.contentmanagement.aquamapstransectgenerator Gianpaolo Coro
org.gcube.data-analysis.statistical-manager-service Angela Italiano
org.gcube.data-analysis.statistical-manager-stubs Not Found
org.gcube.applicationsupportlayer.asl-http-content-access Nikolas Laskaris
org.gcube.information-system.iscache Vassilis Verroios
org.gcube.portlets.user.d4science-reporting-library Not Found
org.gcube.applicationsupportlayer.asl-http-ore-provider Nikolas Laskaris
org.gcube.applicationsupportlayer.aslhttpinfrastructurelogin Not Found
org.gcube.contentmanagement.geo-utils-custom Gianpaolo Coro
org.gcube.data.publishing.software-upload-wizard Not Found
org.gcube.execution.notificationhandlinglibrary John Gerbesiotis
org.gcube.applicationsupportlayer.aslsocial Massimiliano Assante
org.gcube.execution.storagesystemlibrary John Gerbesiotis
org.gcube.execution.workflowdtsadaptor John Gerbesiotis
org.gcube.portlets.user.application-news-widget Massimiliano Assante
org.gcube.application.ocropus Not Found
org.gcube.data-publishing.sdmx-registry-client-gcube Luigi Fortunati
org.gcube.portal.notificationchecker Massimiliano Assante
org.gcube.data-publishing.sdmx-datasource-common Luigi Fortunati
org.gcube.portal.workspacetree Not Found
org.gcube.ontologymanagement.ontologymanagementservice ---
org.gcube.ontologymanagement.ontologymanagementservicestubs Not Found
org.gcube.portlets.admin.taskmanager ---
org.gcube.portlet.user.my-vres Massimiliano Assante
org.gcube.common.csv4j-custom Federico Defaveri
org.gcube.common.oaiharvester Valentina Marioli
org.gcube.data-access.species-tree-plugin Valentina Marioli
org.gcube.data-access.species-tree-requests Valentina Marioli
org.gcube.data.oai.tmplugin.oai-tm-plugin Not Found
org.gcube.data-access.tree-repository Fabio Simeoni
org.gcube.data-access.tree-repository-requests Fabio Simeoni
org.gcube.data-access.tree-manager-service Fabio Simeoni
org.gcube.data-access.tree-manager-stubs Fabio Simeoni
org.gcube.portlets.user.codelistmanagementportlet Federico Defaveri
org.gcube.common.common-uri Fabio Simeoni

Components Containing Wikidoc Links Pointing to the Old Wiki

Component Owner Old Wikidoc Link Corrected Link Related Ticket Issue Resolution Status
1 2 3
Ticket Creation Resolution in HEAD Component Release
org.gcube.dvos.voms-admin-stubs Not Found Link
org.gcube.spatial-data.gis-interface Fabio Sinibaldi Link
org.gcube.spatial-data.geonetwork Fabio Sinibaldi Link
org.gcube.search.rseprcache Alex Antoniadis Link
org.gcube.common.geoserverinterface Fabio Sinibaldi Link

Components Containing Problematic Wikidoc Links

Component Owner Identified Issue Problematic Link Corrected Link Related Ticket Issue Resolution Status
1 2 3
Ticket Creation Resolution in HEAD Component Release
org.gcube.execution.rraggregator Alex Antoniadis Broken Link Link
org.gcube.application.androidgcubesearch Panagiota Koltsida Broken Link Link
org.gcube.execution.rrplugins Alex Antoniadis Broken Link Link
org.gcube.execution.rraggregator-no-deps Alex Antoniadis Broken Link Link
org.gcube.execution.resourceregistry-configuration-default Alex Antoniadis Broken Link Link
org.gcube.application-support-layer.applicationsupportlayersearch Nikolas Laskaris Broken Link Link
org.gcube.execution.resourceregistry-configuration-dts Alex Antoniadis Broken Link Link
org.gcube.applicationsupportlayer.asl_oai_ore Nikolas Laskaris Broken Link Link
org.gcube.execution.workflowsearchadaptor Alex Antoniadis Broken Link Link
org.gcube.execution.rrgcubeplugins Alex Antoniadis Broken Link Link
org.gcube.applicationsupportlayer.asl_http_access_management Nikolas Laskaris Broken Link Link
org.gcube.resource-registry.resourceregistry-configuration-execution Alex Antoniadis Broken Link Link
org.gcube.resource-registry.rrgcubebridge Alex Antoniadis Broken Link Link
org.gcube.application-support-layer.applicationsupportlayercore Nikolas Laskaris Broken Link Link
org.gcube.resource-registry.resourceregistry-configuration-portal Alex Antoniadis Broken Link Link
org.gcube.application-support-layer.applicationsupportlayercontentmanagement Nikolas Laskaris Broken Link Link
org.gcube.resource-registry.resourceregistry-configuration-index Alex Antoniadis Broken Link Link
org.gcube.application-support-layer.applicationsupportlayersearch Nikolas Laskaris Broken Link Link
org.gcube.resource-registry.rrmodel Alex Antoniadis Broken Link Link
org.gcube.resource-registry.resourceregistry-configuration-workflow Alex Antoniadis Broken Link Link
org.gcube.portlets.user.gridjobsmanagementportlet Broken Link Link
org.gcube.resource-registry.resourceregistry-configuration-search Alex Antoniadis Broken Link Link
org.gcube.search.resultset.resultset_client_library Alex Antoniadis Incorrect Page URL Link
org.gcube.search.resultset.resultset_client_library.test-suite Alex Antoniadis Incorrect Page URL Link
org.gcube.search.resultset.resultset_service Alex Antoniadis Incorrect Page URL Link
org.gcube.search.resultset.resultsetservice-stubs Not Found Incorrect Page URL Link
org.gcube.search.resultsetservice-test-suite Not Found Incorrect Page URL Link
org.gcube.search.resultset.resultset_library Alex Antoniadis Incorrect Page URL Link
org.gcube.search.resultset.resultset_library.test-suite Alex Antoniadis Incorrect Page URL Link
org.gcube.search.resultset.garbage_collector Alex Antoniadis Incorrect Page URL Link
org.gcube.search.resultset.garbage_collector.test-suite Alex Antoniadis Incorrect Page URL Link
org.gcube.portal.runtimeresourcecreator-portlet Not Found Irrelevant Documentation Section Link
org.gcube.portlets.user.gcubegeoexplorer Francesco Mangiacrapa Irrelevant Documentation Section Link
org.gcube.portlets.admin.wftemplates-portet Massimiliano Assante Irrelevant Documentation Section Link
org.gcube.common.common-scope-maps Fabio Simeoni Irrelevant Documentation Section Link
org.gcube.portlets.user.gcube-loggedin Massimiliano Assante Irrelevant Documentation Section Link
org.gcube.resources.discovery.ic-client Not Found Irrelevant Documentation Section Link
org.gcube.portlets.user.gis-viewer Francesco Mangiacrapa Irrelevant Documentation Section Link
org.gcube.application-support-layer.applicationsupportlayerhttp Nikolas Laskaris Irrelevant Documentation Section Link
org.gcube.portlets.user.geo-explorer Francesco Mangiacrapa Irrelevant Documentation Section Link
org.gcube.portlets.admin.resourcemanagementportlet Massimiliano Assante Irrelevant Documentation Section Link
org.gcube.data-access.spqlparser Lucio Lelli Irrelevant Documentation Section Link
org.gcube.portlets.user.gcube-gis-viewer Francesco Mangiacrapa Irrelevant Documentation Section Link
org.gcube.application.parallelindexing Not Found Irrelevant Documentation Section Link
org.gcube.portlets.user.workflowdocuments-portlet Massimiliano Assante Irrelevant Documentation Section Link
org.gcube.portlets.user.occurrencemanagement Francesco Mangiacrapa Irrelevant Documentation Section Link
org.gcube.distributions.ghn-client-runtime Fabio Simeoni Irrelevant Documentation Section Link
org.gcube.information-system.discovery-client Fabio Simeoni Irrelevant Documentation Section Link
org.gcube.portlets.admin.workflowdocviewer-portlet Massimiliano Assante Irrelevant Documentation Section Link
org.gcube.core.common-gcore-stubs Fabio Simeoni Irrelevant Documentation Section Link
org.gcube.data.spd.obis-spd-plugin Federico Defaveri Irrelevant Documentation Section Link
org.gcube.application.ocr Not Found Irrelevant Documentation Section Link
org.gcube.portlets.admin.elasticsearch-portlet Panagiota Koltsida Irrelevant Documentation Section Link
org.gcube.information-system.registry-publisher Roberto Cirillo Irrelevant Documentation Section Link
org.gcube.search.searchsystemlibrary Alex Antoniadis Old Documentation Link
org.gcube.search.searchsystemservice Alex Antoniadis Old Documentation Link
org.gcube.search.searchsystemservice-stubs Not Found Old Documentation Link
Retrieved from "https://wiki.gcube-system.org/index.php?title=Documentation_Validation_procedure&oldid=19609"