You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@systemml.apache.org by Deron Eriksson <de...@gmail.com> on 2016/05/25 00:16:52 UTC
Location for release validation checklist?
Hi,
The release candidate validation checklist needs to be easy to modify by
SystemML committers/contributors. As a result, it should probably take a
'Wiki' form. This raises the question of where it should go? Seems like the
options are:
1) md file in the project itself (not a wiki, not easy to modify)
2) GitHub project wiki
3) Apache Confluence
I started off by creating an release validation checklist md file in the
project at docs/. The formatting of this looks good but this is too
difficult to modify. Here's a temporary example:
http://deroneriksson.github.io/incubator-systemml/release-process.html#release-candidate-checklist
So, next I took the above content and uploaded it as a personal Gist page.
The formatting doesn't look that great, and this is how it would probably
look on the SystemML GitHub wiki if it's publicly open (I don't have access
to the GitHub project settings to do this):
https://gist.github.com/deroneriksson/3c75abd5bfc629a3d4c15da420f86e3f
It occurred to me that most Apache projects have Confluence Wikis (for
example, see https://cwiki.apache.org/confluence/display/SPARK/Wiki+Homepage).
Perhaps Apache Confluence would be the best location? However, I don't
believe we have a Confluence Wiki yet.
Luciano, would we post a JIRA to infra to get a Confluence Wiki for the
project?
I think I would favor #3, but I don't want it to prolong the release
process. Anyone have any opinions or advice? We could even handle this on
the mailing list for now.
Thanks,
Deron
Re: Location for release validation checklist?
Posted by Deron Eriksson <de...@gmail.com>.
Hi Luciano,
A very basic checklist has been created at
https://issues.apache.org/jira/browse/SYSTEMML-708
Thanks,
Deron
On Wed, May 25, 2016 at 11:54 AM, Luciano Resende <lu...@gmail.com>
wrote:
> Great, so, once you push your document, I will update with the build
> release portion.
>
> On Wed, May 25, 2016 at 11:03 AM, Deron Eriksson <de...@gmail.com>
> wrote:
>
> > Hi,
> >
> > Checklist on a jira sounds good to me. Sorry if I misunderstood the
> > previous comment.
> >
> > Deron
> >
> >
> > On Wed, May 25, 2016 at 10:07 AM, Luciano Resende <lu...@gmail.com>
> > wrote:
> >
> > > On Wed, May 25, 2016 at 9:06 AM, <du...@gmail.com> wrote:
> > >
> > > > Another possibility would be to create a new JIRA issue for each
> > release
> > > > (candidate) and track what had been tested there. If we do that, then
> > we
> > > > could include just the generic instructions in a markdown file in our
> > > repo.
> > > >
> > > >
> > > Yes, this was my suggestion, put the checklist on a jira for each
> > release.
> > >
> > >
> > > --
> > > Luciano Resende
> > > http://twitter.com/lresende1975
> > > http://lresende.blogspot.com/
> > >
> >
>
>
>
> --
> Luciano Resende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>
Re: Location for release validation checklist?
Posted by Luciano Resende <lu...@gmail.com>.
Great, so, once you push your document, I will update with the build
release portion.
On Wed, May 25, 2016 at 11:03 AM, Deron Eriksson <de...@gmail.com>
wrote:
> Hi,
>
> Checklist on a jira sounds good to me. Sorry if I misunderstood the
> previous comment.
>
> Deron
>
>
> On Wed, May 25, 2016 at 10:07 AM, Luciano Resende <lu...@gmail.com>
> wrote:
>
> > On Wed, May 25, 2016 at 9:06 AM, <du...@gmail.com> wrote:
> >
> > > Another possibility would be to create a new JIRA issue for each
> release
> > > (candidate) and track what had been tested there. If we do that, then
> we
> > > could include just the generic instructions in a markdown file in our
> > repo.
> > >
> > >
> > Yes, this was my suggestion, put the checklist on a jira for each
> release.
> >
> >
> > --
> > Luciano Resende
> > http://twitter.com/lresende1975
> > http://lresende.blogspot.com/
> >
>
--
Luciano Resende
http://twitter.com/lresende1975
http://lresende.blogspot.com/
Re: Location for release validation checklist?
Posted by Deron Eriksson <de...@gmail.com>.
Hi,
Checklist on a jira sounds good to me. Sorry if I misunderstood the
previous comment.
Deron
On Wed, May 25, 2016 at 10:07 AM, Luciano Resende <lu...@gmail.com>
wrote:
> On Wed, May 25, 2016 at 9:06 AM, <du...@gmail.com> wrote:
>
> > Another possibility would be to create a new JIRA issue for each release
> > (candidate) and track what had been tested there. If we do that, then we
> > could include just the generic instructions in a markdown file in our
> repo.
> >
> >
> Yes, this was my suggestion, put the checklist on a jira for each release.
>
>
> --
> Luciano Resende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>
Re: Location for release validation checklist?
Posted by Luciano Resende <lu...@gmail.com>.
On Wed, May 25, 2016 at 9:06 AM, <du...@gmail.com> wrote:
> Another possibility would be to create a new JIRA issue for each release
> (candidate) and track what had been tested there. If we do that, then we
> could include just the generic instructions in a markdown file in our repo.
>
>
Yes, this was my suggestion, put the checklist on a jira for each release.
--
Luciano Resende
http://twitter.com/lresende1975
http://lresende.blogspot.com/
Re: Location for release validation checklist?
Posted by du...@gmail.com.
Another possibility would be to create a new JIRA issue for each release (candidate) and track what had been tested there. If we do that, then we could include just the generic instructions in a markdown file in our repo.
--
Mike Dusenberry
GitHub: github.com/dusenberrymw
LinkedIn: linkedin.com/in/mikedusenberry
Sent from my iPhone.
> On May 24, 2016, at 9:14 PM, Deron Eriksson <de...@gmail.com> wrote:
>
> Hi,
>
> Personally, I would like if we can go to a single page and see the current
> validation status as a checklist (that can be updated by any contributors).
> In the examples I sent, in a couple seconds I can see that 1) no one has
> run the test suite on the src package, 2) performance suite hasn't been run
> on hadoop, 3) no one has reported testing the release in a notebook, etc.
> If the status of the various things that need to be validated is only
> handled on the mail list, then we lose the quick visual status. I think I
> would prefer it on a GitHub project wiki or Apache Confluence wiki to that
> it is easy to edit.
>
> I'm concerned that if we start doing PR's, we are potentially introducing
> too much process into something that can be simple. I want to go to a
> single place and see what has been checked and what is still remaining to
> be checked, and I want it to be as quick and easy as possible for people to
> update it.
>
> Deron
>
>
>
>
> On Tue, May 24, 2016 at 8:20 PM, Luciano Resende <lu...@gmail.com>
> wrote:
>
>> On Tue, May 24, 2016 at 5:16 PM, Deron Eriksson <de...@gmail.com>
>> wrote:
>>
>>> Hi,
>>>
>>> The release candidate validation checklist needs to be easy to modify by
>>> SystemML committers/contributors. As a result, it should probably take a
>>> 'Wiki' form. This raises the question of where it should go? Seems like
>> the
>>> options are:
>>>
>>> 1) md file in the project itself (not a wiki, not easy to modify)
>>> 2) GitHub project wiki
>>> 3) Apache Confluence
>>>
>>> I started off by creating an release validation checklist md file in the
>>> project at docs/. The formatting of this looks good but this is too
>>> difficult to modify. Here's a temporary example:
>> http://deroneriksson.github.io/incubator-systemml/release-process.html#release-candidate-checklist
>>>
>>> So, next I took the above content and uploaded it as a personal Gist
>> page.
>>> The formatting doesn't look that great, and this is how it would probably
>>> look on the SystemML GitHub wiki if it's publicly open (I don't have
>> access
>>> to the GitHub project settings to do this):
>>> https://gist.github.com/deroneriksson/3c75abd5bfc629a3d4c15da420f86e3f
>>>
>>> It occurred to me that most Apache projects have Confluence Wikis (for
>>> example, see
>>> https://cwiki.apache.org/confluence/display/SPARK/Wiki+Homepage).
>>> Perhaps Apache Confluence would be the best location? However, I don't
>>> believe we have a Confluence Wiki yet.
>>>
>>> Luciano, would we post a JIRA to infra to get a Confluence Wiki for the
>>> project?
>>>
>>> I think I would favor #3, but I don't want it to prolong the release
>>> process. Anyone have any opinions or advice? We could even handle this on
>>> the mailing list for now.
>>>
>>> Thanks,
>>> Deron
>>
>> I think that currently with github, it's pretty easy for anyone to
>> contributed to md based documentation via pr, so I don't see a big need for
>> using a wiki.
>>
>> As for tracking execution of the checklist, it should not be on the page,
>> but either via a jira or as a feedback on the voting thread, and each
>> failure should be reported as a jira.
>>
>> Anyway, just my 0.2c.
>>
>> --
>> Luciano Resende
>> http://twitter.com/lresende1975
>> http://lresende.blogspot.com/
>>
Re: Location for release validation checklist?
Posted by Deron Eriksson <de...@gmail.com>.
Hi,
Personally, I would like if we can go to a single page and see the current
validation status as a checklist (that can be updated by any contributors).
In the examples I sent, in a couple seconds I can see that 1) no one has
run the test suite on the src package, 2) performance suite hasn't been run
on hadoop, 3) no one has reported testing the release in a notebook, etc.
If the status of the various things that need to be validated is only
handled on the mail list, then we lose the quick visual status. I think I
would prefer it on a GitHub project wiki or Apache Confluence wiki to that
it is easy to edit.
I'm concerned that if we start doing PR's, we are potentially introducing
too much process into something that can be simple. I want to go to a
single place and see what has been checked and what is still remaining to
be checked, and I want it to be as quick and easy as possible for people to
update it.
Deron
On Tue, May 24, 2016 at 8:20 PM, Luciano Resende <lu...@gmail.com>
wrote:
> On Tue, May 24, 2016 at 5:16 PM, Deron Eriksson <de...@gmail.com>
> wrote:
>
> > Hi,
> >
> > The release candidate validation checklist needs to be easy to modify by
> > SystemML committers/contributors. As a result, it should probably take a
> > 'Wiki' form. This raises the question of where it should go? Seems like
> the
> > options are:
> >
> > 1) md file in the project itself (not a wiki, not easy to modify)
> > 2) GitHub project wiki
> > 3) Apache Confluence
> >
> > I started off by creating an release validation checklist md file in the
> > project at docs/. The formatting of this looks good but this is too
> > difficult to modify. Here's a temporary example:
> >
> >
> http://deroneriksson.github.io/incubator-systemml/release-process.html#release-candidate-checklist
> >
> > So, next I took the above content and uploaded it as a personal Gist
> page.
> > The formatting doesn't look that great, and this is how it would probably
> > look on the SystemML GitHub wiki if it's publicly open (I don't have
> access
> > to the GitHub project settings to do this):
> > https://gist.github.com/deroneriksson/3c75abd5bfc629a3d4c15da420f86e3f
> >
> > It occurred to me that most Apache projects have Confluence Wikis (for
> > example, see
> > https://cwiki.apache.org/confluence/display/SPARK/Wiki+Homepage).
> > Perhaps Apache Confluence would be the best location? However, I don't
> > believe we have a Confluence Wiki yet.
> >
> > Luciano, would we post a JIRA to infra to get a Confluence Wiki for the
> > project?
> >
> > I think I would favor #3, but I don't want it to prolong the release
> > process. Anyone have any opinions or advice? We could even handle this on
> > the mailing list for now.
> >
> > Thanks,
> > Deron
> >
>
> I think that currently with github, it's pretty easy for anyone to
> contributed to md based documentation via pr, so I don't see a big need for
> using a wiki.
>
> As for tracking execution of the checklist, it should not be on the page,
> but either via a jira or as a feedback on the voting thread, and each
> failure should be reported as a jira.
>
> Anyway, just my 0.2c.
>
> --
> Luciano Resende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>
Re: Location for release validation checklist?
Posted by Luciano Resende <lu...@gmail.com>.
On Tue, May 24, 2016 at 5:16 PM, Deron Eriksson <de...@gmail.com>
wrote:
> Hi,
>
> The release candidate validation checklist needs to be easy to modify by
> SystemML committers/contributors. As a result, it should probably take a
> 'Wiki' form. This raises the question of where it should go? Seems like the
> options are:
>
> 1) md file in the project itself (not a wiki, not easy to modify)
> 2) GitHub project wiki
> 3) Apache Confluence
>
> I started off by creating an release validation checklist md file in the
> project at docs/. The formatting of this looks good but this is too
> difficult to modify. Here's a temporary example:
>
> http://deroneriksson.github.io/incubator-systemml/release-process.html#release-candidate-checklist
>
> So, next I took the above content and uploaded it as a personal Gist page.
> The formatting doesn't look that great, and this is how it would probably
> look on the SystemML GitHub wiki if it's publicly open (I don't have access
> to the GitHub project settings to do this):
> https://gist.github.com/deroneriksson/3c75abd5bfc629a3d4c15da420f86e3f
>
> It occurred to me that most Apache projects have Confluence Wikis (for
> example, see
> https://cwiki.apache.org/confluence/display/SPARK/Wiki+Homepage).
> Perhaps Apache Confluence would be the best location? However, I don't
> believe we have a Confluence Wiki yet.
>
> Luciano, would we post a JIRA to infra to get a Confluence Wiki for the
> project?
>
> I think I would favor #3, but I don't want it to prolong the release
> process. Anyone have any opinions or advice? We could even handle this on
> the mailing list for now.
>
> Thanks,
> Deron
>
I think that currently with github, it's pretty easy for anyone to
contributed to md based documentation via pr, so I don't see a big need for
using a wiki.
As for tracking execution of the checklist, it should not be on the page,
but either via a jira or as a feedback on the voting thread, and each
failure should be reported as a jira.
Anyway, just my 0.2c.
--
Luciano Resende
http://twitter.com/lresende1975
http://lresende.blogspot.com/