You are viewing a plain text version of this content. The canonical link for it is here.
Posted to kerby@directory.apache.org by "Zheng, Kai" <ka...@intel.com> on 2016/01/17 23:33:27 UTC
About release note
Hi,
>From users' point of view, for a release, they may want to know what's exactly released. I reviewed the release process and artifacts for the first one RC1, it looks like we're not clear about this. So come to the upcoming RC2 release, how to distinguish it from the before? I guess we'll need to document well, having something like release note or history. We'll need to sort out what features to include in the list that we claim they're ready and available for use or experimental. Just some thoughts, and welcome feedback. Thanks.
Regards,
Kai
RE: About release note
Posted by "Zheng, Kai" <ka...@intel.com>.
Thanks Stefan for the thoughts and Jiajia for the consideration. JIRA will give us the complete list resolved during the span as good inputs for manually writing of the RN. This way makes more sense to Kerby and major releases because it's a new project and we'd better focus on the features we've come up. For minor releases and mature projects like Studio, a bug fix list sounds great.
Regards,
Kai
-----Original Message-----
From: Li, Jiajia [mailto:jiajia.li@intel.com]
Sent: Monday, January 18, 2016 3:53 PM
To: kerby@directory.apache.org
Subject: RE: About release note
So I will pick out the features and important changes in the generated RN.
And some commits without creating the JIRA, I will check the git commit logs for RN.
Ps: The title of issue should be more meaningful when created in the feature development.
Thanks
Jiajia
-----Original Message-----
From: Li, Jiajia [mailto:jiajia.li@intel.com]
Sent: Monday, January 18, 2016 3:34 PM
To: kerby@directory.apache.org
Subject: RE: About release note
Thanks for Stefan's advises, I also think the JIRA generated RN is not very well. And the method to generate RN help me a lot.
Thanks
Jiajia
-----Original Message-----
From: Stefan Seelmann [mailto:mail@stefan-seelmann.de]
Sent: Monday, January 18, 2016 2:56 PM
To: kerby@directory.apache.org
Subject: Re: About release note
On 01/17/2016 11:33 PM, Zheng, Kai wrote:
> Hi,
>
> From users' point of view, for a release, they may want to know what's exactly released. I reviewed the release process and artifacts for the first one RC1, it looks like we're not clear about this. So come to the upcoming RC2 release, how to distinguish it from the before? I guess we'll need to document well, having something like release note or history. We'll need to sort out what features to include in the list that we claim they're ready and available for use or experimental. Just some thoughts, and welcome feedback. Thanks.
In other Directory projects we use Jira to generate RN. If you go to "Change Log" [1] or "Road Map" [2] you see the versions, the included issues, and there is also a link "Release Notes". This requires that the "Fix versions" field is properly maintained. We then take those RN and put it into the announce mail and on the website [3][4].
However I'm not always happy with what Jira generates. Often the issue title is not really descriptive. And issues like "Fix findbugs problem"
is not interesting from a user POV. But at least you can use it as base for a hand-written release notes.
Kind Regards,
Stefan
[1]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:changelog-panel
[2]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel
[3] https://directory.apache.org/api/news.html
[4] https://directory.apache.org/studio/news.html
RE: About release note
Posted by "Li, Jiajia" <ji...@intel.com>.
So I will pick out the features and important changes in the generated RN.
And some commits without creating the JIRA, I will check the git commit logs for RN.
Ps: The title of issue should be more meaningful when created in the feature development.
Thanks
Jiajia
-----Original Message-----
From: Li, Jiajia [mailto:jiajia.li@intel.com]
Sent: Monday, January 18, 2016 3:34 PM
To: kerby@directory.apache.org
Subject: RE: About release note
Thanks for Stefan's advises, I also think the JIRA generated RN is not very well. And the method to generate RN help me a lot.
Thanks
Jiajia
-----Original Message-----
From: Stefan Seelmann [mailto:mail@stefan-seelmann.de]
Sent: Monday, January 18, 2016 2:56 PM
To: kerby@directory.apache.org
Subject: Re: About release note
On 01/17/2016 11:33 PM, Zheng, Kai wrote:
> Hi,
>
> From users' point of view, for a release, they may want to know what's exactly released. I reviewed the release process and artifacts for the first one RC1, it looks like we're not clear about this. So come to the upcoming RC2 release, how to distinguish it from the before? I guess we'll need to document well, having something like release note or history. We'll need to sort out what features to include in the list that we claim they're ready and available for use or experimental. Just some thoughts, and welcome feedback. Thanks.
In other Directory projects we use Jira to generate RN. If you go to "Change Log" [1] or "Road Map" [2] you see the versions, the included issues, and there is also a link "Release Notes". This requires that the "Fix versions" field is properly maintained. We then take those RN and put it into the announce mail and on the website [3][4].
However I'm not always happy with what Jira generates. Often the issue title is not really descriptive. And issues like "Fix findbugs problem"
is not interesting from a user POV. But at least you can use it as base for a hand-written release notes.
Kind Regards,
Stefan
[1]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:changelog-panel
[2]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel
[3] https://directory.apache.org/api/news.html
[4] https://directory.apache.org/studio/news.html
RE: About release note
Posted by "Li, Jiajia" <ji...@intel.com>.
Thanks for Stefan's advises, I also think the JIRA generated RN is not very well. And the method to generate RN help me a lot.
Thanks
Jiajia
-----Original Message-----
From: Stefan Seelmann [mailto:mail@stefan-seelmann.de]
Sent: Monday, January 18, 2016 2:56 PM
To: kerby@directory.apache.org
Subject: Re: About release note
On 01/17/2016 11:33 PM, Zheng, Kai wrote:
> Hi,
>
> From users' point of view, for a release, they may want to know what's exactly released. I reviewed the release process and artifacts for the first one RC1, it looks like we're not clear about this. So come to the upcoming RC2 release, how to distinguish it from the before? I guess we'll need to document well, having something like release note or history. We'll need to sort out what features to include in the list that we claim they're ready and available for use or experimental. Just some thoughts, and welcome feedback. Thanks.
In other Directory projects we use Jira to generate RN. If you go to "Change Log" [1] or "Road Map" [2] you see the versions, the included issues, and there is also a link "Release Notes". This requires that the "Fix versions" field is properly maintained. We then take those RN and put it into the announce mail and on the website [3][4].
However I'm not always happy with what Jira generates. Often the issue title is not really descriptive. And issues like "Fix findbugs problem"
is not interesting from a user POV. But at least you can use it as base for a hand-written release notes.
Kind Regards,
Stefan
[1]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:changelog-panel
[2]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel
[3] https://directory.apache.org/api/news.html
[4] https://directory.apache.org/studio/news.html
Re: About release note
Posted by Stefan Seelmann <ma...@stefan-seelmann.de>.
On 01/17/2016 11:33 PM, Zheng, Kai wrote:
> Hi,
>
> From users' point of view, for a release, they may want to know what's exactly released. I reviewed the release process and artifacts for the first one RC1, it looks like we're not clear about this. So come to the upcoming RC2 release, how to distinguish it from the before? I guess we'll need to document well, having something like release note or history. We'll need to sort out what features to include in the list that we claim they're ready and available for use or experimental. Just some thoughts, and welcome feedback. Thanks.
In other Directory projects we use Jira to generate RN. If you go to
"Change Log" [1] or "Road Map" [2] you see the versions, the included
issues, and there is also a link "Release Notes". This requires that the
"Fix versions" field is properly maintained. We then take those RN and
put it into the announce mail and on the website [3][4].
However I'm not always happy with what Jira generates. Often the issue
title is not really descriptive. And issues like "Fix findbugs problem"
is not interesting from a user POV. But at least you can use it as base
for a hand-written release notes.
Kind Regards,
Stefan
[1]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:changelog-panel
[2]
https://issues.apache.org/jira/browse/DIRKRB?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel
[3] https://directory.apache.org/api/news.html
[4] https://directory.apache.org/studio/news.html
RE: About release note
Posted by "Zheng, Kai" <ka...@intel.com>.
Thanks Jiajia for the take!
Regards,
Kai
-----Original Message-----
From: Li, Jiajia [mailto:jiajia.li@intel.com]
Sent: Monday, January 18, 2016 11:34 AM
To: kerby@directory.apache.org
Subject: RE: About release note
Hi Kai,
I think the release note can help users to know kerby's features easily, I can take the work to sort out it.
Thanks
Jiajia
-----Original Message-----
From: Zheng, Kai [mailto:kai.zheng@intel.com]
Sent: Monday, January 18, 2016 6:33 AM
To: kerby@directory.apache.org
Subject: About release note
Hi,
>From users' point of view, for a release, they may want to know what's exactly released. I reviewed the release process and artifacts for the first one RC1, it looks like we're not clear about this. So come to the upcoming RC2 release, how to distinguish it from the before? I guess we'll need to document well, having something like release note or history. We'll need to sort out what features to include in the list that we claim they're ready and available for use or experimental. Just some thoughts, and welcome feedback. Thanks.
Regards,
Kai
RE: About release note
Posted by "Li, Jiajia" <ji...@intel.com>.
Hi Kai,
I think the release note can help users to know kerby's features easily, I can take the work to sort out it.
Thanks
Jiajia
-----Original Message-----
From: Zheng, Kai [mailto:kai.zheng@intel.com]
Sent: Monday, January 18, 2016 6:33 AM
To: kerby@directory.apache.org
Subject: About release note
Hi,
>From users' point of view, for a release, they may want to know what's exactly released. I reviewed the release process and artifacts for the first one RC1, it looks like we're not clear about this. So come to the upcoming RC2 release, how to distinguish it from the before? I guess we'll need to document well, having something like release note or history. We'll need to sort out what features to include in the list that we claim they're ready and available for use or experimental. Just some thoughts, and welcome feedback. Thanks.
Regards,
Kai