Bug 533730 - N&N for Photon (4.8)
Summary: N&N for Photon (4.8)
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.8   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 4.8 RC3   Edit
Assignee: Niraj Modi CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2018-04-18 03:06 EDT by Lakshmi P Shanmugam CLA
Modified: 2018-06-05 08:13 EDT (History)
11 users (show)

See Also:


Attachments
Open this content in a new window. (15.23 KB, image/png)
2018-05-25 12:24 EDT, Niraj Modi CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Lakshmi P Shanmugam CLA 2018-04-18 03:06:03 EDT
This bug tracks the combined N&N and the N&Ns in the corresponding doc bundles for Photon
Comment 5 Lakshmi P Shanmugam CLA 2018-04-24 12:13:26 EDT
I've copied over all the content from 4.8 M1-M6 N&N and Java 10 support content from 4.8M7 N&N to 4.8 N&N and what's New document in the platform.common repo.

Todo:
1) In the news repo, copy over content from 4.8/M7/index.html to appropriate sections in the respective (jdt, platform, platform_isv, pde) html pages in 4.8 folder.

2) After M7, in the news repo overwrite 4.8/index.html with 4.8/index_4.8_final.html and rename 4.8/index_4.8_final.php to 4.8/index.php.

3) In the platform.common repo, copy over M7 content from:
- 4.8/jdt.html to org.eclipse.jdt.doc.user/whatsNew/jdt_whatsnew.html
- 4.8/platform.html to org.eclipse.platform.doc.user/whatsNew/platform_whatsnew.html
- 4.8/platform_isv.html to /org.eclipse.platform.doc.isv/whatsNew/platform_isv_whatsnew.html
- 4.8/pde.html to org.eclipse.pde.doc.user/whatsNew/pde_whatsnew.html
Java 10 support content is already copied.

4) Copy the images to corresponding images folder.

5) Validate all modified html files with https://validator.w3.org/#validate_by_input.
Comment 6 Niraj Modi CLA 2018-05-15 14:36:19 EDT
(In reply to Lakshmi Shanmugam from comment #5)
> I've copied over all the content from 4.8 M1-M6 N&N and Java 10 support
> content from 4.8M7 N&N to 4.8 N&N and what's New document in the
> platform.common repo.
> 
> Todo:
> 1) In the news repo, copy over content from 4.8/M7/index.html to appropriate
> sections in the respective (jdt, platform, platform_isv, pde) html pages in
> 4.8 folder.
> 
> 2) After M7, in the news repo overwrite 4.8/index.html with
> 4.8/index_4.8_final.html and rename 4.8/index_4.8_final.php to 4.8/index.php.

Completed above via below git commit:
http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/?id=6056c4eea8450a81b4c02ebc0989f4b71986b052

Note: Additionally copied updated image files(formatter-profile-overview.png and formatter-profile-wrap-settings.png) from 4.8M5 into 4.8 section and cleaned up the interim files(index_4.8_final.html/php)
Comment 7 Niraj Modi CLA 2018-05-15 15:56:01 EDT
(In reply to Lakshmi Shanmugam from comment #5)
> 3) In the platform.common repo, copy over M7 content from:
> - 4.8/jdt.html to org.eclipse.jdt.doc.user/whatsNew/jdt_whatsnew.html
Done via below git commits:
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=16c23eb7a5bd4c8c55849a8e8b40917ee991c585
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=4bf1d8fe1dc0a62b4dfd7dc32a12b0d74ea9c894

> - 4.8/platform.html to
> org.eclipse.platform.doc.user/whatsNew/platform_whatsnew.html
Done via below git commit:
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=884af6dc5a1ce8243c26650c794b8101f7e6cd62

> - 4.8/platform_isv.html to
> /org.eclipse.platform.doc.isv/whatsNew/platform_isv_whatsnew.html
Done via below git commit:
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=c4342da3936eb9cf5d69dbb6f460938133750f09

> - 4.8/pde.html to org.eclipse.pde.doc.user/whatsNew/pde_whatsnew.html
> Java 10 support content is already copied.
Already had all the required updates.
Additionally copied fix for bug 531830 from org.eclipse.pde.doc.user/whatsNew/pde_whatsnew.html to platform news/4.8/pde.html as well, via below git commit:
http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/?id=dfcd021596164465208fa9c5324830b27890b1a8

> 4) Copy the images to corresponding images folder.
> 
> 5) Validate all modified html files with
> https://validator.w3.org/#validate_by_input.
Coping the images and HTML validation done with respective commits mentioned above.
Comment 8 Niraj Modi CLA 2018-05-15 15:59:32 EDT
I am done with 4.8 N&N consolidation from my side, please verify.
Comment 9 Noopur Gupta CLA 2018-05-17 04:08:43 EDT
I am looking at the JDT items organization (not planning to go through the contents as that should already be done with milestones N&N). I think the following things can be improved:

- 2 images in Java 9 section are too wide. Kalyan, please follow the instructions given in /platform news/instructions.html file in the news repo.

- Some images in Java 10 section don't look sharp.

- Following items should be moved to the Java 9 section:

From Java Editor section: 
* Paste module-info.java code in Package Explorer
* Content assist for module declaration name
* Quick Fix for unresolved module on module name in requires directive
* Quick fix for Non-existing or empty package on exports directive

From Java Views and Dialogs section:
* Creation of module-info.java file on creation of a new Java9 Project
* Overriding modular build path dependencies for launching
Comment 10 Eclipse Genie CLA 2018-05-17 06:17:52 EDT
New Gerrit change created: https://git.eclipse.org/r/122855
Comment 12 Kalyan Prasad Tatavarthi CLA 2018-05-17 06:44:42 EDT
(In reply to Noopur Gupta from comment #9)
> I am looking at the JDT items organization (not planning to go through the
> contents as that should already be done with milestones N&N). I think the
> following things can be improved:
> 
> - 2 images in Java 9 section are too wide. Kalyan, please follow the
> instructions given in /platform news/instructions.html file in the news repo.

I have updated the width of the two images.

Also added N&N entry for the preference "Compiler Compliance does not match used JRE"
Comment 13 Niraj Modi CLA 2018-05-17 08:30:21 EDT
(In reply to Noopur Gupta from comment #9)
> - Some images in Java 10 section don't look sharp.
> 
> - Following items should be moved to the Java 9 section:
> 
> From Java Editor section: 
> * Paste module-info.java code in Package Explorer
> * Content assist for module declaration name
> * Quick Fix for unresolved module on module name in requires directive
> * Quick fix for Non-existing or empty package on exports directive
> 
> From Java Views and Dialogs section:
> * Creation of module-info.java file on creation of a new Java9 Project
> * Overriding modular build path dependencies for launching

Updated sharper images in Java10 section and moved above mentioned items to Java 9 section via below git commits:
http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/?id=94bba44717aaa6f9ca860a0ca1b5da400737800f
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=129898dc272f072b7885684f75cfb0597a5de5c3

Additionally above commit:
- Copies the new N&N entry made for bug 533880 from 4.8\M7\index.html to 4.8\jdt.html as well.
- Fixes HTML validation error in jdt_whatsnew.html
Comment 14 Eclipse Genie CLA 2018-05-21 10:16:25 EDT
New Gerrit change created: https://git.eclipse.org/r/123026
Comment 16 Noopur Gupta CLA 2018-05-21 10:19:15 EDT
(In reply to Eclipse Genie from comment #15)
> Gerrit change https://git.eclipse.org/r/123026 was merged to [master].
> Commit:
> http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=ef97242883bcba3d66dde6d3013ab6403aae17b0

Fixed the following things that I encountered in the JDT doc:
- Removed the entry with a note that it has been replaced with
another functionality. 
- Reorganized JUnit 5 section entries.
Comment 17 Eclipse Genie CLA 2018-05-22 05:51:42 EDT
New Gerrit change created: https://git.eclipse.org/r/123052
Comment 19 Noopur Gupta CLA 2018-05-22 05:53:36 EDT
(In reply to Eclipse Genie from comment #18)
> Gerrit change https://git.eclipse.org/r/123052 was merged to [master].
> Commit:
> http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=70782511168b74a32928e37ba65d78d09ec29f7e

Updated JDT doc with:
- updated copyright year
- replaced JUnit 5 with 5.1
- removed reference to M2 and MP entry
Comment 20 Niraj Modi CLA 2018-05-23 13:28:41 EDT
Added Quip/Author section to Photon N&N page:
http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/?id=562b4aeb1eed8bfcf262ba4b3031f1efef458a8e
Comment 21 Eclipse Genie CLA 2018-05-24 07:30:45 EDT
New Gerrit change created: https://git.eclipse.org/r/123250
Comment 23 Stephan Herrmann CLA 2018-05-24 07:35:39 EDT
(In reply to Eclipse Genie from comment #22)
> Gerrit change https://git.eclipse.org/r/123250 was merged to [master].
> Commit:
> http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/
> ?id=31267039b6eacd73c5c525420b01429fd6b2d9ba

Minor update regarding @NonNullByDefault per module.
Comment 24 Noopur Gupta CLA 2018-05-25 05:55:59 EDT
https://www.eclipse.org/eclipse/news/4.8/ is still not updated.
Changes should also go to /platform news/4.8/jdt.html.

Niraj, can you please have a look?
Comment 25 Niraj Modi CLA 2018-05-25 06:58:05 EDT
(In reply to Stephan Herrmann from comment #23)
> (In reply to Eclipse Genie from comment #22)
> > Gerrit change https://git.eclipse.org/r/123250 was merged to [master].
> > Commit:
> > http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/
> > ?id=31267039b6eacd73c5c525420b01429fd6b2d9ba
> 
> Minor update regarding @NonNullByDefault per module.

Copied above changes from 4.8/jdt.html to org.eclipse.jdt.doc.user/whatsNew/jdt_whatsnew.html and additionally fixed few formatting differences as compared with jdt.html, via below git commit:
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=0c9dc598af73c8b36b91fd92479607343dd8bf05
Comment 26 Niraj Modi CLA 2018-05-25 07:35:04 EDT
(In reply to Noopur Gupta from comment #24)
> https://www.eclipse.org/eclipse/news/4.8/ is still not updated.
> Changes should also go to /platform news/4.8/jdt.html.
> 
> Niraj, can you please have a look?
https://www.eclipse.org/eclipse/news/4.8/ was in sync till last week.

Merged the recent N&N changes done only in *_whatnew.html files, to corresponding *.html files(news repo) via below git commit:
http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/?id=c8e7dadc3d4f8f7b41c7c3376b27d581d472ef53

Additionally updated Copyright year in *_whatnew.html files via below git commit:
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=50dffd2ae6ee216e3852e8d699bb88de7e8bf966
Comment 28 Dani Megert CLA 2018-05-25 10:39:07 EDT
(In reply to Sravan Kumar Lakkimsetti from comment #27)
> Here are the problems I noticed in Platform N&N
> 
> https://www.eclipse.org/eclipse/news/4.8/platform.php#winxp-dropped the
> announcement link is not working from eclipse->help->Help
> Contents->Workbench User Guide->Whats new
> 
> Image is not clear for the following
> https://www.eclipse.org/eclipse/news/4.8/platform.php#parallel-builds-preference
> 
> https://www.eclipse.org/eclipse/news/4.8/platform.php#report-missing-nature-as-marker
> 
> https://www.eclipse.org/eclipse/news/4.8/platform.php#keys-export-commandid-csv
> 
> https://www.eclipse.org/eclipse/news/4.8/platform.php#preference-import-export-buttons
> 
> https://www.eclipse.org/eclipse/news/4.8/platform.php#macos-waiting-cursor


Who's fixing this?
Comment 29 Niraj Modi CLA 2018-05-25 12:24:23 EDT
Created attachment 274202 [details]
Open this content in a new window.

(In reply to Sravan Kumar Lakkimsetti from comment #27)
> Here are the problems I noticed in Platform N&N
> 
> https://www.eclipse.org/eclipse/news/4.8/platform.php#winxp-dropped the
> announcement link is not working from eclipse->help->Help
> Contents->Workbench User Guide->Whats new

The announcement link is correct: https://dev.eclipse.org/mhonarc/lists/cross-project-issues-dev/msg15385.html

But looks like it's contents cannot be displayed in the "Eclipse Help", but I can open this link in new Window from the displayed error message. Please see attachment.

Not sure if there's some way to get the contents of external site to be shown in the "Eclipse Help"... otherwise we can remove the mention of this external link from this N&N.
Comment 30 Eclipse Genie CLA 2018-05-29 07:08:12 EDT
New Gerrit change created: https://git.eclipse.org/r/123515
Comment 32 Lakshmi P Shanmugam CLA 2018-05-29 07:12:56 EDT
(In reply to Niraj Modi from comment #29)
> Created attachment 274202 [details]
> Open this content in a new window.
> 
> (In reply to Sravan Kumar Lakkimsetti from comment #27)
> > Here are the problems I noticed in Platform N&N
> > 
> > https://www.eclipse.org/eclipse/news/4.8/platform.php#winxp-dropped the
> > announcement link is not working from eclipse->help->Help
> > Contents->Workbench User Guide->Whats new
> 
> The announcement link is correct:
> https://dev.eclipse.org/mhonarc/lists/cross-project-issues-dev/msg15385.html
> 
> But looks like it's contents cannot be displayed in the "Eclipse Help", but
> I can open this link in new Window from the displayed error message. Please
> see attachment.
> 
> Not sure if there's some way to get the contents of external site to be
> shown in the "Eclipse Help"... otherwise we can remove the mention of this
> external link from this N&N.

target="_blank" should be added to links that cannot open in external frame. Fixed this and 2 other links with above gerrit change.
Comment 33 Lakshmi P Shanmugam CLA 2018-05-29 07:32:36 EDT
Fixed broken link in jdt webpage - http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/?id=13d47625758a5438706d1aa4a88b3147c7a0786c
Comment 34 Eclipse Genie CLA 2018-05-30 01:41:23 EDT
New Gerrit change created: https://git.eclipse.org/r/123588
Comment 38 Lakshmi P Shanmugam CLA 2018-05-31 07:13:37 EDT
Marking as fixed.
Comment 39 Niraj Modi CLA 2018-06-05 07:20:49 EDT
Synced-up the 4.8 N&N web-site with *_whatsnew.html(R4_8_maintenance branch) via below git commit:
http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/?id=300180bb7bfd245293837986a513f50ce43c1143
Comment 40 Niraj Modi CLA 2018-06-05 07:32:13 EDT
Hi All,
Please note any further changes done to 4.8 N&N, also needs to be copied over to the 4.8 N&N web-site. Thanks!