You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ignite.apache.org by Dmitriy Pavlov <dp...@apache.org> on 2019/05/14 12:19:58 UTC
[Discussion] Documentation process improvement: Release notes
Hi Igniters,
During the preparation of release candidate 2.7.5, I’ve missed the
development of Release notes for it, and this caused delay for a vote.
I want to suggest simple changes in our documentation process. Some time
ago Artem B. proposed similar for the doc, but I would like to adapt it for
release notes.
Let us
- Enrich Ignite flags with 'Release Notes required' flag (default is, as
always, true)
- Add field 'Release Notes' to Ignite project.
All tickets with empty Release Notes fields but with flag set may be
checked with contributor if it needs to be mentioned in RELEASE_NOTES.txt.
If we agree on these changes, I’ll ask infra to add these fields in 3 days.
Sincerely,
Dmitriy Pavlov
Re: [Discussion] Documentation process improvement: Release notes
Posted by Dmitriy Pavlov <dp...@apache.org>.
Hi Igniters,
Fields are available in JIRA now, so for 2.7.6 I applied this new process
and moved all Release Notes from txt file back to JIRA field:
https://cwiki.apache.org/confluence/display/IGNITE/Apache+Ignite+2.7.6#ApacheIgnite2.7.6-ReleaseNotes
Now Release Manager can easily track which changes still need to be added
to the Release notes (all new tickets will have set flag).
I also suggest adding 'Release Notes Required' flag to all 2.8 assigned
changes.
Sincerely,
Dmitriy Pavlov
вт, 27 авг. 2019 г. в 14:51, Dmitriy Pavlov <dp...@apache.org>:
> Hi Igniters,
>
> Thanks to everyone, https://issues.apache.org/jira/browse/INFRA-18944 created.
> For relatively small releases like 2.7.5,2.7.6, it is ok to collect RN
> manually, but for a major release, I assume we need a separate field for it.
>
> I also found not completed issue, which could benefit from separate field
> creation:
> https://issues.apache.org/jira/browse/IGNITE-5355
>
> Sincerely,
> Dmitriy Pavlov
>
> пн, 20 мая 2019 г. в 18:30, Garrett Alley <ga...@gridgain.com>:
>
>> I like the flag, it would help cut down on the work involved in creating
>> the release notes. Eventually, we may want to group the fixes "by
>> component" in the release notes.
>>
>> -g-
>>
>> On Mon, May 20, 2019 at 4:28 AM Ilya Kasnacheev <
>> ilya.kasnacheev@gmail.com>
>> wrote:
>>
>> > Hello!
>> >
>> > I think it definitely makes sense to have Release Notes field in JIRA
>> > tickets (start using it if it is already present?). Not sure about the
>> > flag.
>> >
>> > Regards,
>> > --
>> > Ilya Kasnacheev
>> >
>> >
>> > пн, 20 мая 2019 г. в 13:23, Dmitriy Pavlov <dp...@apache.org>:
>> >
>> > > Hi Ignite Developers,
>> > >
>> > > Kindly Reminder, please review the proposed changes and share your
>> > vision.
>> > > I would appreciate if this change will be approved by community
>> members,
>> > > but not via silence.
>> > >
>> > > Sincerely
>> > > Dmitriy Pavlov
>> > >
>> > > вт, 14 мая 2019 г. в 15:19, Dmitriy Pavlov <dp...@apache.org>:
>> > >
>> > > > Hi Igniters,
>> > > >
>> > > > During the preparation of release candidate 2.7.5, I’ve missed the
>> > > > development of Release notes for it, and this caused delay for a
>> vote.
>> > > >
>> > > > I want to suggest simple changes in our documentation process. Some
>> > time
>> > > > ago Artem B. proposed similar for the doc, but I would like to
>> adapt it
>> > > for
>> > > > release notes.
>> > > >
>> > > > Let us
>> > > > - Enrich Ignite flags with 'Release Notes required' flag (default
>> is,
>> > as
>> > > > always, true)
>> > > > - Add field 'Release Notes' to Ignite project.
>> > > >
>> > > > All tickets with empty Release Notes fields but with flag set may be
>> > > > checked with contributor if it needs to be mentioned in
>> > > RELEASE_NOTES.txt.
>> > > >
>> > > > If we agree on these changes, I’ll ask infra to add these fields in
>> 3
>> > > > days.
>> > > >
>> > > > Sincerely,
>> > > > Dmitriy Pavlov
>> > > >
>> > > >
>> > >
>> >
>>
>
Re: [Discussion] Documentation process improvement: Release notes
Posted by Dmitriy Pavlov <dp...@apache.org>.
Hi Igniters,
Thanks to everyone, https://issues.apache.org/jira/browse/INFRA-18944 created.
For relatively small releases like 2.7.5,2.7.6, it is ok to collect RN
manually, but for a major release, I assume we need a separate field for it.
I also found not completed issue, which could benefit from separate field
creation:
https://issues.apache.org/jira/browse/IGNITE-5355
Sincerely,
Dmitriy Pavlov
пн, 20 мая 2019 г. в 18:30, Garrett Alley <ga...@gridgain.com>:
> I like the flag, it would help cut down on the work involved in creating
> the release notes. Eventually, we may want to group the fixes "by
> component" in the release notes.
>
> -g-
>
> On Mon, May 20, 2019 at 4:28 AM Ilya Kasnacheev <ilya.kasnacheev@gmail.com
> >
> wrote:
>
> > Hello!
> >
> > I think it definitely makes sense to have Release Notes field in JIRA
> > tickets (start using it if it is already present?). Not sure about the
> > flag.
> >
> > Regards,
> > --
> > Ilya Kasnacheev
> >
> >
> > пн, 20 мая 2019 г. в 13:23, Dmitriy Pavlov <dp...@apache.org>:
> >
> > > Hi Ignite Developers,
> > >
> > > Kindly Reminder, please review the proposed changes and share your
> > vision.
> > > I would appreciate if this change will be approved by community
> members,
> > > but not via silence.
> > >
> > > Sincerely
> > > Dmitriy Pavlov
> > >
> > > вт, 14 мая 2019 г. в 15:19, Dmitriy Pavlov <dp...@apache.org>:
> > >
> > > > Hi Igniters,
> > > >
> > > > During the preparation of release candidate 2.7.5, I’ve missed the
> > > > development of Release notes for it, and this caused delay for a
> vote.
> > > >
> > > > I want to suggest simple changes in our documentation process. Some
> > time
> > > > ago Artem B. proposed similar for the doc, but I would like to adapt
> it
> > > for
> > > > release notes.
> > > >
> > > > Let us
> > > > - Enrich Ignite flags with 'Release Notes required' flag (default is,
> > as
> > > > always, true)
> > > > - Add field 'Release Notes' to Ignite project.
> > > >
> > > > All tickets with empty Release Notes fields but with flag set may be
> > > > checked with contributor if it needs to be mentioned in
> > > RELEASE_NOTES.txt.
> > > >
> > > > If we agree on these changes, I’ll ask infra to add these fields in 3
> > > > days.
> > > >
> > > > Sincerely,
> > > > Dmitriy Pavlov
> > > >
> > > >
> > >
> >
>
Re: [Discussion] Documentation process improvement: Release notes
Posted by Garrett Alley <ga...@gridgain.com>.
I like the flag, it would help cut down on the work involved in creating
the release notes. Eventually, we may want to group the fixes "by
component" in the release notes.
-g-
On Mon, May 20, 2019 at 4:28 AM Ilya Kasnacheev <il...@gmail.com>
wrote:
> Hello!
>
> I think it definitely makes sense to have Release Notes field in JIRA
> tickets (start using it if it is already present?). Not sure about the
> flag.
>
> Regards,
> --
> Ilya Kasnacheev
>
>
> пн, 20 мая 2019 г. в 13:23, Dmitriy Pavlov <dp...@apache.org>:
>
> > Hi Ignite Developers,
> >
> > Kindly Reminder, please review the proposed changes and share your
> vision.
> > I would appreciate if this change will be approved by community members,
> > but not via silence.
> >
> > Sincerely
> > Dmitriy Pavlov
> >
> > вт, 14 мая 2019 г. в 15:19, Dmitriy Pavlov <dp...@apache.org>:
> >
> > > Hi Igniters,
> > >
> > > During the preparation of release candidate 2.7.5, I’ve missed the
> > > development of Release notes for it, and this caused delay for a vote.
> > >
> > > I want to suggest simple changes in our documentation process. Some
> time
> > > ago Artem B. proposed similar for the doc, but I would like to adapt it
> > for
> > > release notes.
> > >
> > > Let us
> > > - Enrich Ignite flags with 'Release Notes required' flag (default is,
> as
> > > always, true)
> > > - Add field 'Release Notes' to Ignite project.
> > >
> > > All tickets with empty Release Notes fields but with flag set may be
> > > checked with contributor if it needs to be mentioned in
> > RELEASE_NOTES.txt.
> > >
> > > If we agree on these changes, I’ll ask infra to add these fields in 3
> > > days.
> > >
> > > Sincerely,
> > > Dmitriy Pavlov
> > >
> > >
> >
>
Re: [Discussion] Documentation process improvement: Release notes
Posted by Ilya Kasnacheev <il...@gmail.com>.
Hello!
I think it definitely makes sense to have Release Notes field in JIRA
tickets (start using it if it is already present?). Not sure about the flag.
Regards,
--
Ilya Kasnacheev
пн, 20 мая 2019 г. в 13:23, Dmitriy Pavlov <dp...@apache.org>:
> Hi Ignite Developers,
>
> Kindly Reminder, please review the proposed changes and share your vision.
> I would appreciate if this change will be approved by community members,
> but not via silence.
>
> Sincerely
> Dmitriy Pavlov
>
> вт, 14 мая 2019 г. в 15:19, Dmitriy Pavlov <dp...@apache.org>:
>
> > Hi Igniters,
> >
> > During the preparation of release candidate 2.7.5, I’ve missed the
> > development of Release notes for it, and this caused delay for a vote.
> >
> > I want to suggest simple changes in our documentation process. Some time
> > ago Artem B. proposed similar for the doc, but I would like to adapt it
> for
> > release notes.
> >
> > Let us
> > - Enrich Ignite flags with 'Release Notes required' flag (default is, as
> > always, true)
> > - Add field 'Release Notes' to Ignite project.
> >
> > All tickets with empty Release Notes fields but with flag set may be
> > checked with contributor if it needs to be mentioned in
> RELEASE_NOTES.txt.
> >
> > If we agree on these changes, I’ll ask infra to add these fields in 3
> > days.
> >
> > Sincerely,
> > Dmitriy Pavlov
> >
> >
>
Re: [Discussion] Documentation process improvement: Release notes
Posted by Dmitriy Pavlov <dp...@apache.org>.
Hi Ignite Developers,
Kindly Reminder, please review the proposed changes and share your vision.
I would appreciate if this change will be approved by community members,
but not via silence.
Sincerely
Dmitriy Pavlov
вт, 14 мая 2019 г. в 15:19, Dmitriy Pavlov <dp...@apache.org>:
> Hi Igniters,
>
> During the preparation of release candidate 2.7.5, I’ve missed the
> development of Release notes for it, and this caused delay for a vote.
>
> I want to suggest simple changes in our documentation process. Some time
> ago Artem B. proposed similar for the doc, but I would like to adapt it for
> release notes.
>
> Let us
> - Enrich Ignite flags with 'Release Notes required' flag (default is, as
> always, true)
> - Add field 'Release Notes' to Ignite project.
>
> All tickets with empty Release Notes fields but with flag set may be
> checked with contributor if it needs to be mentioned in RELEASE_NOTES.txt.
>
> If we agree on these changes, I’ll ask infra to add these fields in 3
> days.
>
> Sincerely,
> Dmitriy Pavlov
>
>