Mylyn Docs 3.0 Release Review

Type: 
Release
State: 
Successful
End Date of the Review Period: 

Reviews run for a minimum of one week. The outcome of the review is decided on this date. This is the last day to make comments or ask questions about this review.

Wednesday, March 1, 2017
Project: 
Release: 

3.0

Description: 

This release restructures Mylyn WikiText for easier consumption as Maven artifcts, contains defect fixes and improvements to AsciiDoc parsing.

API Certification: 

The project leadership certifies that the APIs in this release are "Eclipse Quality".

Architectural Issues: 
  • Mylyn Docs makes API available for both extensibility and integration
  • API breaking changes have been introduced with the 3.0 release, however most of them are Java package renaming and OSGi bundle renaming only.
  • API tooling is used to verify that binary backwards compatibility is maintained and no API regressions are introduced.
  • APIs are consumed by 3rd parties who provide feedback
  • Developer guide includes information on upgrading to 3.0
Security Issues: 

None.

Non-Code Aspects: 
  • API has javadoc
  • User documentation is included
  • Developer guide is included
Usability Details: 

Maturity

  • Constant stream of stable releases
  • Bundled as part of EPP distributions
  • Committers work from HEAD, contributors from weekly builds, community from milestone releases

Accessibility

  • No review for this release, but following accessibility guidelines
  • http://www.eclipse.org/articles/Article-Accessibility/index.html

User Interface Guidelines

  • Focus on consistent visual design, UI elements, icons
  • http://wiki.eclipse.org/index.php/User_Interface_Guidelines

 

End of Life: 

None.

Standards: 
  • A Java SE 8 runtime or newer is required
Communities: 

Users

  • Lively community on bug reports
  • Articles and blogs by community members

Developers

  • Contributor documentation on Eclipsepedia
  • Lively community on mylyn-dev, mylyn-docs-dev and bug reports

Integrators

  • Integrator documentation on Eclipsepedia
  • Separate mylyn-integrators mailing list removes need for integrators to watch the higher-traffic mylyn-dev