[prev in list] [next in list] [prev in thread] [next in thread] 

List:       openjdk-openjfx-dev
Subject:    Re: Release notes presentation
From:       Nir Lisker <nlisker () gmail ! com>
Date:       2020-08-29 16:22:21
Message-ID: CA+0ynh8EBaWVS8mV1R5mwD496qnind8ayQ+7e84oywAc-T+E_A () mail ! gmail ! com
[Download RAW message or body]

Any of those options seem fine to me. Just have the "marketable" summary
link to the full table if they are not on the same page.

On Sat, Aug 29, 2020 at 6:24 PM Kevin Rushforth <kevin.rushforth@oracle.com>
wrote:

> I also like having both. We did something like this for JavaFX 11:
> 
> https://github.com/openjdk/jfx/blob/master/doc-files/release-notes-11.md
> 
> with sections for "Important Changes", "New Features", "Known Issues",
> etc., and the list of fixes and enhancements at the end.
> 
> We haven't done this for subsequent releases, but it seems worth doing,
> either on openjfx.io or in the release notes in the repo.
> 
> -- Kevin
> 
> On 8/29/2020 8:02 AM, Johan Vos wrote:
> > Hi Nir,
> > 
> > I am very ok with that. I think we somehow need both. Currently, the
> > release notes that are also in the repository are a dry summary of the
> bug
> > fixes/features that have been added in this release. They are a 1-1
> > translation of the issues in JBS that are fixed in the given release. I
> > think that is good to have, as it allows for an easy lookup of what
> feature
> > was in which release.
> > 
> > Apart from that, I'm often asked what the "key features" are for a
> specific
> > release. That is of course very subjective, but from a marketing point,
> or
> > even for developers, it makes sense to have those release notes as well.
> I
> > don't think those should go in the github repo, but they can definitely
> go
> > on openjfx.io.
> > 
> > Those "friendly" release notes will always be subjective, but I don't see
> > big problems with that. In case of doubt, the "official" (dry) release
> > notes are objective.
> > 
> > - Johan
> > 
> > On Sat, Aug 29, 2020 at 4:32 PM Nir Lisker <nlisker@gmail.com> wrote:
> > 
> > > Reviving this, the JDK has a page for release notes [1] that makes it
> > > easier for the developer to be updated on the changes. I think that we
> can
> > > do something similar.
> > > 
> > > [1]
> https://www.oracle.com/java/technologies/javase/14-relnote-issues.html
> > > 
> > > On Mon, Mar 9, 2020 at 2:56 PM Jeanette Winzenburg <
> > > fastegal@swingempire.de>
> > > wrote:
> > > 
> > > > agree with better highlighting of the important changes/issues
> > > > disagree with leaving out the not so important - that's in the eye of
> > > > the reader, anyway - changes/issues: after all, the target readership
> > > > are technicians, not suits :)
> > > > 
> > > > -- Jeanette
> > > > 
> > > > Zitat von Nir Lisker <nlisker@gmail.com>:
> > > > 
> > > > > Hi,
> > > > > 
> > > > > I posted the release notes for OpenJFX 14 on Reddit. The top comment
> > > [1]
> > > > > complained about the presentation. Maybe on openjfx.io the Release
> > > Notes
> > > > > link could show a more "friendly" summary with a link to the detailed
> > > > > table. I suggest:
> > > > > 
> > > > > 1. Including only changes that matter to the users of the library with
> > > > > separate sections for new API and for (non-internal) bug fixes.
> > > > > 2. Highlighting significant changes.
> > > > > 
> > > > > Some example bug fixes to include:
> > > > > - TableView, ListView: unexpected scrolling behaviour on up/down keys
> > > > > - DragAndDrop no longer works with GTK3
> > > > > - Window order is not correct when Modality.WINDOW_MODAL
> > > > > 
> > > > > Don't include:
> > > > > - [WebView] Sub-resource integrity check fails on Windows and Linux
> > > > > - javafx.web build fails on XCode 10.2
> > > > > - Cherry pick GTK WebKit ___ changes
> > > > > 
> > > > > Enhancements to include:
> > > > > - Add support for e-paper displays
> > > > > - Add exclusion scope for LightBase
> > > > > - Point2D and Point3D should implement Interpolatable
> > > > > 
> > > > > Don't include:
> > > > > -  Color, Point2D and Point3D's fields should be made final
> > > > > 
> > > > > Thoughts?
> > > > > 
> > > > > - Nir
> > > > > 
> > > > > [1]
> > > > > 
> > > 
> https://www.reddit.com/r/java/comments/fegcv9/release_notes_for_javafx_14/fjphqfn?utm_source=share&utm_medium=web2x
> 
> > > > 
> > > > 
> > > > 
> 
> 


[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic