Bug 435445 - Create initial Luna (4.4) What's New documents
Summary: Create initial Luna (4.4) What's New documents
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.4   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 4.4 RC4   Edit
Assignee: Martin Mathew CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2014-05-21 16:10 EDT by Dani Megert CLA
Modified: 2014-06-04 15:12 EDT (History)
12 users (show)

See Also:


Attachments
section re null type annotations (2.75 KB, patch)
2014-06-03 09:52 EDT, Stephan Herrmann CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2014-05-21 16:10:55 EDT
Copy all M1-M7 New and Noteworthy items [1] into their corresponding component N&N:
/org.eclipse.platform.doc.user/whatsNew/platform_whatsnew.html
/org.eclipse.pde.doc.user/whatsNew/pde_whatsnew.html
/org.eclipse.jdt.doc.user/whatsNew/jdt_whatsnew.html


[1] eclipse.platform.news/platform/4.4
Comment 1 Martin Mathew CLA 2014-05-23 03:49:43 EDT
In JDT 4.4 M7 N&N we have just one news that refers to Java 8 feature implementation as a whole. Shouldn't this be elaborated and have each feature explained with images?

Equinox related changes and platform API changes will be moved to 
/org.eclipse.platform.doc.isv/whatsNew/platform_isv_whatsnew.html
Comment 2 Dani Megert CLA 2014-05-23 04:45:19 EDT
(In reply to Manju Mathew from comment #1)
> In JDT 4.4 M7 N&N we have just one news that refers to Java 8 feature
> implementation as a whole. Shouldn't this be elaborated and have each
> feature explained with images?

Yes, please.
Comment 3 Martin Mathew CLA 2014-05-27 02:51:46 EDT
In platform_isv_whatsnew.html > Equinox Changes, there are 3 news titled "Equinox OSGi framework update" from different milestone releases. Should these 3 news be retained as such or can it be combined to a single news or can they have different title?

Simlarly in platform_isv_whatsnew.html > Equinox Changes,there are 2 news titled "Equinox Regions update" with different content.

The news titled "SWT does not work on Linux with GTK+ 3 version > 3.8.x" is present in M5 and M6, hence added only the news from M6 in the final N&N document.

There could still be some news currently present in platform_whatsnew.html which can be better placed in platform_isv_whatsnew.html document. Requesting the component owner to have a look.

In jdt_whatsnew.html, should we add the below as news?
1. UI Option to generate method parameter attribute in class file
2. UI for fine grain search of method reference expressions

Java 8 news for compiler looks pretty empty. Is there something that can be added in this section like improvement in null analysis or APT improvements?

Releasing the consolidated document till this point. 
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=b0ffee826ec667cc4affaa09ecfd783157c43b2c
Comment 4 Noopur Gupta CLA 2014-05-27 03:09:51 EDT
(In reply to Manju Mathew from comment #3)

> In jdt_whatsnew.html, should we add the below as news?
> 1. UI Option to generate method parameter attribute in class file
> 2. UI for fine grain search of method reference expressions

Some more candidates related to Java 8 that can be added, if required:
- Quick Assists: 
    * Change body block to expression 
    * Change body expression to block
- New Formatter options for lambda:
    * Braces
    * Whitespace
- Adornments for abstract, default, static methods of interface
- Ctrl+Click on '->' or '::' to go to the functional method declaration (separated from "Hover to see the functional method")
- Type Hierarchy shows lambda expressions as implementations of the functional interface
- 'default' access modifier replaced with 'package' access modifier in UI
Comment 5 Martin Mathew CLA 2014-05-27 05:40:09 EDT
(In reply to Noopur Gupta from comment #4)
> - Ctrl+Click on '->' or '::' to go to the functional method declaration
This is not fully functional due to bug 429785 in JDT Core.
Comment 6 John Arthorne CLA 2014-05-27 08:31:08 EDT
(In reply to Manju Mathew from comment #3)
> In platform_isv_whatsnew.html > Equinox Changes, there are 3 news titled
> "Equinox OSGi framework update" from different milestone releases. Should
> these 3 news be retained as such or can it be combined to a single news or
> can they have different title?
> 
> Simlarly in platform_isv_whatsnew.html > Equinox Changes,there are 2 news
> titled "Equinox Regions update" with different content.

Tom, can you provide merged text for these?
Comment 7 Thomas Watson CLA 2014-05-27 13:21:56 EDT
(In reply to John Arthorne from comment #6)
> Tom, can you provide merged text for these?

Done in commit:

http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=561322d58c15aa4a2ce24cc2be6f4d2e6f4af73d
Comment 8 Martin Mathew CLA 2014-05-28 03:18:38 EDT
Jay and Stephan, can you both have a look at the 'Java Compiler' section of jdt_whatsnew.html and see if we have missed any news to be added. This section looks pretty empty. Is there something that can be added in this section like improvement in null analysis or APT improvements?
Comment 9 John Arthorne CLA 2014-05-28 10:54:19 EDT
Manju, I used to edit this doc, and I am happy to do a review and polish on the contents. Can you let me know when you have incorporated all the latest feedback, and then I will review it.
Comment 10 Martin Mathew CLA 2014-06-01 20:59:51 EDT
Updated JDT N&N with Java 8 news, Platform N&N with news provided by Arun, incorporated some of the review comments from PMC.

In Platform N&N, few of the images do not adhere to the width specification of 519 pixels. Adjusting the width to 519 resulted in blurred images in the final document, hence requesting the component owners to have a look and provide better images with width 519 pixels for:
images/darklinux.png
images/darktheme.png
images/OpenAsProject.png
images/split_editors.png
images/theme-association.png
images/css-bridge/new-definitions.png
images/css-bridge/overriding-definitions.png
images/css-bridge/using-definitions.png

Platform N&N "Improvements in the dark theme" => bug 433475 is reopened. Requesting the component owners to verify whether this news is still relevant and if possible combine the news "Dark theme" and "Improvements in the dark theme" to a single news.

Pending tasks:
1. Java Compiler news
2. Debug news

Released the updated document till this point with: http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=8446c75c10f88edbc721aa784d3d5a0d914cf48a
Comment 11 Lars Vogel CLA 2014-06-03 05:01:03 EDT
(In reply to Manju Mathew from comment #10)
> In Platform N&N, few of the images do not adhere to the width specification
> of 519 pixels. Adjusting the width to 519 resulted in blurred images in the
> final document, hence requesting the component owners to have a look and
> provide better images with width 519 pixels for:

An IDE screenshot with 519 is really tiny. I was unable to great an descent screenshot with this size. 

Platform N&N "Improvements in the dark theme" => bug 433475 is reopened. Requesting the component owners to verify whether this news is still relevant and if possible combine the news "Dark theme" and "Improvements in the dark theme" to a single news.

Yes, still relevant. I update the entries also adding a new screenshot for the IDE (larger than 519, I'm unable to create a screenshot in this size which does not look ridiculous).
Comment 12 Lars Vogel CLA 2014-06-03 05:09:59 EDT
(In reply to Lars Vogel from comment #11)
> (In reply to Manju Mathew from comment  
> An IDE screenshot with 519 is really tiny. I was unable to great an descent
> screenshot with this size. 

I decided to follow this rule, even though IMHO the result looks bad. Can you point me to the specification of this requirement? 519 feel to small, maybe we can adjust that in the future.
Comment 13 Lars Vogel CLA 2014-06-03 05:15:24 EDT
(In reply to Manju Mathew from comment #10)

> images/darklinux.png
> images/darktheme.png
> 
> Platform N&N "Improvements in the dark theme" => bug 433475 is reopened.
> Requesting the component owners to verify whether this news is still
> relevant and if possible combine the news "Dark theme" and "Improvements in
> the dark theme" to a single news.

Replaced the two images from above and combined entries with https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=c3c4bfc90b2bedfbf0c70e69996ed43d2a2a1322
Comment 14 Noopur Gupta CLA 2014-06-03 05:16:44 EDT
(In reply to Lars Vogel from comment #12) 
> I decided to follow this rule, even though IMHO the result looks bad. Can
> you point me to the specification of this requirement? 519 feel to small,
> maybe we can adjust that in the future.

eclipse.platform.news\platform\4.4\whats-new-template\eclipse-whats-new-template.html
Comment 15 Lars Vogel CLA 2014-06-03 05:31:18 EDT
(In reply to Noopur Gupta from comment #14)
> eclipse.platform.news\platform\4.4\whats-new-template\eclipse-whats-new-
> template.html

Thanks, I opened https://bugs.eclipse.org/bugs/show_bug.cgi?id=436430 for discussion.
Comment 16 Stephan Herrmann CLA 2014-06-03 08:12:00 EDT
For documenting the new support for null type annotations in JDT I would like to link to a section in the help document.

May I assume that ".." inside JDT's whatsNew/jdt_whatsnew.html will *always* point to the root of org.eclipse.jdt.doc.user? Or will copies served from download.eclipse.org lack this context?
Comment 17 Dani Megert CLA 2014-06-03 09:30:52 EDT
(In reply to Stephan Herrmann from comment #16)
> May I assume that ".." inside JDT's whatsNew/jdt_whatsnew.html will *always*
> point to the root of org.eclipse.jdt.doc.user? Or will copies served from
> download.eclipse.org lack this context?

Not, that will work. We e.g. also refer to the Platform What's new with
../../org.eclipse.platform.doc.user/whatsNew/platform_whatsnew.html
Comment 18 Stephan Herrmann CLA 2014-06-03 09:52:38 EDT
Created attachment 243882 [details]
section re null type annotations

Here's a take at advertising null type annotations.

I'm waiting for screenshots from Shankha, since screen shots taken on my linux box wouldn't be accepted ;-P


Next I was going to write a paragraph for some migration guide (migrate from SE5 null annotations to null *type* annotations), but it seems, we don't typically have a migration section in org.eclipse.jdt.doc.user.

-> Any hints where such guide should be prominently shown? 
   (cf. also bug 434307).


At this point it seems that I should also place a big red sticker "please don't use the quickfix to add the annotation bundle to build.properties". Will this be the last word for Luna (see bug 413583)?
Comment 19 John Arthorne CLA 2014-06-03 09:58:44 EDT
(In reply to Stephan Herrmann from comment #18)
> Next I was going to write a paragraph for some migration guide (migrate from
> SE5 null annotations to null *type* annotations), but it seems, we don't
> typically have a migration section in org.eclipse.jdt.doc.user.

JDT porting guide is here:

http://git.eclipse.org/c/platform/eclipse.platform.common.git/tree/bundles/org.eclipse.jdt.doc.isv/porting/4.4

But if this is a user-facing thing, then it could just be added as an extra paragraph on the N&N entry that introduces the new feature.
Comment 20 John Arthorne CLA 2014-06-03 10:09:07 EDT
(In reply to Lars Vogel from comment #12)
> I decided to follow this rule, even though IMHO the result looks bad. Can
> you point me to the specification of this requirement? 519 feel to small,
> maybe we can adjust that in the future.

I agree with you, this looks bad ;)

Can you provide one that looks good at whatever size you need? Call it "darktheme-full.png" and just commit it to the same images folder. We can crop it for the N&N that appears inside the download, but show the full size on the N&N that is linked on the download page. The download page copy is the one most people see and link to anyway, and we have more flexibility there on size.
Comment 21 Lars Vogel CLA 2014-06-03 15:03:10 EDT
(In reply to John Arthorne from comment #20)

> Can you provide one that looks good at whatever size you need? Call it
> "darktheme-full.png" and just commit it to the same images folder. We can
> crop it for the N&N that appears inside the download, but show the full size
> on the N&N that is linked on the download page. The download page copy is
> the one most people see and link to anyway, and we have more flexibility
> there on size.

Gerrit review for the "darktheme-full.png" https://git.eclipse.org/r/27865
I'm basically out now for vacation (prep) so I can't help with the cropping magic.
Comment 22 John Arthorne CLA 2014-06-03 15:32:04 EDT
(In reply to Lars Vogel from comment #21)
> Gerrit review for the "darktheme-full.png" https://git.eclipse.org/r/27865
> I'm basically out now for vacation (prep) so I can't help with the cropping
> magic.

Thanks Lars, I have merged and cropped it. We can use the uncropped version in the What's New linked from the download page.
Comment 23 Stephan Herrmann CLA 2014-06-03 16:24:28 EDT
I've added two paragraphs on null type annotations as supported by ECJ via http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=495089180b71bb33a5c13ee9fc3c7b7e2bffeadd

This includes essential hints for migrating projects using null annotations to be used in Eclipse Luna.
Comment 24 Martin Mathew CLA 2014-06-04 09:39:32 EDT
Final beautification and slight rearrangement is done and is released as : http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=5e8d1d881cc139fb8c94b48af8749c7c1f4b4c6f
Comment 26 Dani Megert CLA 2014-06-04 15:11:46 EDT
.
Comment 27 Dani Megert CLA 2014-06-04 15:12:00 EDT
.