Agree with Denis. I think that we should treat it as a starting point for the release notes, and further update it before releases.
On Wed, Aug 2, 2017 at 10:58 PM, Denis Magda <dma...@gridgain.com> wrote: > Guys, > > We're on the same page that the page has to look more colorful and > informative. This is exactly why Spark's page was given as an example. > > However, I like the template generated by Alex script in a sense that you > already have something to start work with. Go ahead and remove redundant > tickets once the template is ready, apply CSS and other nice formatting, > etc. So I would still accept the contribution. > > Denis > > On Wednesday, August 2, 2017, Vladimir Ozerov <voze...@gridgain.com> > wrote: > > > Alex, > > > > This is not only about the issue types. Release notes is the face of our > > product. Generating it from JIRA has several problems which are > > unresolvable IMO: > > 1) Tickets are created by many dozens people, so there could be typos, > > linguistic errors, etc. > > 2) Ticket descriptions often inconclusive and gives no useful information > > to users > > > > The only way to have sensible Release notes is to create them manually. > > Instead of forcing many people to follow some rules just to make this > > report looks sexy, we'd better to have one responsbile enginner, who will > > spend an hour once in 1-2 months to make release notes correct and > > meaningful. We can have a template with <div>, <h1>, <ul>, <li> tags for > > nice markup. > > > > > > On Wed, Aug 2, 2017 at 10:55 PM, Aleksey Chetaev <alex.chet...@gmail.com > > <javascript:;>> > > wrote: > > > > > Vladimir, > > > > > > I agree that page not perfect now. I think, problem in Jira issue > types. > > A > > > lot of new features or improvements created as task and often we don't > > use > > > sub-task for depended issues. I can be wrong, but committer who > prepared > > > release can't manually create this page, we need have some tools. > > > > > > 2017-08-02 21:35 GMT+03:00 Vladimir Ozerov [via Apache Ignite > > Developers] < > > > ml+s2346864n20398...@n4.nabble.com <javascript:;>>: > > > > > > > JIRA = report from JIRA > > > > > > > > ср, 2 авг. 2017 г. в 21:35, Vladimir Ozerov <[hidden email] > > > > <http:///user/SendEmail.jtp?type=node&node=20398&i=0>>: > > > > > > > > > Denis, > > > > > > > > > > This page works exactly how I suggested in the beginning of that > > > thread: > > > > > manually crafted notes on most important features + link to JIRA > > report > > > > to > > > > > see all closed tickets. > > > > > > > > > > We already have manually crafted any properly grouped release > notes. > > > All > > > > > we need is to make them a bit more verbose, add some CSS and > publish > > on > > > > the > > > > > site. No need to publish JIRA, this is useless noise. > > > > > > > > > > ср, 2 авг. 2017 г. в 21:20, Denis Magda <[hidden email] > > > > <http:///user/SendEmail.jtp?type=node&node=20398&i=1>>: > > > > > > > > > >> Vladimir, > > > > >> > > > > >> The goal is to have a page like that: > > > > >> https://spark.apache.org/releases/spark-release-2-1-0.html < > > > > >> https://spark.apache.org/releases/spark-release-2-1-0.html> > > > > >> > > > > >> where a user can go and see all the changes incorporated in the > > > > release. > > > > >> The header of the file can be custom - you can list major > > achievements > > > > with > > > > >> extra explanation. Going forward we can improve the page layout, > > > design > > > > and > > > > >> content but we definitely need a page like that so that the users > > can > > > > see > > > > >> the changes without a release download and lookup of > > RELEASE_NOTES.txt > > > > >> (which is not that descriptive as well). > > > > >> > > > > >> — > > > > >> Denis > > > > >> > > > > >> > On Aug 2, 2017, at 8:36 AM, Vladimir Ozerov <[hidden email] > > > > <http:///user/SendEmail.jtp?type=node&node=20398&i=2>> > > > > >> wrote: > > > > >> > > > > > >> > Alex, > > > > >> > > > > > >> > In AI 2.1 we fixed several hundreds issues. Why do you think > there > > > is > > > > a > > > > >> > single person interested in reviewing all of them? E.g. we added > > new > > > > >> JDBC > > > > >> > driver. I do not see it in the list of major features, neither I > > > need > > > > to > > > > >> > know that this task was split into 20 smaller sub tasks, each of > > > > which > > > > >> are > > > > >> > listed in the report. > > > > >> > > > > > >> > The question stands still - who needs this kind of detalization? > > > > >> > > > > > >> > ср, 2 авг. 2017 г. в 17:48, Aleksey Chetaev <[hidden email] > > > > <http:///user/SendEmail.jtp?type=node&node=20398&i=3>>: > > > > >> > > > > > >> >> Vladimir, > > > > >> >> > > > > >> >> We have links to release notes on download page: > > > > >> >> https://ignite.apache.org/ > > > > >> >> download.cgi. For be user-friendly we added header with > > description > > > > >> about > > > > >> >> most interested features in release and near list of issues. If > > we > > > > want > > > > >> >> skip minor or another issues we can use Jira labels and skip > > issues > > > > >> with > > > > >> >> label like "skip_rn" using filters, but I don't think it's good > > > way. > > > > >> Users > > > > >> >> shouldn't like use Jira and another developers tools, they want > > see > > > > >> all new > > > > >> >> (include all fixed) in release and this page easy way to do it. > > > > >> >> > > > > >> >> 2017-08-02 17:09 GMT+03:00 Vladimir Ozerov [via Apache Ignite > > > > >> Developers] < > > > > >> >> [hidden email] <http:///user/SendEmail.jtp? > > > type=node&node=20398&i=4>>: > > > > > > > > >> >> > > > > >> >>> Alex. > > > > >> >>> > > > > >> >>> How are we supposed to use this report? Release notes should > be > > > > >> designed > > > > >> >>> in > > > > >> >>> such a way, that the most important features are highly > visible, > > > > while > > > > >> >>> minor changes are either skipped at all, or shown aside, as > they > > > > have > > > > >> >>> little to no value for users. If someone is interested in all > > > fixed > > > > >> >>> tickets, we can give a link to JIRA report. Moreover, some > fixes > > > > must > > > > >> be > > > > >> >>> even hidden from users, e.g. security-related stuff. > > > > >> >>> > > > > >> >>> That said, I am not quite sure I understand the purpose of > this > > > > >> >> reporting. > > > > >> >>> It is not user-friendly. > > > > >> >>> > > > > >> >>> Vladimir. > > > > >> >>> > > > > >> >>> On Wed, Aug 2, 2017 at 4:57 PM, Aleksey Chetaev <[hidden > email] > > > > >> >>> <http:///user/SendEmail.jtp?type=node&node=20380&i=0>> > > > > >> >>> wrote: > > > > >> >>> > > > > >> >>>> Igniters, > > > > >> >>>> > > > > >> >>>> Started 2.0 we generated manually Jira based release notes > with > > > > all > > > > >> new > > > > >> >>>> improvements and fixed bugs. > > > > >> >>>> f.e(https://ignite.apache.org/releases/2.1.0/release_notes. > > html > > > ). > > > > I > > > > >> >>>> created > > > > >> >>>> new class in ignite-tools for we can do it automatically > using > > > IDE > > > > or > > > > >> >>>> TeamCity. Class using JSON template for create release notes. > > In > > > > >> >>> template > > > > >> >>>> we > > > > >> >>>> can setup Jira servers with credentials and filters for each > > > > release > > > > >> >>> notes > > > > >> >>>> section. > > > > >> >>>> Please see pull request: https://github.com/apache/ > > > > ignite/pull/2379 > > > > >> >> may > > > > >> >>> be > > > > >> >>>> we can merge this to Ignite for improve our release process? > > > > >> >>>> > > > > >> >>>> Kind regards > > > > >> >>>> Aleksey Chetaev. > > > > >> >>>> > > > > >> >>>> > > > > >> >>>> > > > > >> >>>> -- > > > > >> >>>> View this message in context: http://apache-ignite- > > > > >> >>>> developers.2346864.n4.nabble.com/Release-notes-tools-for- > > > > >> >>>> Ignite-releases-tp20377.html > > > > >> >>>> Sent from the Apache Ignite Developers mailing list archive > at > > > > >> >>> Nabble.com. > > > > >> >>>> > > > > >> >>> > > > > >> >>> > > > > >> >>> ------------------------------ > > > > >> >>> If you reply to this email, your message will be added to the > > > > >> discussion > > > > >> >>> below: > > > > >> >>> http://apache-ignite-developers.2346864.n4.nabble.com/Releas > > > > >> >>> e-notes-tools-for-Ignite-releases-tp20377p20380.html > > > > >> >>> To unsubscribe from Release notes tools for Ignite releases, > > click > > > > >> here > > > > >> >>> < > > > > >> >> > > > > >> >>> > > > > >> >>> . > > > > >> >>> NAML > > > > >> >>> < > > > > >> >> > > > > >> http://apache-ignite-developers.2346864.n4.nabble. > > > > com/template/NamlServlet.jtp?macro=macro_viewer&id=instant_ > > > > html%21nabble%3Aemail.naml&base=nabble.naml.namespaces. > > > > BasicNamespace-nabble.view.web.template.NabbleNamespace- > > > > nabble.view.web.template.NodeNamespace&breadcrumbs= > > > > notify_subscribers%21nabble%3Aemail.naml-instant_emails% > > > > 21nabble%3Aemail.naml-send_instant_email%21nabble%3Aemail.naml > > > > >> >>> > > > > >> >>> > > > > >> >> > > > > >> >> > > > > >> >> > > > > >> >> > > > > >> >> -- > > > > >> >> View this message in context: > > > > >> >> > > > > >> http://apache-ignite-developers.2346864.n4.nabble. > > > > com/Release-notes-tools-for-Ignite-releases-tp20377p20384.html > > > > >> >> Sent from the Apache Ignite Developers mailing list archive at > > > > >> Nabble.com. > > > > >> > > > > >> > > > > > > > > > > > > ------------------------------ > > > > If you reply to this email, your message will be added to the > > discussion > > > > below: > > > > http://apache-ignite-developers.2346864.n4.nabble. > > > > com/Release-notes-tools-for-Ignite-releases-tp20377p20398.html > > > > To unsubscribe from Release notes tools for Ignite releases, click > here > > > > <http://apache-ignite-developers.2346864.n4.nabble. > > > com/template/NamlServlet.jtp?macro=unsubscribe_by_code& > node=20377&code= > > > YWxleC5jaGV0YWV2QGdtYWlsLmNvbXwyMDM3N3wtMTkzNjgwOTg1OQ==> > > > > . > > > > NAML > > > > <http://apache-ignite-developers.2346864.n4.nabble. > > > com/template/NamlServlet.jtp?macro=macro_viewer&id=instant_ > > > html%21nabble%3Aemail.naml&base=nabble.naml.namespaces. > > > BasicNamespace-nabble.view.web.template.NabbleNamespace- > > > nabble.view.web.template.NodeNamespace&breadcrumbs= > > > notify_subscribers%21nabble%3Aemail.naml-instant_emails% > > > 21nabble%3Aemail.naml-send_instant_email%21nabble%3Aemail.naml> > > > > > > > > > > > > > > > > > > > -- > > > View this message in context: http://apache-ignite- > > > developers.2346864.n4.nabble.com/Release-notes-tools-for- > > > Ignite-releases-tp20377p20400.html > > > Sent from the Apache Ignite Developers mailing list archive at > > Nabble.com. > > > > > >
