Documentation Validation

From Gcube Wiki
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

Each review process workflow consists of three stages

  1. The assigned reviewer of a section must classify this section into APPROVED - MINOR CHANGES - MAJOR CHANGES - MISSING - OBSOLETE, and set 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 opens a ticket(Type: defect, Category (Defect): Documentation) to the author(or the 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, and places the link for this ticket in the Related Ticket column. The reviewer changes the Initial Comments column of the Review Process Status field to green (accomplished) and the Address Comments column to yellow (in progress).
  2. The author/authors of a specific section must perform the changes needed to address the initial comments of the reviewer. When this stage is completed the author changes the Address Comments column of the Review Process Status field to green (accomplished) and the Approval column to yellow (in progress).
  3. 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.

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. The Due Date in this case must defined as five weeks after the current date.
  • A major 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. The Due Date depends on the reason for which the review is performed, and the Initial Comments should be provided to the author by the reviewer, at least 3 weeks before the Due 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.

Status of 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
1. Introduction All Federico De Faveri, Pasquale Pagano Major Review
2. gCube Architecture All Leonardo Candela, Pasquale Pagano, Manuele Simi Major Review
3. Reference Model All Leonardo Candela, Paolo Roccetti, Manuele Simi Major Review
4.1 GCube Infrastructure Enabling Services All Manuele Simi Major Review
4.1.1 Information System All Lucio Lelii, Manuele Simi Major Review
4.1.2 Virtual Organisation Management All Major Review
4.1.3 VRE Management All Lucio Lelii, Kostas Liaskos, Fabio Simeoni, Manuele Simi, Daniele Strollo Major Review
4.1.6 Execution Engine All Giorgos Papanikos Major Review
4.1.7 Workflow Engine All Gerasimos Farantatos, Giorgos Papanikos Major Review
4.1.8 Messaging Infrastructure All Andrea Manzi Major Review
4.1.9 SAM Infrastructure All Andrea Manzi Major Review
4.2 gCube Information Organisation Services (NEW) All Fabio Simeoni Major Review
4.2.1 Storage Manager All Federico De Faveri Major Review
4.2.2 Content Manager All Fabio Simeoni Major Review
4.2.3 Content Manager Library All Fabio Simeoni Major Review
4.2.4 gCube Document Model and gCube Model Library (2.0) (NEW) All Fabio Simeoni Major Review
4.2.5.1 gDL 1.0 All Federico De Faveri, Lucio Lelii Major Review
4.2.5.2 gDL 2.0 All Federico De Faveri, Fabio Simeoni Major Review
4.2.6 View Manager All Fabio Simeoni Major Review
4.3 gCube Information Organisation Services (LEGACY) All Major Review
4.3.2 Content Management All Federico De Faveri Major Review
4.3.3 Collection Management All Federico De Faveri Major Review
4.3.4 Metadata Management All Manuele Simi Major Review
4.3.5 Annotation Management All Fabio Simeoni Major Review
4.3.6 Content Import All Leonardo Candela, Diego Milano Major Review
4.4 gCube Information Retrieval Services All Leonardo Candela Major Review
4.4.1 gCube ResultSet (gRS) All Kostas Tsakalozos Major Review
4.4.2 gCube ResultSet 2 (gRS2) All Gerasimos Farantatos, Giorgos Papanikos Major Review
4.4.3 Search Framework All Vassilis Veroios Major Review
4.4.4 OpenSearch Framework All Gerasimos Farantatos Major Review
4.4.5 Index Management Framework All Vassilis Veroios Major Review
4.4.6 Data Transformation All Kostas Tsakalozos Major Review
4.4.7 Personalisation All Giota Koltsida Major Review
4.4.8 Distributed Information Retrieval Support Framework All Fabio Simeoni Major Review
4.4.8 gCube Ontology Management Service All Rena Tsantouli Major Review
4.5.1 Application Support Layer All Rena Tsantouli Major Review
Home Library All Federico De Faveri Major Review
4.5.2 gCube Portal Engine All Giota Koltsida Major Review
5.1.2. Profile Specification All Manuele Simi, Daniele Strollo Major Review
5.1.3. Service Archive Specification All Lucio Lelii Major Review
5.2.1. Developing gCube Portlets Guide All Massimiliano Assante Major Review
5.2.2 GCube Widgets Library - General guidelines about Portlet StyleSheets All Massimiliano Assante Major Review
5.2.3 GCube Portlets common icon set All Massimiliano Assante Major Review
5.2.4 Inter Portlet Subscription/Notification Mechanism (Client side) All Massimiliano Assante Major Review
5.2.5 Building your gCube Portlet in ETICS All Gabriele Giammatteo Major Review
5.3.1. Security Model All Major Review
5.3.2. How To Configure Service Security All Major Review
5.3.3. Common Security Troubleshooting All Major Review
5.3.4. How to use VOMS api library All Major Review

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, Pasquale Pagano Major Review
2.1 Virtual Research Environments and Community Portals All Leonardo Candela, Pasquale Pagano Major Review
2.2 Content and Collections All Leonardo Candela, Pasquale Pagano Major Review
2.3 Content Annotation All Leonardo Candela, Pasquale Pagano Major Review
2.4 Metadata All Leonardo Candela, Pasquale Pagano Major Review
3.1 Login to a VO/VRE All Massimiliano Assante Major Review
3.2 Search All Giota Koltsida Major Review
3.3 Result Browsing All Massimiliano Assante Major Review
3.4 Annotations All Giota Koltsida Major Review
3.5 Content Viewer All Giota Koltsida Major Review
3.6 User Profile Management All Giota Koltsida Major Review
3.7 Report Management All Massimiliano Assante Major Review
3.8 Course Management All Gerasimos Farantatos Major Review
3.9 Time Series All Federico De Faveri Major Review
3.10 AquaMaps : Species Distribution and Biodiversity Maps All Leonardo Candela Major Review
Workspace All Federico De Faveri Major Review
4.1 Login to a portal instance and select a VRE All Giota Koltsida Major Review
4.2 Perform a search and view the metadata of a record All Giota Koltsida Major Review
4.3 Change the XSLT at your profile and view the results using the new XSLT All Giota Koltsida Major Review
4.4 Annotating Information Objects All Giota Koltsida Major Review
4.5 Send a workspace area item to another user All Federico De Faveri Major Review
Ontology Editing Portlet All Rena Tsantouli 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, Pasquale Pagano Major Review
3. How to set up a gCube infrastructure All Manuele Simi Major Review
4. gCube Hosting Node (gHN) Installation All Manuele Simi Major Review
5. Core Services Installation All Manuele Simi Major Review
5.1 Information System Installation All Manuele Simi Major Review
5.2 VRE Management Services Installation All Manuele Simi, Daniele Strollo Major Review
5.3 Dynamic Virtual Organization Support Service Installation All Major Review
6. How to create a Virtual Organization All Manuele Simi Major Review
6.1 Installing the Virtual Organization enabling services All Manuele Simi Major Review
6.2 Configuring the Virtual Organization All Manuele Simi Major Review
6.3 Verifying the Virtual Organization correctness All Manuele Simi Major Review
6.4 VO gCube Resources All Manuele Simi Major Review
6.5 Dynamic Services Deployment and Configuration All Manuele Simi Major Review
6.6 Monitoring the Virtual Organization All Manuele Simi Major Review
6.7 Managing the Virtual Organization All Manuele Simi Major Review
7. How to create a Virtual Research Environment All Leonardo Candela, Pasquale Pagano Major Review
7.1 Defining the Virtual Research Environment All Leonardo Candela, Pasquale Pagano Major Review
7.2 Approving the Virtual Research Environment All Leonardo Candela, Pasquale Pagano Major Review
7.3 Verifying the Virtual Research Environment correctness All Leonardo Candela, Pasquale Pagano Major Review
7.4 Managing the Virtual Research Environment All Leonardo Candela, Pasquale Pagano Major Review
8.1 New gCube Portal Installation (Liferay) All Massimiliano Assante, Giota Koltsida Major Review
8.2 Authentication management with Certificates and https All Giulio Galiero, Kanchanna.ramasamybalraj Major Review
8.3 Portal Administration Functionality All Rena Tsantouli Major Review
8.3.1 Roles' Management All Giota Koltsida Major Review
8.3.2 Users' Management All Giota Koltsida Major Review
8.3.3 Profiles' Management All Giota Koltsida Major Review
8.3.4 Information Space Editor All Rena Tsantouli Major Review
8.3.5 Resource Management All Fabio Sinibaldi Major Review
8.3.6 Content Import All Federico De Faveri Major Review
8.3.7 Index Management All Kostas Tsakalozos Major Review
8.3.8 IR Bootstrapper All Giota Koltsida Major Review
8.4 Monitoring System All Major Review
9 Programmatic Administration Interface All Manuele Simi Major Review
12.1 Security Model All Major Review
12.2 How To Configure gHN Security All Major Review
12.3 How To Configure Identities For gCube Services All Major Review

Status of Components

Components Lacking Documentation Links

Component Related Ticket Issue Resolution Status
1 2
Ticket Creation Resolution
org.gcube.application-support-layer.application-support-layer-resourcemanagement
org.gcube.application-support-layer.application-support-layer-storagemanagement
org.gcube.application-support-layer.application-support-layer-voms
org.gcube.information-system.is-cache
org.gcube.metadata-management.mmlibrary
org.gcube.portal.custom-portal-handler
org.gcube.portlets-admin.collection-explorer
org.gcube.portlets-admin.data-transformation-admin-portlet
org.gcube.portlets-admin.taskmanager
org.gcube.portlets-admin.vre-deployer
org.gcube.portlets-user.gcube-loggedin-portlet
org.gcube.portlets-user.html-proxy-portlet
org.gcube.portlets-user.scorm-packaging
org.gcube.portlets-user.session-library
org.gcube.portlets-user.workspace-portlet-lighttree
org.gcube.vo-management.usermanagement-core

Components with Documentation Links Pointing to the Old Wiki

Component Old Wiki Link Corrected Link Related Ticket Issue Resolution Status
1 2
Ticket Creation Resolution
org.gcube.information-system.glite-bridge Link
org.gcube.information-system.glite-bridge-stubs Link
org.gcube.metadata-management.metadatamanager Link
org.gcube.metadata-management.metadatamanager-stubs Link
org.gcube.metadata-management.metadatamanager-testsuite Link
org.gcube.metadata-management.xmlindexer Link
org.gcube.metadata-management.xmlindexer-stubs Link
org.gcube.messaging.monitoring-probes Link
org.gcube.portlets-user.results-portlet Link
org.gcube.vo-management.authorization Link
org.gcube.vo-management.authorization-stubs Link
org.gcube.vo-management.authorization-testsuite Link
org.gcube.vo-management.delegation Link
org.gcube.vo-management.delegation-stubs Link
org.gcube.vo-management.delegation-testsuite Link
org.gcube.vo-management.voms-admin-stubs Link
org.gcube.vo-management.voms-api Link
org.gcube.vo-management.voms-api-testsuite Link

Components with Documentation Links Pointing to Invalid URLs

Component Identified Issue Problematic Link Corrected Link Related Ticket Issue Resolution Status
1 2
Ticket Creation Resolution
org.gcube.content-management.gcube-model-library Incorrect Page URL Link
org.gcube.content-management.view-manager Old CM Documentation Link
org.gcube.portlets-user.geospatial-portlet Irrelevant Documentation Section Link
org.gcube.portlets-user.report-generator-portlet Irrelevant Documentation Section Link
org.gcube.portlets-user.result-presentation Irrelevant Documentation Section Link
org.gcube.portlets-user.search-portlet Incorrect Section URL Link
org.gcube.portlets-user.template-generator Irrelevant Documentation Section Link