Contract SFS-DEV-005: Difference between revisions

From OpenSFS Wiki
Jump to navigation Jump to search
 
(18 intermediate revisions by 2 users not shown)
Line 4: Line 4:


For the details please see the [[Media:SFS-DEV-005_Statement_of_Work.pdf|contract statement of work]].
For the details please see the [[Media:SFS-DEV-005_Statement_of_Work.pdf|contract statement of work]].
The contract was terminated on July 28, 2015.  The final git commit of the project was 1c8320fcc3906ae5de4e0f58bbba96e0d91a9bf4.
=== In-progress output ===
PDF and html artifacts are automatically built for every change submitted into the Documentation project. A build of the current master of the Protocols Documentation project is available here:
[https://build.hpdd.intel.com/job/lustre-protocol-reviews/lastSuccessfulBuild/artifact/ https://build.hpdd.intel.com/job/lustre-protocol-reviews/lastSuccessfulBuild/artifact/]
=== Contract Termination ===
The contract was terminated on July 28, 2015.  The final git commit of the project was 1c8320fcc3906ae5de4e0f58bbba96e0d91a9bf4.


== Key People ==
== Key People ==
Line 33: Line 45:


The official start date of work is agreed to be January 13, 2015.
The official start date of work is agreed to be January 13, 2015.
The contract termination date was July 28, 2015.
== Tracking Ticket ==
[https://jira.hpdd.intel.com/browse/LUDOC-280 LUDOC-280] is the top level ticket that tracks the work performed under this contract.  Individual work tickets can be found through that top level ticket.


== Source Repository ==
== Source Repository ==
Line 44: Line 62:
   http://git.hpdd.intel.com/doc/protocol.git
   http://git.hpdd.intel.com/doc/protocol.git


The contents of the source repository are managed via a [https://review.hpdd.intel.com/ Gerritt] review interface. To initiate a change (including new content), one begins by filing a [https://jira.hpdd.intel.com/ Jira] ticket. The process is:
Changes to the documentation are submitted through the same gerrit review system that is used for the Lustre source code, just under a different target git repository and project name.
* File an LUDOC Jira ticket, in this case identifying the doc/protocol module.
 
* Address the issue from that ticket in a clone of the repository ([https://wiki.hpdd.intel.com/display/PUB/Using+Gerrit instructions])
If you are using Fedora, you can install the required AsciiDoc packages with:
* Explicitly mention the Jira (LUDOC-) ticket number in the commit message. When pushed back top the origin repository this results in a "change" artifact that is identified by a URL in the output of the 'git push'. 
 
* Update the Jira ticket identifying the URL of the change being pushed.
  yum install asciidoc
 
With AsciiDoc installed you can produce a html version of the protocols documentation using:
 
  asciidoc protocol.txt
 
and a pdf version with:
 
  a2x -f pdf --fop protocol.txt
 
== Meeting minutes ==
 
[[2015-03-02 Protocols Document meeting minutes]]
 
[[2015-06-01 Protocols Document meeting minutes]]
 
[[2015-06-15 Protocols Document meeting minutes]]
 
[[2015-06-22 Protocols Document meeting minutes]]
 
[[2015-06-29 Protocols Document meeting minutes]]
 
[[2015-07-06 Protocols Document meeting minutes]]


For convenience, we list the [[SFS-DEV-005 Jira Tickets|Jira tickets]] related to this project.
[[2015-07-13 Protocols Document meeting minutes]]

Latest revision as of 11:44, 11 September 2015

Overview

The goal of contract SFS-DEV-005 is to document the Lustre protocol.

For the details please see the contract statement of work.

The contract was terminated on July 28, 2015. The final git commit of the project was 1c8320fcc3906ae5de4e0f58bbba96e0d91a9bf4.

In-progress output

PDF and html artifacts are automatically built for every change submitted into the Documentation project. A build of the current master of the Protocols Documentation project is available here:

https://build.hpdd.intel.com/job/lustre-protocol-reviews/lastSuccessfulBuild/artifact/

Contract Termination

The contract was terminated on July 28, 2015. The final git commit of the project was 1c8320fcc3906ae5de4e0f58bbba96e0d91a9bf4.

Key People

OpenSFS

  • Sarp Oral - OpenSFS Contract Administrator
  • Christopher Morrone - OpenSFS Technical Representative

Project Approval Committee (PAC)

  • Christopher Morrone (LLNL) - PAC Chair
  • Colin Faber (Seagate)
  • Ruth Klundt (Sandia)
  • Jacques-Charles Lafoucriere (CEA)
  • Olaf Faaland (LLNL)
  • Ned Bass (LLNL)
  • Chris Horn (Cray)
  • Cory Spitz (Cray)
  • Justin Miller (Cray)

Intel

  • Andrew Uselton - Engineer
  • Richard Henwood - Project Manager
  • Andreas Dilger

Important Dates

The official start date of work is agreed to be January 13, 2015.

The contract termination date was July 28, 2015.

Tracking Ticket

LUDOC-280 is the top level ticket that tracks the work performed under this contract. Individual work tickets can be found through that top level ticket.

Source Repository

The sources of the documentation are found in the following git repository:

 git://review.hpdd.intel.com/doc/protocol

A web interface to the repository is:

 http://git.hpdd.intel.com/doc/protocol.git

Changes to the documentation are submitted through the same gerrit review system that is used for the Lustre source code, just under a different target git repository and project name.

If you are using Fedora, you can install the required AsciiDoc packages with:

 yum install asciidoc

With AsciiDoc installed you can produce a html version of the protocols documentation using:

 asciidoc protocol.txt

and a pdf version with:

 a2x -f pdf --fop protocol.txt

Meeting minutes

2015-03-02 Protocols Document meeting minutes

2015-06-01 Protocols Document meeting minutes

2015-06-15 Protocols Document meeting minutes

2015-06-22 Protocols Document meeting minutes

2015-06-29 Protocols Document meeting minutes

2015-07-06 Protocols Document meeting minutes

2015-07-13 Protocols Document meeting minutes