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, 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 #1520
3. Reference Model All Leonardo Candela, Pasquale Pagano, Manuele Simi Vassilis Moustakas Major Review 22-March-09 APPROVED #1534
4.1 GCube Infrastructure Enabling Services All Authors Reviewer Review Reason Due Date Status Ticket
4.1.1 Information System All Leonardo Candela, Manuele Simi Spyros Mpoytsis Major Review 22-March-09 APPROVED #1463
4.1.2 Virtual Organisation Management All Andrea Turli Spyros Mpoytsis Major Review 22-March-09 APPROVED #1464
4.1.3 VRE Management All Manuele Simi Fabio Simeoni Major Review 22-March-09 APPROVED #1699
4.1.4 Broker and Matchmaker All Andrea Turli Manuele Simi Major Review 22-March-09 APPROVED #1788
4.1.5 Process Management All Paola Ranaldi Paul Polydoras Major Review 22-March-09 APPROVED
4.1.6 Process Optimisation All Vangelis Floros Vasilis Verrios Major Review 22-March-09 APPROVED
4.2.1 Storage Management All Diego Milano Dimitris Katris Major Review 22-March-09 APPROVED #1805
4.2.2 Content Management All Diego Milano Giota Koltsida Major Review 22-March-09 APPROVED #1675
4.2.3 Collection Management All Diego Milano Giota Koltsida Major Review 22-March-09 APPROVED #1676
4.2.4 Metadata Management All Lucio Lelii, Manuele Simi Spyros Mpoytsis Major Review 22-March-09 APPROVED #1465
4.2.5 Annotation Management All Fabio Simeoni Dimitris Katris Major Review 22-March-09 APPROVED
4.2.6 Content Import All Diego Milano Leonardo Candela Major Review 22-March-09 Approved #1532
4.2.7 Data Transformation All Dimitris Katris Paola Ranaldi Major Review 22-March-09 APPROVED
4.3.1 gCube ResultSet (gRS) All Kostas Tsakalozos Manuele Simi Major Review 22-March-09 APPROVED
4.3.2 Search Framework All Paul Polydoras Vasilis Verrios Major Review 22-March-09 APPROVED #1504
4.3.3 Index Management Framework All Spyros Mpoutsis Vasilis Verrios Major Review 22-March-09 APPROVED #1503
4.3.4 Personalisation All Giota Koltsida Rena Tsantouli Major Review 22-March-09 APPROVED
4.3.5 DIR Support Framework All Fabio Simeoni Leonardo Candela Major Review 22-March-09 APPROVED #1533
4.3.6 gCube Ontology Management Service All Dimitris Katris Vasilis Verrios Major Review 22-March-09 APPROVED #1502
4.4.1 Application Support Layer All Rena Tsantouli Federico De Faveri Major Review 22-March-09 APPROVED #1539
4.4.2 gCube Portal Engine All Giota Koltsida Massimiliano Assante Major Review 22-March-09 APPROVED
5.1.3. Profile Specification All Manuele Simi Vassilis Moustakas Major Review 22-March-09 APPROVED #1536
5.1.4. Service Archive Specification All Lucio Lelii Vasilis Verrios Major Review 22-March-09 APPROVED
5.2.1. Developing Portlets with GWT All Valia Tsagkalidou Rena Tsantouli Major Review 22-March-09 APPROVED #1680
5.2.2. General guidelines about Portlet StyleSheets All Valia Tsagkalidou Rena Tsantouli Major Review 22-March-09 APPROVED #1681
5.3.1. Security Model All Andrea Turli Dimitris Katris Major Review 22-March-09 APPROVED #1679
5.3.2. How To Configure Service Security All Andrea Turli Dimitris Katris Major Review 22-March-09 APPROVED #1679
5.3.3. Common Security Troubleshooting All Andrea Turli Dimitris Katris Major Review 22-March-09 APPROVED #1679
5.3.4. How to use VOMS api library All Andrea Turli Dimitris Katris Major Review 22-March-09 APPROVED #1679

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 Rena Tsantouli Major Review 08-March-09 APPROVED
2.1 Virtual Research Environments and Community Portals All Leonardo Candela, Pasquale Pagano Rena Tsantouli Major Review 08-March-09 APPROVED
2.2 Content and Collections All Leonardo Candela, Pasquale Pagano Dimitris Katris Major Review 08-March-09 APPROVED
2.3 Content Annotation All Dimitris Katris Giota Koltsida Major Review 08-March-09 APPROVED
2.4 Metadata All Leonardo Candela, Pasquale Pagano Giota Koltsida Major Review 08-March-09 APPROVED #1721
3.1 Workspace All Federico De Faveri Rena Tsantouli Major Review 08-March-09 APPROVED #1735
3.2 Search All Valia, Giota Massimiliano Assante Major Review 08-March-09 APPROVED #1700
3.3 Result Browsing All Massimiliano Assante Rena Tsantouli Major Review 08-March-09 APPROVED #1736
3.4 Annotations All Dimitris Katris Federico De Faveri Major Review 08-March-09 APPROVED #1711
3.5 Metadata Management All Dimitris Katris Massimiliano Assante Major Review 08-March-09 APPROVED #1701
3.6 User Profile Management All Giota Koltsida Federico De Faveri Major Review 08-March-09 APPROVED #1714
3.7 Report Management All Massimiliano Assante Federico De Faveri Major Review 08-March-09 APPROVED #1717
4.1 Login to a portal instance and select a VRE All Giota Koltsida Federico De Faveri Major Review 08-March-09 APPROVED #1715
4.2 Perform a search and view the metadata of a record All Giota Koltsida Massimiliano Assante Major Review 08-March-09 APPROVED #1702
4.3 Change the XSLT at your profile and view the results using the new XSLT All Giota Koltsida Federico De Faveri Major Review 08-March-09 APPROVED #1716
4.4 Annotating Information Objects All Dimitris Katris Federico De Faveri Major Review 08-March-09 APPROVED
4.5 Send a workspace area item to another user All Federico De Faveri Dimitris Katris Major Review 08-March-09 APPROVED


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, Lino Pagano Paola Ranaldi Major Review December 18 APPROVED
2. gCube Overview All Leonardo Candela, Lino Pagano Paola Ranaldi Major Review December 18 Ready (This section points to Section 2 of Developer's Guide named gCube Architecture) APPROVED #1949
3. How to set up a gCube infrastructure All Manuele Simi Paola Ranaldi Major Review December 18 APPROVED #2058
4. gCube Hosting Node (gHN) Installation All Manuele Simi Diego Milano Major Review December 18 APPROVED
5. Core Services Installation All Manuele Simi Kostas Liaskos Major Review December 18 APPROVED
5.1 Information System Installation All Manuele Simi Kostas Liaskos Major Review December 18 APPROVED
5.2 VRE Management Services Installation All Manuele Simi Kostas Liaskos Major Review December 18 APPROVED
5.3 Broker & Matchmaker Installation All Manuele Simi Kostas Liaskos Major Review December 18 APPROVED
5.4 Dynamic Virtual Organization Support Service Installation All Paolo Roccetti Kostas Liaskos Major Review December 18 APPROVED
6. How to create a Virtual Organization All Manuele Simi Pedro Andrade Major Review December 18 APPROVED #2300
6.1 Installing the Virtual Organization enabling services All Manuele Simi Pedro Andrade Major Review December 18 APPROVED #2301
6.2 Configuring the Virtual Organization All Manuele Simi Pedro Andrade Major Review December 18 APPROVED #2302
6.3 Verifying the Virtual Organization correctness All Manuele Simi Pedro Andrade Major Review December 18 APPROVED
6.4 VO gCube Resources All Manuele Simi Pedro Andrade Major Review December 18 APPROVED #2303
6.5 Dynamic Services Deployment and Configuration All Manuele Simi Pedro Andrade Major Review December 18 APPROVED #2304
6.6 Monitoring the Virtual Organization All Manuele Simi Pedro Andrade Major Review December 18 APPROVED
6.7 Managing the Virtual Organization All Manuele Simi Pedro Andrade Major Review December 18 APPROVED #2321
7. How to create a Virtual Research Environment All Leonardo Candela, Lino Pagano Giota Koltsida Major Review December 18 APPROVED
7.1 Defining the Virtual Research Environment All Leonardo Candela, Lino Pagano Giota Koltsida Major Review December 18 APPROVED #2306
7.2 Approving the Virtual Research Environment All Leonardo Candela, Lino Pagano Giota Koltsida Major Review December 18 APPROVED #2307
7.3 Verifying the Virtual Research Environment correctness All Leonardo Candela, Lino Pagano Giota Koltsida Major Review December 18 APPROVED
7.4 Managing the Virtual Research Environment All Leonardo Candela, Lino Pagano Giota Koltsida Major Review December 18 APPROVED
8.1 gCube Portal Installation All Giota Koltsida Tommaso Piccioli Major Review December 18 APPROVED
8.2 Authorization management with LDAP All Massimiliano Assante Rena Tsantouli Major Review December 18 APPROVED #2326
8.3 Portal Administration Functionality All Rena Tsantouli Leonardo Candela, Lino Pagano Major Review December 18 APPROVED #2298
8.3.1 Layout Generator All Rena Tsantouli Leonardo Candela, Lino Pagano Major Review December 18 APPROVED #2299
8.3.2 Roles' Management All Giota Koltsida Leonardo Candela, Lino Pagano Major Review December 18 APPROVED
8.3.3 Users' Management All Giota Koltsida Leonardo Candela, Lino Pagano Major Review December 18 APPROVED
8.3.4 Information Space Editor All Rena Tsantouli Leonardo Candela, Lino Pagano Major Review December 18 APPROVED
8.3.5 Resource Management All Fabio Sinibaldi Leonardo Candela, Lino Pagano Major Review December 18 APPROVED #2331
8.3.6 Content Import All Diego Milano Leonardo Candela, Lino Pagano Major Review December 18 APPROVED
8.3.7 Index Management All Spyros Boutsis, Kostas Tsakalozos Leonardo Candela, Lino Pagano Major Review December 18 APPROVED
8.4 Monitoring System All Vassilis Moustakas Massimiliano Assante Major Review December 18 APPROVED #2108
11.1 Security Model All Paolo Roccetti Rena Tsantouli Major Review December 18 APROVED
11.2 How To Configure gHN Security All Paolo Roccetti Rena Tsantouli Major Review December 18 APPROVED
11.3 How To Configure Identities For gCube Services All Paolo Roccetti Rena Tsantouli Major Review December 18 APPROVED