Jump to: navigation, search

Difference between revisions of "Lyo/ProjectPlans"

< Lyo
(Milestones)
(Upcoming Releases)
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Introduction  =
 
= Introduction  =
  
This page contains the project plans for the Eclipse Lyo project. The first part of the plan describes the various components of Lyo and the currently planned enhancements to functionality. This plan is subject to changes based on community participation and the importance of proposed functionality to the community - we encourage anyone interested to participate. The planning process will be as open as possible and this plan will be updated as it changes. Please provide feedback on the lyo-dev@eclipse.org mailing list.  
+
This page contains the project plans for the Eclipse Lyo project. The first part of the plan describes the various components of Lyo and the currently planned enhancements to functionality. This plan is subject to changes based on community participation and the importance of proposed functionality to the community - we encourage anyone interested to participate. The planning process will be as open as possible and this plan will be updated as it changes. Please provide feedback on the [mailto:lyo-dev@eclipse.org lyo-dev@eclipse.org] mailing list.
 +
 
 +
You can also view the official release plans for Lyo at:  http://www.eclipse.org/projects/project-plan.php?projectid=technology.lyo
  
 
= Lyo Components  =
 
= Lyo Components  =
Line 14: Line 16:
 
*OSLC query parser  
 
*OSLC query parser  
 
*HTTP client library  
 
*HTTP client library  
*Basic, Form, Oauth support  
+
*Basic, Form, OAuth support  
 
*Client query builder (contributors needed)
 
*Client query builder (contributors needed)
  
Line 25: Line 27:
 
*Improve Requirements and Change Management MUST coverage ('''contributors needed''')  
 
*Improve Requirements and Change Management MUST coverage ('''contributors needed''')  
 
*Improved query tests ('''contributors needed''')  
 
*Improved query tests ('''contributors needed''')  
*Improved Oauth tests  
+
*Improved OAuth tests  
 
*Tests driven by resource shape documents ('''contributors needed''')
 
*Tests driven by resource shape documents ('''contributors needed''')
  
Line 32: Line 34:
 
Reference implementations are currently available for the Change, Requirements and Architecture Management specifications. See the&nbsp;[[Lyo/LyoRIO|Lyo reference implementation]] page for details. Currently planned enhancements are:  
 
Reference implementations are currently available for the Change, Requirements and Architecture Management specifications. See the&nbsp;[[Lyo/LyoRIO|Lyo reference implementation]] page for details. Currently planned enhancements are:  
  
*Support for the Quality Management domain ('''contributors needed''')
 
*Adoption of the OSLC Java SDK
 
 
*Refactoring to allow for pluggable RDF and application server technologies ('''contributors needed''')  
 
*Refactoring to allow for pluggable RDF and application server technologies ('''contributors needed''')  
 
*Improve reference implementation web UI ('''contributors needed''')
 
*Improve reference implementation web UI ('''contributors needed''')
 
<br>
 
  
 
== Additional Proposed SDKs  ==
 
== Additional Proposed SDKs  ==
Line 49: Line 47:
 
*JavaScript
 
*JavaScript
  
= Milestones  =
+
= Upcoming Releases =
  
Currently planned milestones are:  
+
Our next release, Lyo 2.0, is planned for 3Q 2013. We plan to move to quarterly releases after 2.0.
 +
 
 +
Release content will come from the prioritized backlog, stakeholder feedback, and community contributions. Contributions are always welcome! Even small bug fixes help.
 +
 
 +
= Lyo Backlog =
 +
 
 +
Backlog items with rough prioritizations:
 +
 
 +
* [HIGH] Build a W3C LDP reference impl and SDK for LDP only
 +
** Simple JAX-RS + Jena based reference server
 +
** Reference apps to driver reference server (possibly Node)
 +
** Build a OSLC V3 ref impl and/or SDK on it
 +
* [HIGH] OSLC4J support for Tracked Resource Set specification
 +
** Sample TRS consumer
 +
* [HIGH] Test suite and assessment report consumability
 +
** Deployable web app
 +
** Host for IBM
 +
** Increase MUST/SHOULD coverage
 +
* [HIGH] - Re-factor test suites to use OSLC4J and drive them via resource shape and service provider resurces
 +
* [HIGH] - JavaScript client library
 +
** Consumer navigation of provider (catalog->provider->resources)
 +
** Helpers for dialogs (frame handlers, etc)
 +
* [MEDIUM] Automation enablements
 +
** Hudson/Jenkins
 +
** Test tools
 +
** Chef/Puppet
 +
* [MEDIUM] Orion integration
 +
** [RDF formats] People like to hand crank some RDF formats, can we do something simple to plug into to provide some simple syntax highlighting and validation
 +
** [Node.js] Perhaps just a document of how to use Orion to do JS/Node dev with our impl.  FYI https://github.com/scripted-editor/scripted
 +
* [LOW] Perl enhancements, merge libs
 +
* [LOW] Python examples
 +
 
 +
= Previous Releases  =
 +
 
 +
* Lyo 1.1 (February 2013)
 +
* Lyo 1.0 (October 2012)
 +
 
 +
== Lyo 1.1 ==
 +
 
 +
Themes:
 +
 
 +
* Enhancing OSLC4J
 +
** OSLC Query library
 +
** OSLC consumer library
 +
** Other minor enhancements (RDF collection support, etc) and bug fixes
 +
* Test suite enhancements
 +
** RM suite improvements
 +
** Automation suite
 +
* OAuth libraries
 +
* Additional samples
 +
** client library sample usage
 +
** automation reference implementation
 +
 
 +
== Lyo 1.0 ==
  
 
* M1 (Q4 2011) - theme is test suite enhancements
 
* M1 (Q4 2011) - theme is test suite enhancements
  
  * Reporting
+
  * Compliance Reporting
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365198 Bug 365198 - Would like to add the compliance toolkit to the TestSuite]
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365201 Bug 365201 - Seeking a place to post OSLC compliance baseline reports]
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365206 Bug 365206 - Post the OSLC Test Suite and Compliance toolkit instructions documentation]
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365203 Bug 365302 - Post the "OSLC TestSuite and Compliance Test" demo/walkthrough video ]   
 
  * Improved CM MUST and SHOULD requirement coverage
 
  * Improved CM MUST and SHOULD requirement coverage
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365618 Bug 365618 - Complete CM MUST test cases]
 +
    * Goal: 100% CM MUST
 +
    * Analyze CM SHOULD coverage
 
  * Improved QM and RM MUST coverage
 
  * Improved QM and RM MUST coverage
  * Soliciting contributions for other domains
+
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365622 Bug 365622 - QM and RM core spec coverage by the test suite ]
 +
  * Suite bug fixes and enhancements
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=363478 Bug 363478 - Add test suite configuration for Bugzilla adapter ]
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=357387 Bug 357387 - Investigate uplift of TestSuites to Apache HttpClient 4.1.x ]
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365422 Bug 365422 - Add RDF model validation to the OSLC JUnits. ]
 +
    * [https://bugs.eclipse.org/bugs/buglist.cgi?cmdtype=dorem&remaction=run&namedcmd=Resolved%20Test%20Suite&sharer_id=123972 Already resolved improvements] 
  
 
* M2 (Q1 2012) - theme is initial Java SDK and refactored reference implementations
 
* M2 (Q1 2012) - theme is initial Java SDK and refactored reference implementations
  
 
  * Initial Java provider and client SDK
 
  * Initial Java provider and client SDK
 +
    * Initial contribution of OSLC4J
 +
    * Initial documentation to help developer's get started with OSLC4J
 
  * Example reference implementations based on the SDK
 
  * Example reference implementations based on the SDK
  * Additional test suite enhancements to support apps written with the SDK
+
    * CM reference implementation based on OSLC4J
 +
  * Test suite improvements
 +
  * Refactor test suite to enable additional domain tests more easily
 +
  * Test suite configurations for OSLC4J CM provider
 +
* Improved QM and RM MUST coverage
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=365622 Bug 365622 - QM and RM core spec coverage by the test suite ]
 +
* Provide a community webcast on Lyo content
  
 
* M3/Beta (Q2 2012) - theme is feature completeness
 
* M3/Beta (Q2 2012) - theme is feature completeness
  
 
  * Full Java provider and client SDKs
 
  * Full Java provider and client SDKs
  * Reference implementation completely refactored to take advantage of SDK
+
  * Re-vamped OSLC Workshop based on OSLC4J, including documentation
 
  * Reference implementation can use pluggable RDF/application server providers
 
  * Reference implementation can use pluggable RDF/application server providers
 +
  * Stub service provider for use as an OSLC starter application
 
  * Documentation
 
  * Documentation
 +
  * OSLC4J API reference guide
 +
  * OSLC4J Tutorial and Getting started guide.
 +
* Additional test suite enhancements to support apps written with the SDK
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=360175 Bug 360175 - Validate ATOM responses ]
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=360176 Bug 360176 - Test for link labels ]
 +
    * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=360180 Bug 360180 - Improve tests around partial get/put ]
 +
* Improve QM domain spec MUST coverage
 +
    * Goal (dependent on community): 75%
 +
* Test suite enhancements and bug fixes
 +
  * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=360184 Bug 360184 - Use OSLC throughout the test suite]
 +
  * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=360183 Bug 360183 - Define test suite cases in the form of scenarios ]
  
* Release candidates and 1.0 (Q3 2012) - theme is stabilization and shutdown
+
* Release candidates and 1.0 (Q3 2012) - theme is release readiness
 
+
  * Some reference implementation refactored to take advantage of SDK
 +
      * QM reference implementation based on OSLC4J
 +
      * AM reference implementation based on OSLC4J
 +
  * Test suite enhancements
 +
      * Improve CM, QM, RM core and domain SHOULD and MAY coverage
 +
      * Improve RM domain spec MUST coverage
 
   * Stretch items based on community participation
 
   * Stretch items based on community participation
       * non-Java language SDKs
+
       * non-Java language SDKs (could be in earlier milestones based on participation)
 +
        * C#/.NET
 +
        * Scripting languages (Python, Perl, Ruby)
 +
        * JavaScript client library
 
       * Additional reference implementation and test suite enhancements
 
       * Additional reference implementation and test suite enhancements
 
   * Release shutdown work
 
   * Release shutdown work
 +
 +
= Release Review Documentation =
 +
 +
* [http://wiki.eclipse.org/images/3/34/Lyo-1.0-Release-Graduation-Review.pdf Lyo 1.0 release/graduation documentation]
 +
* [http://wiki.eclipse.org/images/1/1c/Lyo-1.1-Release-Review.pdf Lyo 1.1 release documentation]

Revision as of 15:38, 28 June 2013

Introduction

This page contains the project plans for the Eclipse Lyo project. The first part of the plan describes the various components of Lyo and the currently planned enhancements to functionality. This plan is subject to changes based on community participation and the importance of proposed functionality to the community - we encourage anyone interested to participate. The planning process will be as open as possible and this plan will be updated as it changes. Please provide feedback on the lyo-dev@eclipse.org mailing list.

You can also view the official release plans for Lyo at: http://www.eclipse.org/projects/project-plan.php?projectid=technology.lyo

Lyo Components

OSLC Java SDKs

  • Documentation
  • Constant strings for OSLC namespaces and providers
  • POJO model for OSLC resources
  • RDF parser and serializer
  • JSON parser and serializer
  • OSLC query parser
  • HTTP client library
  • Basic, Form, OAuth support
  • Client query builder (contributors needed)

Test suite for OSLC

The test suite for OSLC is currently available on the Lyo project. See the Lyo test suite page for details. Currently planned enhancements are

  • Add reporting capabilities
  • Improve Change Management MUST and SHOULD requirement coverage (contributors needed)
  • Improve Requirements and Change Management MUST coverage (contributors needed)
  • Improved query tests (contributors needed)
  • Improved OAuth tests
  • Tests driven by resource shape documents (contributors needed)

Reference implementations for OSLC (RIOs)

Reference implementations are currently available for the Change, Requirements and Architecture Management specifications. See the Lyo reference implementation page for details. Currently planned enhancements are:

  • Refactoring to allow for pluggable RDF and application server technologies (contributors needed)
  • Improve reference implementation web UI (contributors needed)

Additional Proposed SDKs

Contributors are needed and welcome for all of the following:

  • .NET (C# or other)
  • Perl
  • Python
  • PHP
  • JavaScript

Upcoming Releases

Our next release, Lyo 2.0, is planned for 3Q 2013. We plan to move to quarterly releases after 2.0.

Release content will come from the prioritized backlog, stakeholder feedback, and community contributions. Contributions are always welcome! Even small bug fixes help.

Lyo Backlog

Backlog items with rough prioritizations:

  • [HIGH] Build a W3C LDP reference impl and SDK for LDP only
    • Simple JAX-RS + Jena based reference server
    • Reference apps to driver reference server (possibly Node)
    • Build a OSLC V3 ref impl and/or SDK on it
  • [HIGH] OSLC4J support for Tracked Resource Set specification
    • Sample TRS consumer
  • [HIGH] Test suite and assessment report consumability
    • Deployable web app
    • Host for IBM
    • Increase MUST/SHOULD coverage
  • [HIGH] - Re-factor test suites to use OSLC4J and drive them via resource shape and service provider resurces
  • [HIGH] - JavaScript client library
    • Consumer navigation of provider (catalog->provider->resources)
    • Helpers for dialogs (frame handlers, etc)
  • [MEDIUM] Automation enablements
    • Hudson/Jenkins
    • Test tools
    • Chef/Puppet
  • [MEDIUM] Orion integration
    • [RDF formats] People like to hand crank some RDF formats, can we do something simple to plug into to provide some simple syntax highlighting and validation
    • [Node.js] Perhaps just a document of how to use Orion to do JS/Node dev with our impl.  FYI https://github.com/scripted-editor/scripted
  • [LOW] Perl enhancements, merge libs
  • [LOW] Python examples

Previous Releases

  • Lyo 1.1 (February 2013)
  • Lyo 1.0 (October 2012)

Lyo 1.1

Themes:

  • Enhancing OSLC4J
    • OSLC Query library
    • OSLC consumer library
    • Other minor enhancements (RDF collection support, etc) and bug fixes
  • Test suite enhancements
    • RM suite improvements
    • Automation suite
  • OAuth libraries
  • Additional samples
    • client library sample usage
    • automation reference implementation

Lyo 1.0

  • M1 (Q4 2011) - theme is test suite enhancements
* Compliance Reporting
   * Bug 365198 - Would like to add the compliance toolkit to the TestSuite
   * Bug 365201 - Seeking a place to post OSLC compliance baseline reports
   * Bug 365206 - Post the OSLC Test Suite and Compliance toolkit instructions documentation
   * Bug 365302 - Post the "OSLC TestSuite and Compliance Test" demo/walkthrough video     
* Improved CM MUST and SHOULD requirement coverage
   * Bug 365618 - Complete CM MUST test cases
   * Goal: 100% CM MUST
   * Analyze CM SHOULD coverage
* Improved QM and RM MUST coverage
   * Bug 365622 - QM and RM core spec coverage by the test suite 
* Suite bug fixes and enhancements
   * Bug 363478 - Add test suite configuration for Bugzilla adapter 
   * Bug 357387 - Investigate uplift of TestSuites to Apache HttpClient 4.1.x 
   * Bug 365422 - Add RDF model validation to the OSLC JUnits. 
   * Already resolved improvements  
  • M2 (Q1 2012) - theme is initial Java SDK and refactored reference implementations
* Initial Java provider and client SDK
   * Initial contribution of OSLC4J
   * Initial documentation to help developer's get started with OSLC4J
* Example reference implementations based on the SDK
   * CM reference implementation based on OSLC4J
* Test suite improvements
  * Refactor test suite to enable additional domain tests more easily 
  * Test suite configurations for OSLC4J CM provider
* Improved QM and RM MUST coverage
   * Bug 365622 - QM and RM core spec coverage by the test suite 
* Provide a community webcast on Lyo content
  • M3/Beta (Q2 2012) - theme is feature completeness
* Full Java provider and client SDKs
* Re-vamped OSLC Workshop based on OSLC4J, including documentation
* Reference implementation can use pluggable RDF/application server providers
  * Stub service provider for use as an OSLC starter application
* Documentation
  * OSLC4J API reference guide
  * OSLC4J Tutorial and Getting started guide.
* Additional test suite enhancements to support apps written with the SDK
   * Bug 360175 - Validate ATOM responses 
   * Bug 360176 - Test for link labels 
   * Bug 360180 - Improve tests around partial get/put 
* Improve QM domain spec MUST coverage
   * Goal (dependent on community): 75%
* Test suite enhancements and bug fixes
  * Bug 360184 - Use OSLC throughout the test suite
  * Bug 360183 - Define test suite cases in the form of scenarios 
  • Release candidates and 1.0 (Q3 2012) - theme is release readiness
  * Some reference implementation refactored to take advantage of SDK
     * QM reference implementation based on OSLC4J
     * AM reference implementation based on OSLC4J 
  * Test suite enhancements
     * Improve CM, QM, RM core and domain SHOULD and MAY coverage
     * Improve RM domain spec MUST coverage
  * Stretch items based on community participation
     * non-Java language SDKs (could be in earlier milestones based on participation)
        * C#/.NET
        * Scripting languages (Python, Perl, Ruby)
        * JavaScript client library
     * Additional reference implementation and test suite enhancements
  * Release shutdown work

Release Review Documentation