Skip to main content
Jump to: navigation, search

Difference between revisions of "Intent/ReleaseReview/0.8"

(New page: =Eclipse Kepler (4.3) Release Review - Mylyn Intent 0.8= Alex Lagarde ''(alex.lagarde@obeo.fr)'' Release Review : June, 2013 ''Communication Channel : [http://www.eclipse.org/forums/ecl...)
 
(Bugzilla)
 
(36 intermediate revisions by the same user not shown)
Line 24: Line 24:
 
As listed in the [http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs.intent Project Plan], Intent 0.8 provides the following features :  
 
As listed in the [http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs.intent Project Plan], Intent 0.8 provides the following features :  
  
* Mylyn Intent : Intent generic components and authoring environment (editor, compiler, synchronizer...). Notice that it can be used in RCP mode as it is independant from core.resources
+
* '''Mylyn Intent''' : Intent generic components and authoring environment (editor, compiler, synchronizer...). Notice that it can be used in RCP mode as it is independant from core.resources
* Mylyn Intent - Workspace support: Required to make Intent work on an Eclipse workspace (specific views, project wizards...)
+
* '''Mylyn Intent - Workspace support''': Required to make Intent work on an Eclipse workspace (specific views, project wizards...)
* Mylyn Intent - CDO support: Required to make Intent work on a CDO repository (specific views, project wizards...)
+
* '''Mylyn Intent - CDO support''': Required to make Intent work on a CDO repository (specific views, project wizards...)
* Mylyn Intent Connector: Java: allows to directly drop java files/classes/methods inside an Intent doc an synchronize them
+
* '''Mylyn Intent Connector: Java''': allows to directly drop java files/classes/methods inside an Intent doc an synchronize them
* Doc generators For Wikitext : A set of generators for Wikitext documents (Latex, html...)
+
* '''Doc generators For Wikitext''': A set of generators for Wikitext documents (Latex, html...)
* Doc generators For Intent document : A set of generators allowing to export an Intent Project to several formats (HTML Bootstrap...)
+
* '''Doc generators For Intent document''': A set of generators allowing to export an Intent Project to several formats (HTML Bootstrap...)
  
 
= Code Aspects =
 
= Code Aspects =
Line 42: Line 42:
 
The about files and use licenses are in place as per the Guidelines to Legal Documentation.
 
The about files and use licenses are in place as per the Guidelines to Legal Documentation.
  
 +
Here are the CQ still used by Intent 0.8 :
 
{| border="1" cellpadding="7" cellspacing="0"
 
{| border="1" cellpadding="7" cellspacing="0"
 
! CQ !!  Third-Party Code !!  License !!  Use
 
! CQ !!  Third-Party Code !!  License !!  Use
 
|-  
 
|-  
! [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=5305 5305] || Google Collections Version: 1.0 (PB Orbit CQ3679) ||Apache License, 2.0 ||unmodified binary
+
! [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=6301 6301] || junit Version: 4.8.1 (PB Orbit CQ3678) ||Common Public License 1.0 || unmodified binary
 
|-  
 
|-  
 
! [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=7060 6311] || Guava Version: 11.0.2 (PB CQ7056)|| Apache License, 2.0 || unmodified binary
 
! [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=7060 6311] || Guava Version: 11.0.2 (PB CQ7056)|| Apache License, 2.0 || unmodified binary
 
|}
 
|}
 +
And older CQs (for Intent 0.7)
 +
{| border="1" cellpadding="7" cellspacing="0"
 +
! CQ !!  Third-Party Code !!  License !!  Use
 +
|-
 +
! [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=5305 5305] || Google Collections Version: 1.0 (PB Orbit CQ3679) ||Apache License, 2.0 ||unmodified binary
 +
|-
 +
! [https://dev.eclipse.org/ipzilla/show_bug.cgi?id=6311 6311] || Guava Version: 10.0.1 (PB Orbit CQ6121)|| Apache License, 2.0 || unmodified binary
 +
|}
 +
  
 
All other contributions (code, documentation, images, etc) have been committed by individuals who are either Members of the Foundation, or have signed the appropriate Committer Agreement. In either case, these are individuals who have signed, and are abiding by, the Eclipse IP Policy. The other contributions of the IP log are not significant or are written 100% by employees of the same employer (Obeo) as the Submitting Committer (http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
 
All other contributions (code, documentation, images, etc) have been committed by individuals who are either Members of the Foundation, or have signed the appropriate Committer Agreement. In either case, these are individuals who have signed, and are abiding by, the Eclipse IP Policy. The other contributions of the IP log are not significant or are written 100% by employees of the same employer (Obeo) as the Submitting Committer (http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
Line 61: Line 71:
  
 
== Tests ==
 
== Tests ==
150 unit and integration tests are launched every day. We plan to improve this number to increase stability in the next releases.
+
216 unit and integration tests are launched every day. We plan to improve this number to increase stability in the next releases.
  
 
== Code quality ==
 
== Code quality ==
Line 68: Line 78:
 
The Intent hudson builds relies on Jacoco to provide code-coverage informations automatically, and it is very easy to use Sonar to have informations about Intent code quality. Intent Sonar report is regulary refreshed by [http://nemo.sonarsource.org/dashboard/index/397381?page_id=3 Nemo] (although we still have to work on the code coverage, which is not correctly calculated).
 
The Intent hudson builds relies on Jacoco to provide code-coverage informations automatically, and it is very easy to use Sonar to have informations about Intent code quality. Intent Sonar report is regulary refreshed by [http://nemo.sonarsource.org/dashboard/index/397381?page_id=3 Nemo] (although we still have to work on the code coverage, which is not correctly calculated).
  
Javadoc and comments represents more than 45% of the Intent Java source code.
+
Javadoc and comments represents more than 42% of the Intent Java source code.
  
 
==APIs==
 
==APIs==
Line 74: Line 84:
  
 
==Documentation==
 
==Documentation==
For the Intent 0.8 release, Intent documentation is being centralised on Intent wiki, as it is going to be regulary improved and completed.
+
 
For the 0.8 release, we plan to provide an Eclipse Help plugin.
+
Although we plan to drastically improve Intent documentation (using Intent itself), here are the documentation available for Intent 0.8 :
 +
- an eclipse Help plugin providing a simple Getting Started Guide (under Mylyn User Guide)
 +
- a cheat sheet (automatically opened when creating an Intent project, this can be changed from preferences) allowing to easilly get started with Intent
 +
- the Intent wiki, that we try to make as complete as possible
  
 
==Bugzilla==
 
==Bugzilla==
 +
Note: a "Closed" issue means that the issue has been validated on an official milestone.
 +
Hence there is no Intent issue that is "resolved" without being "closed", as all resolved issues have been validated on one of Intent RCs.
  
 +
Bugzilla issues (all releases combined)
 
{| border="1" cellpadding="5" cellspacing="0"  
 
{| border="1" cellpadding="5" cellspacing="0"  
 
|-
 
|-
 
|  
 
|  
 
! style="background: #CECEF2;" | NEW
 
! style="background: #CECEF2;" | NEW
| RESOLVED
+
| ASSIGNED
| VERIFIED
+
 
! style="background: #CECEF2;" | CLOSED
 
! style="background: #CECEF2;" | CLOSED
 
! style="background: #CEF2CE;" | TOTAL
 
! style="background: #CEF2CE;" | TOTAL
Line 90: Line 105:
 
| blocker
 
| blocker
 
! style="background: #CECEF2;" | 0
 
! style="background: #CECEF2;" | 0
| 0
 
 
| 0
 
| 0
 
! style="background: #CECEF2;" | 1
 
! style="background: #CECEF2;" | 1
Line 98: Line 112:
 
! style="background: #CECEF2;" | 0
 
! style="background: #CECEF2;" | 0
 
| 0
 
| 0
| 0
+
! style="background: #CECEF2;" | 1
! style="background: #CECEF2;" | 0
+
! style="background: #CEF2CE;" | 1
! style="background: #CEF2CE;" | 0
+
 
|-
 
|-
 
| major
 
| major
! style="background: #CECEF2;" | 1
+
! style="background: #CECEF2;" | 0
 
| 0
 
| 0
| 0
+
! style="background: #CECEF2;" | 5
! style="background: #CECEF2;" | 3
+
! style="background: #CEF2CE;" | 5
! style="background: #CEF2CE;" | 4
+
 
|-
 
|-
 
| normal
 
| normal
! style="background: #CECEF2;" | 5
+
! style="background: #CECEF2;" | 4
| 1
+
 
| 0
 
| 0
! style="background: #CECEF2;" | 7
+
! style="background: #CECEF2;" | 25
! style="background: #CEF2CE;" | 11
+
! style="background: #CEF2CE;" |29
 
|-
 
|-
 
| minor
 
| minor
 +
! style="background: #CECEF2;" | 3
 +
| 0
 +
! style="background: #CECEF2;" | 6
 +
! style="background: #CEF2CE;" | 9
 +
|-
 +
| enhancement
 +
! style="background: #CECEF2;" | 13
 +
| 1
 +
! style="background: #CECEF2;" | 12
 +
! style="background: #CEF2CE;" | 26
 +
|-
 +
! style="background: #CEF2CE;" | TOTAL
 +
! style="background: #CEF2CE;" | 21
 +
! style="background: #CEF2CE;" | 1
 +
! style="background: #CEF2CE;" | 49
 +
! style="background: #CEF2CE;" | 71
 +
|}
 +
 +
 +
Bugzilla issues (only for Intent 0.8: issues created or resolved since Intent 0.7 release)
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
|-
 +
|
 +
! style="background: #CECEF2;" | NEW
 +
| ASSIGNED
 +
! style="background: #CECEF2;" | CLOSED
 +
! style="background: #CEF2CE;" | TOTAL
 +
|-
 +
| blocker
 
! style="background: #CECEF2;" | 0
 
! style="background: #CECEF2;" | 0
| 0
 
 
| 0
 
| 0
 
! style="background: #CECEF2;" | 0
 
! style="background: #CECEF2;" | 0
 
! style="background: #CEF2CE;" | 0
 
! style="background: #CEF2CE;" | 0
 
|-
 
|-
| enhancement
+
| critical
 
! style="background: #CECEF2;" | 0
 
! style="background: #CECEF2;" | 0
 
| 0
 
| 0
 +
! style="background: #CECEF2;" | 1
 +
! style="background: #CEF2CE;" | 1
 +
|-
 +
| major
 +
! style="background: #CECEF2;" | 0
 
| 0
 
| 0
 
! style="background: #CECEF2;" | 2
 
! style="background: #CECEF2;" | 2
 
! style="background: #CEF2CE;" | 2
 
! style="background: #CEF2CE;" | 2
 +
|-
 +
| normal
 +
! style="background: #CECEF2;" | 0
 +
| 0
 +
! style="background: #CECEF2;" | 18
 +
! style="background: #CEF2CE;" |18
 +
|-
 +
| minor
 +
! style="background: #CECEF2;" | 3
 +
| 0
 +
! style="background: #CECEF2;" | 6
 +
! style="background: #CEF2CE;" | 9
 +
|-
 +
| enhancement
 +
! style="background: #CECEF2;" | 13
 +
| 1
 +
! style="background: #CECEF2;" | 10
 +
! style="background: #CEF2CE;" | 24
 
|-
 
|-
 
! style="background: #CEF2CE;" | TOTAL
 
! style="background: #CEF2CE;" | TOTAL
! style="background: #CEF2CE;" | 7
+
! style="background: #CEF2CE;" | 27
! style="background: #CEF2CE;" | 0
+
! style="background: #CEF2CE;" | 1
! style="background: #CEF2CE;" | 0
+
! style="background: #CEF2CE;" | 36
! style="background: #CEF2CE;" | 13
+
! style="background: #CEF2CE;" | 54
! style="background: #CEF2CE;" | 20
+
 
|}
 
|}
 
Note : these figures are subject to changes as the whole team is in the process of fixing bugs until the final release (this snapshot has been taken on Mai 22, 2011)?
 
  
 
==UI Usability==
 
==UI Usability==
Line 149: Line 208:
  
 
* Website: The [http://eclipse.org/intent/|Intent Website] has been reworked for the release and reflects the latest information
 
* Website: The [http://eclipse.org/intent/|Intent Website] has been reworked for the release and reflects the latest information
* User documentation: [[Intent|Intent Wiki]] includes [[Intent/Getting_Started|Getting Started]] Tutorials and some more detailed documentation.
+
* User documentation: from eclipse help, in cheat sheets and from the [[Intent|Intent Wiki]] (which includes [[Intent/Getting_Started|Getting Started]] Tutorials and some more detailed documentation).
 
* Full talk transcripts: every talk gave at technical conferences (like EclipseCon) are made available to readers  [http://www.eclipse.org/intent/pages/transcripts/2012_AgileALMConnect/Intent_AgileALMConnect2012.htm Agile ALM Connect 2012] and [http://www.eclipse.org/intent/pages/transcripts/2011_EclipseConEurope/Intent_ece2011.htm EclipseConEurope 2011]
 
* Full talk transcripts: every talk gave at technical conferences (like EclipseCon) are made available to readers  [http://www.eclipse.org/intent/pages/transcripts/2012_AgileALMConnect/Intent_AgileALMConnect2012.htm Agile ALM Connect 2012] and [http://www.eclipse.org/intent/pages/transcripts/2011_EclipseConEurope/Intent_ece2011.htm EclipseConEurope 2011]
 
* Video demonstrations : representative [[Intent/Videos| Intent video demonstrations]] are available on wiki
 
* Video demonstrations : representative [[Intent/Videos| Intent video demonstrations]] are available on wiki
Line 157: Line 216:
 
== Communities ==
 
== Communities ==
 
Talks have been given on the following events:
 
Talks have been given on the following events:
* Mylyn Intent at EclipseCon Europe 2011 : https://www.eclipsecon.org/submissions/2011/view_talk.php?id=2199
+
* Mylyn Intent at EclipseCon France 2013 (coming in June 2013)
* Mylyn Intent at Agile ALM Connect 2012 (EclipseCon 2012) : http://www.eclipsecon.org/2012/sessions/create-useful-documentation-mylyn-intent-step-further-application-life-cycle-management.
+
* Mylyn Intent at Agile ALM Connect 2013(EclipseCon 2013): http://www.eclipse.org/intent/pages/transcripts/2013_EclipseConBoston/Intent_EConBoston2013.html#1
 +
* Documentation Driven Testing (approach based on Intent) at EclipseCon 2013 : http://www.eclipse.org/intent/pages/transcripts/2013_EclipseConBoston_DDT/DocDrivenTesting_EconBoston2013.html#1
 +
* Interview about Intent on JAXenter http://jaxenter.com/eclipse-intent-being-agile-does-not-mean-being-short-sighted-45856.html
 +
* Mylyn Intent at EclipseCon Europe 2012: http://www.eclipse.org/intent/pages/transcripts/2012_EclipseConEurope/Intent_EConEurope2012.html#1
 +
* Mylyn Intent at Agile ALM Connect 2012 (EclipseCon 2012): http://www.eclipsecon.org/2012/sessions/create-useful-documentation-mylyn-intent-step-further-application-life-cycle-management.
 +
* Mylyn Intent at EclipseCon Europe 2011: https://www.eclipsecon.org/submissions/2011/view_talk.php?id=2199
  
 
== Other medium ==
 
== Other medium ==
* Activity on the intent newsgroup (eclipse.intent): 28 messages on Intent from June 2011 to May 2012
+
* Activity on the intent newsgroup (eclipse.intent): 40 messages on Intent from July 2012 to May 2013
 
* Twitter account of the Intent project: https://twitter.com/#!/Intent_project
 
* Twitter account of the Intent project: https://twitter.com/#!/Intent_project
  
Line 169: Line 233:
 
==Schedule==
 
==Schedule==
 
Intent 0.8 Release Plan
 
Intent 0.8 Release Plan
* RC1 Wenesday, May 23
+
* RC1 Wenesday, May 22
* RC2 Wenesday, May 30
+
* RC2 Wenesday, May 28
* Final Wenesday, May 30
+
* RC3 Wenesday, June 05
 +
* RC4 Wenesday, June 12 
 +
* Final Wenesday, June 12
  
 
==Project Plan==
 
==Project Plan==
 
Intent 0.8 project plan is available at http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs.intent
 
Intent 0.8 project plan is available at http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs.intent

Latest revision as of 05:42, 30 May 2013

Eclipse Kepler (4.3) Release Review - Mylyn Intent 0.8

Alex Lagarde (alex.lagarde@obeo.fr)

Release Review : June, 2013

Communication Channel : eclipse.intent (newsgroup) & mylyn-intent-dev (mailing list)

Process Documentation : http://www.eclipse.org/projects/dev_process/development_process.php

Project Plan : http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs.intent

Introduction

Intent is a tool allowing developers to easily write a documentation up-to-date with any development artifact (models, code, environment...).

The documentation, integrated with other Eclipse tools, then becomes truly useful and is no longer a burden that developer have to carry to please their customers or their project manager.

Based on Donald Knuth's Literate Programming concepts and allowing collaborative work around design tasks, Intent will try to reconcile developers with Documentation.

Fore more details about Intent scope, please refer to Intent Project mission statements

Features

As listed in the Project Plan, Intent 0.8 provides the following features :

  • Mylyn Intent : Intent generic components and authoring environment (editor, compiler, synchronizer...). Notice that it can be used in RCP mode as it is independant from core.resources
  • Mylyn Intent - Workspace support: Required to make Intent work on an Eclipse workspace (specific views, project wizards...)
  • Mylyn Intent - CDO support: Required to make Intent work on a CDO repository (specific views, project wizards...)
  • Mylyn Intent Connector: Java: allows to directly drop java files/classes/methods inside an Intent doc an synchronize them
  • Doc generators For Wikitext: A set of generators for Wikitext documents (Latex, html...)
  • Doc generators For Intent document: A set of generators allowing to export an Intent Project to several formats (HTML Bootstrap...)

Code Aspects

Committer Diversity

3 Committers from Obeo, and 2 individual committers.

API

Mylyn Intent 0.8 is still in incubation. When required for good reasons, we did break the previous 0.7 API (espicially because of model refactorings). We have made effort to make the API as complete as possible, but we do not forbid ourselves to make minor breaks in the API for the next year release. We may plan to graduate (move out from incubation phase) next year, and in that case we will define a stric policy in regards to API breaks.

IP Issues

The about files and use licenses are in place as per the Guidelines to Legal Documentation.

Here are the CQ still used by Intent 0.8 :

CQ Third-Party Code License Use
6301 junit Version: 4.8.1 (PB Orbit CQ3678) Common Public License 1.0 unmodified binary
6311 Guava Version: 11.0.2 (PB CQ7056) Apache License, 2.0 unmodified binary

And older CQs (for Intent 0.7)

CQ Third-Party Code License Use
5305 Google Collections Version: 1.0 (PB Orbit CQ3679) Apache License, 2.0 unmodified binary
6311 Guava Version: 10.0.1 (PB Orbit CQ6121) Apache License, 2.0 unmodified binary


All other contributions (code, documentation, images, etc) have been committed by individuals who are either Members of the Foundation, or have signed the appropriate Committer Agreement. In either case, these are individuals who have signed, and are abiding by, the Eclipse IP Policy. The other contributions of the IP log are not significant or are written 100% by employees of the same employer (Obeo) as the Submitting Committer (http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).

The "provider" field of each plugin is set to "Eclipse Mylyn".

The "copyright" field of each plugin is set to the copyright owner.

Any third-party logos or trademarks included in the distribution (icons, logos, etc) have been licensed under the EPL.

The Intent 0.8 IP log is located at http://www.eclipse.org/projects/ip_log.php?projectid=mylyn.docs.intent

Tests

216 unit and integration tests are launched every day. We plan to improve this number to increase stability in the next releases.

Code quality

Checkstyle activated on each distinct plug-in.

The Intent hudson builds relies on Jacoco to provide code-coverage informations automatically, and it is very easy to use Sonar to have informations about Intent code quality. Intent Sonar report is regulary refreshed by Nemo (although we still have to work on the code coverage, which is not correctly calculated).

Javadoc and comments represents more than 42% of the Intent Java source code.

APIs

Metamodel definitions and interfaces are considered APIs.

Documentation

Although we plan to drastically improve Intent documentation (using Intent itself), here are the documentation available for Intent 0.8 : - an eclipse Help plugin providing a simple Getting Started Guide (under Mylyn User Guide) - a cheat sheet (automatically opened when creating an Intent project, this can be changed from preferences) allowing to easilly get started with Intent - the Intent wiki, that we try to make as complete as possible

Bugzilla

Note: a "Closed" issue means that the issue has been validated on an official milestone. Hence there is no Intent issue that is "resolved" without being "closed", as all resolved issues have been validated on one of Intent RCs.

Bugzilla issues (all releases combined)

NEW ASSIGNED CLOSED TOTAL
blocker 0 0 1 1
critical 0 0 1 1
major 0 0 5 5
normal 4 0 25 29
minor 3 0 6 9
enhancement 13 1 12 26
TOTAL 21 1 49 71


Bugzilla issues (only for Intent 0.8: issues created or resolved since Intent 0.7 release)

NEW ASSIGNED CLOSED TOTAL
blocker 0 0 0 0
critical 0 0 1 1
major 0 0 2 2
normal 0 0 18 18
minor 3 0 6 9
enhancement 13 1 10 24
TOTAL 27 1 36 54

UI Usability

The UI follows the Eclipse user interface guidelines, if applicable.

End of Life

There are no specific end of life concerns for this release.

Non-Code Aspects

Basically, any relevant informations (new blog bost, getting started guides...) is listed in the useful links wiki page

Communities

Talks have been given on the following events:

Other medium

Committer Changes

None

Schedule

Intent 0.8 Release Plan

  • RC1 Wenesday, May 22
  • RC2 Wenesday, May 28
  • RC3 Wenesday, June 05
  • RC4 Wenesday, June 12
  • Final Wenesday, June 12

Project Plan

Intent 0.8 project plan is available at http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs.intent

Back to the top