17 Apr
2018
17 Apr
'18
10:28 a.m.
Hi,
I’d like to modify the Release Notes app to autogenerate summaries for releases.
The idea is to auto generate it based on the headings for user , admins and devs headers.
For ex, taking the 10.2 release notes it would give:
"For users: New default Color Theme, Figure Macro, Rename/Move protection and Minor
changes do not generate notifications anymore. For admins: Default Notifications. For
Developers: REST API now supports the use of minor revision for page changes, Translation
fallback and Jobs improvements."
It's not too bad IMO.
WDYT?
Thanks
-Vincent
17 Apr
17 Apr
10:31 a.m.
On 17 Apr 2018, at 10:28, Vincent Massol
<vincent(a)massol.net> wrote:
Hi,
I’d like to modify the Release Notes app to autogenerate summaries for releases.
The idea is to auto generate it based on the headings for user , admins and devs
headers.
For ex, taking the 10.2 release notes it would give:
"For users: New default Color Theme, Figure Macro, Rename/Move protection and Minor
changes do not generate notifications anymore. For admins: Default Notifications. For
Developers: REST API now supports the use of minor revision for page changes, Translation
fallback and Jobs improvements.”
To give a comparions this is how we manually summarised it:
"This release has a fresh look thanks to its new default color theme. A new Figure
macro is available for content creators to add illustrations along with optional captions.
Renaming and moving standard pages is now discouraged with a warning message that should
prevent editors from breaking XWiki.”
Ofc, the manual summary is nicer but I think the automated one could be enough for the
user to know the topics and then check the release notes to understand better what’s in
it.
Context: This is an effort to automate further our release process and to win some more
minutes.
Thanks
-Vincent
It's not too bad IMO.
WDYT?
Thanks
-Vincent
10:35 a.m.
+1 since we want to release often, it's better to have a lot of things
automated.
Additional proposition: automate the blog post and the twitter message that
announce the release.
2018-04-17 10:31 GMT+02:00 Vincent Massol <vincent(a)massol.net>et>:
--
Guillaume Delhumeau (guillaume.delhumeau(a)xwiki.com)
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project
On 17 Apr 2018, at 10:28, Vincent Massol
<vincent(a)massol.net> wrote:
Hi,
I’d like to modify the Release Notes app to autogenerate summaries for
releases.
The idea is to auto generate it based on the headings for user , admins
and devs
headers.
For ex, taking the 10.2 release notes it would give:
"For users: New default Color Theme, Figure Macro, Rename/Move
protection and
Minor changes do not generate notifications anymore. For
admins: Default Notifications. For Developers: REST API now supports the
use of minor revision for page changes, Translation fallback and Jobs
improvements.”
To give a comparions this is how we manually summarised it:
"This release has a fresh look thanks to its new default color theme. A
new Figure macro is available for content creators to add illustrations
along with optional captions. Renaming and moving standard pages is now
discouraged with a warning message that should prevent editors from
breaking XWiki.”
Ofc, the manual summary is nicer but I think the automated one could be
enough for the user to know the topics and then check the release notes to
understand better what’s in it.
Context: This is an effort to automate further our release process and to
win some more minutes.
Thanks
-Vincent
It's not too bad IMO.
WDYT?
Thanks
-Vincent
10:39 a.m.
On 17 Apr 2018, at 10:35, Guillaume Delhumeau
<guillaume.delhumeau(a)xwiki.com> wrote:
+1 since we want to release often, it's better to have a lot of things
automated.
Additional proposition: automate the blog post
We need the summary so if we automate the summary we can indeed automate the blog post.
and the twitter message that
announce the release.
This is already automated AFAIK.
Thanks
-Vincent
2018-04-17 10:31 GMT+02:00 Vincent Massol <vincent(a)massol.net>et>:
>
>
>> On 17 Apr 2018, at 10:28, Vincent Massol <vincent(a)massol.net> wrote:
>>
>> Hi,
>>
>> I’d like to modify the Release Notes app to autogenerate summaries for
> releases.
>>
>> The idea is to auto generate it based on the headings for user , admins
> and devs headers.
>>
>> For ex, taking the 10.2 release notes it would give:
>>
>> "For users: New default Color Theme, Figure Macro, Rename/Move
> protection and Minor changes do not generate notifications anymore. For
> admins: Default Notifications. For Developers: REST API now supports the
> use of minor revision for page changes, Translation fallback and Jobs
> improvements.”
>
> To give a comparions this is how we manually summarised it:
>
> "This release has a fresh look thanks to its new default color theme. A
> new Figure macro is available for content creators to add illustrations
> along with optional captions. Renaming and moving standard pages is now
> discouraged with a warning message that should prevent editors from
> breaking XWiki.”
>
> Ofc, the manual summary is nicer but I think the automated one could be
> enough for the user to know the topics and then check the release notes to
> understand better what’s in it.
>
> Context: This is an effort to automate further our release process and to
> win some more minutes.
>
> Thanks
> -Vincent
>
>>
>> It's not too bad IMO.
>>
>> WDYT?
>>
>> Thanks
>> -Vincent
18 Apr
18 Apr
11:12 a.m.
On Tue, Apr 17, 2018 at 10:39 AM, Vincent Massol <vincent(a)massol.net> wrote:
Yes what we do now by hand is pretty much just copy/pasting summary in
some template right now. We should ideally automate it even if we
don't automate the summary (i.e. we should extract the summary from
the RN).
Yes the twitt is sent by a script.
On 17 Apr 2018, at 10:35, Guillaume Delhumeau
<guillaume.delhumeau(a)xwiki.com> wrote:
+1 since we want to release often, it's better to have a lot of things
automated.
Additional proposition: automate the blog post
We need the summary so if we automate the summary we can indeed automate the blog post.
and the twitter message that
announce the release.
This is already automated AFAIK.
Thanks
-Vincent
--
Thomas Mortagne
2018-04-17 10:31 GMT+02:00 Vincent Massol <vincent(a)massol.net>et>:
>
>
>> On 17 Apr 2018, at 10:28, Vincent Massol <vincent(a)massol.net> wrote:
>>
>> Hi,
>>
>> I’d like to modify the Release Notes app to autogenerate summaries for
> releases.
>>
>> The idea is to auto generate it based on the headings for user , admins
> and devs headers.
>>
>> For ex, taking the 10.2 release notes it would give:
>>
>> "For users: New default Color Theme, Figure Macro, Rename/Move
> protection and Minor changes do not generate notifications anymore. For
> admins: Default Notifications. For Developers: REST API now supports the
> use of minor revision for page changes, Translation fallback and Jobs
> improvements.”
>
> To give a comparions this is how we manually summarised it:
>
> "This release has a fresh look thanks to its new default color theme. A
> new Figure macro is available for content creators to add illustrations
> along with optional captions. Renaming and moving standard pages is now
> discouraged with a warning message that should prevent editors from
> breaking XWiki.”
>
> Ofc, the manual summary is nicer but I think the automated one could be
> enough for the user to know the topics and then check the release notes to
> understand better what’s in it.
>
> Context: This is an effort to automate further our release process and to
> win some more minutes.
>
> Thanks
> -Vincent
>
>>
>> It's not too bad IMO.
>>
>> WDYT?
>>
>> Thanks
>> -Vincent
11:44 a.m.
2018-04-18 11:12 GMT+02:00 Thomas Mortagne <thomas.mortagne(a)xwiki.com>om>:
--
Thomas Mortagne
--
Guillaume Delhumeau (guillaume.delhumeau(a)xwiki.com)
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project
On Tue, Apr 17, 2018 at 10:39 AM, Vincent Massol
<vincent(a)massol.net>
wrote:
the blog
post.
Yes what we do now by hand is pretty much just copy/pasting summary in
some template right now. We should ideally automate it even if we
don't automate the summary (i.e. we should extract the summary from
the RN).
Yes the twitt is sent by a script.
Yes but you still need to write its content :) (except is someone has
changed it since the last release I performed).
> On 17 Apr 2018, at 10:35, Guillaume Delhumeau <
guillaume.delhumeau(a)xwiki.com> wrote:
+1 since we want to release often, it's better to have a lot of things
automated.
Additional proposition: automate the blog post
We need the summary so if we automate the summary we can indeed automate and the twitter message that
announce the release.
This is already automated AFAIK.
Thanks
-Vincent
>
> 2018-04-17 10:31 GMT+02:00 Vincent Massol <vincent(a)massol.net>et>:
>
>>
>>
>>> On 17 Apr 2018, at 10:28, Vincent Massol <vincent(a)massol.net> wrote:
>>>
>>> Hi,
>>>
>>> I’d like to modify the Release Notes app to autogenerate summaries for
>> releases.
>>>
>>> The idea is to auto generate it based on the headings for user ,
admins
>> and devs headers.
>>>
>>> For ex, taking the 10.2 release notes it would give:
>>>
>>> "For users: New default Color Theme, Figure Macro, Rename/Move
>> protection and Minor changes do not generate notifications anymore. For
>> admins: Default Notifications. For Developers: REST API now supports
the
>> use of minor revision for page changes,
Translation fallback and Jobs
>> improvements.”
>>
>> To give a comparions this is how we manually summarised it:
>>
>> "This release has a fresh look thanks to its new default color theme. A
>> new Figure macro is available for content creators to add illustrations
>> along with optional captions. Renaming and moving standard pages is now
>> discouraged with a warning message that should prevent editors from
>> breaking XWiki.”
>>
>> Ofc, the manual summary is nicer but I think the automated one could be
>> enough for the user to know the topics and then check the release
notes
to
>> understand better what’s in it.
>>
>> Context: This is an effort to automate further our release process and
to
> win
some more minutes.
>
> Thanks
> -Vincent
>
>>
>> It's not too bad IMO.
>>
>> WDYT?
>>
>> Thanks
>> -Vincent
11:48 a.m.
On Wed, Apr 18, 2018 at 11:44 AM, Guillaume Delhumeau
<guillaume.delhumeau(a)xwiki.com> wrote:
--
Thomas Mortagne
--
Guillaume Delhumeau (guillaume.delhumeau(a)xwiki.com)
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project
--
Thomas Mortagne
2018-04-18 11:12 GMT+02:00 Thomas Mortagne
<thomas.mortagne(a)xwiki.com>om>:
Yes but the content does not have anything to do with the summary. But
sure we could put the right release note in the twitt automatically.
On Tue, Apr 17, 2018 at 10:39 AM, Vincent Massol
<vincent(a)massol.net>
wrote:
the blog
post.
Yes what we do now by hand is pretty much just copy/pasting summary in
some template right now. We should ideally automate it even if we
don't automate the summary (i.e. we should extract the summary from
the RN).
Yes the twitt is sent by a script.
Yes but you still need to write its content :) (except is someone has
changed it since the last release I performed).
> On 17 Apr 2018, at 10:35, Guillaume Delhumeau <
guillaume.delhumeau(a)xwiki.com> wrote:
+1 since we want to release often, it's better to have a lot of things
automated.
Additional proposition: automate the blog post
We need the summary so if we automate the summary we can indeed automate and the twitter message that
announce the release.
This is already automated AFAIK.
Thanks
-Vincent
>
> 2018-04-17 10:31 GMT+02:00 Vincent Massol <vincent(a)massol.net>et>:
>
>>
>>
>>> On 17 Apr 2018, at 10:28, Vincent Massol <vincent(a)massol.net> wrote:
>>>
>>> Hi,
>>>
>>> I’d like to modify the Release Notes app to autogenerate summaries for
>> releases.
>>>
>>> The idea is to auto generate it based on the headings for user ,
admins
>> and devs headers.
>>>
>>> For ex, taking the 10.2 release notes it would give:
>>>
>>> "For users: New default Color Theme, Figure Macro, Rename/Move
>> protection and Minor changes do not generate notifications anymore. For
>> admins: Default Notifications. For Developers: REST API now supports
the
>> use of minor revision for page changes,
Translation fallback and Jobs
>> improvements.”
>>
>> To give a comparions this is how we manually summarised it:
>>
>> "This release has a fresh look thanks to its new default color theme. A
>> new Figure macro is available for content creators to add illustrations
>> along with optional captions. Renaming and moving standard pages is now
>> discouraged with a warning message that should prevent editors from
>> breaking XWiki.”
>>
>> Ofc, the manual summary is nicer but I think the automated one could be
>> enough for the user to know the topics and then check the release
notes
to
>> understand better what’s in it.
>>
>> Context: This is an effort to automate further our release process and
to
> win
some more minutes.
>
> Thanks
> -Vincent
>
>>
>> It's not too bad IMO.
>>
>> WDYT?
>>
>> Thanks
>> -Vincent
2343
days inactive
2344
days old
6 comments
3 participants
participants (3)
-
Guillaume Delhumeau -
Thomas Mortagne -
Vincent Massol