You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@karaf.apache.org by Christian Schneider <ch...@die-schneider.net> on 2012/02/07 11:30:02 UTC
Document archtiectural decisions in Wiki
Hi all,
I discussed with Andreas on IRC that it is would be good to document
architectural decisions in the wiki. The idea is to extract the most
important informations from discussions on e.g. the mailing list. The
list should allow us to point new developers to decisions that were made
so they can inform themselves about these before dicussing the
decisions. The list should also allow to revisit decisions from time to
time so we have the chance to change a decision if for example the
reasons for it change.
See
https://cwiki.apache.org/confluence/display/KARAF/Architectural+decisions
I currently added a first decision for console as it came up on the irc
channel. Please document further decisions as you see fit and also help
making existing ones more concise.
We should of course not document every little decision. I think a good
indicator that a decision should be documented is when it is discussed
often and or heated :-)
Christian
--
Christian Schneider
http://www.liquid-reality.de
Open Source Architect
Talend Application Integration Division http://www.talend.com
Re: Document archtiectural decisions in Wiki
Posted by Christian Schneider <ch...@die-schneider.net>.
Makes sense to me. In the end we have to support the decision anyway. So
I replaced that with "Who was involved"
Christian
Am 07.02.2012 13:07, schrieb Jamie G.:
> +1. I agree with Andreas, the supporter/against section can go - if
> something comes to a vote that'll be on an email thread, just
> including a list of whom was involved is sufficient. The rest looks
> good :)
>
> Cheers,
> Jamie
>
> On Tue, Feb 7, 2012 at 8:50 AM, Andreas Pieber<an...@gmail.com> wrote:
>> As already stated on IRC I'm very much +1 for documenting those decisions.
>> Will make various things much easier to adapt/correct afterwards. Though one
>> thing I've found in you're template I do not really like is the
>> "supporter/aginst" section. I think this does not really help anybody than
>> to "pranger" someone if a decision does not work out as planed. I think we
>> should rather add an involved section to make it easier finding out who was
>> involved in a decision.
>>
>> Otherwise rellly cool. Thxs for starting this.
>>
>> Kind regards,
>> Andreas
>>
>>
>> On Tue 07 Feb 2012 11:30:02 AM CET, Christian Schneider wrote:
>>> Hi all,
>>>
>>> I discussed with Andreas on IRC that it is would be good to document
>>> architectural decisions in the wiki. The idea is to extract the most
>>> important informations from discussions on e.g. the mailing list. The list
>>> should allow us to point new developers to decisions that were made so they
>>> can inform themselves about these before dicussing the decisions. The list
>>> should also allow to revisit decisions from time to time so we have the
>>> chance to change a decision if for example the reasons for it change.
>>>
>>> See
>>> https://cwiki.apache.org/confluence/display/KARAF/Architectural+decisions
>>>
>>> I currently added a first decision for console as it came up on the irc
>>> channel. Please document further decisions as you see fit and also help
>>> making existing ones more concise.
>>> We should of course not document every little decision. I think a good
>>> indicator that a decision should be documented is when it is discussed often
>>> and or heated :-)
>>>
>>> Christian
>>>
>>>
--
Christian Schneider
http://www.liquid-reality.de
Open Source Architect
Talend Application Integration Division http://www.talend.com
Re: Document archtiectural decisions in Wiki
Posted by "Jamie G." <ja...@gmail.com>.
+1. I agree with Andreas, the supporter/against section can go - if
something comes to a vote that'll be on an email thread, just
including a list of whom was involved is sufficient. The rest looks
good :)
Cheers,
Jamie
On Tue, Feb 7, 2012 at 8:50 AM, Andreas Pieber <an...@gmail.com> wrote:
> As already stated on IRC I'm very much +1 for documenting those decisions.
> Will make various things much easier to adapt/correct afterwards. Though one
> thing I've found in you're template I do not really like is the
> "supporter/aginst" section. I think this does not really help anybody than
> to "pranger" someone if a decision does not work out as planed. I think we
> should rather add an involved section to make it easier finding out who was
> involved in a decision.
>
> Otherwise rellly cool. Thxs for starting this.
>
> Kind regards,
> Andreas
>
>
> On Tue 07 Feb 2012 11:30:02 AM CET, Christian Schneider wrote:
>>
>> Hi all,
>>
>> I discussed with Andreas on IRC that it is would be good to document
>> architectural decisions in the wiki. The idea is to extract the most
>> important informations from discussions on e.g. the mailing list. The list
>> should allow us to point new developers to decisions that were made so they
>> can inform themselves about these before dicussing the decisions. The list
>> should also allow to revisit decisions from time to time so we have the
>> chance to change a decision if for example the reasons for it change.
>>
>> See
>> https://cwiki.apache.org/confluence/display/KARAF/Architectural+decisions
>>
>> I currently added a first decision for console as it came up on the irc
>> channel. Please document further decisions as you see fit and also help
>> making existing ones more concise.
>> We should of course not document every little decision. I think a good
>> indicator that a decision should be documented is when it is discussed often
>> and or heated :-)
>>
>> Christian
>>
>>
>
Re: Document archtiectural decisions in Wiki
Posted by Andreas Pieber <an...@gmail.com>.
As already stated on IRC I'm very much +1 for documenting those
decisions. Will make various things much easier to adapt/correct
afterwards. Though one thing I've found in you're template I do not
really like is the "supporter/aginst" section. I think this does not
really help anybody than to "pranger" someone if a decision does not
work out as planed. I think we should rather add an involved section to
make it easier finding out who was involved in a decision.
Otherwise rellly cool. Thxs for starting this.
Kind regards,
Andreas
On Tue 07 Feb 2012 11:30:02 AM CET, Christian Schneider wrote:
> Hi all,
>
> I discussed with Andreas on IRC that it is would be good to document
> architectural decisions in the wiki. The idea is to extract the most
> important informations from discussions on e.g. the mailing list. The
> list should allow us to point new developers to decisions that were
> made so they can inform themselves about these before dicussing the
> decisions. The list should also allow to revisit decisions from time
> to time so we have the chance to change a decision if for example the
> reasons for it change.
>
> See
> https://cwiki.apache.org/confluence/display/KARAF/Architectural+decisions
>
> I currently added a first decision for console as it came up on the
> irc channel. Please document further decisions as you see fit and also
> help making existing ones more concise.
> We should of course not document every little decision. I think a good
> indicator that a decision should be documented is when it is discussed
> often and or heated :-)
>
> Christian
>
>
Re: Document archtiectural decisions in Wiki
Posted by Christian Schneider <ch...@die-schneider.net>.
Absolutely. I mainly intend to document the decisions as the mailing
list threads can get really big and sometimes contradict themselves.
So after each important decision I think it makes sense to extract what
should be remembered.
Christian
Am 07.02.2012 13:24, schrieb Guillaume Nodet:
> One important thing for everyone to keep in mind.
> IRC is NOT the way to make decisions. The only way for that is the
> mailing list.
>
> On Tue, Feb 7, 2012 at 11:30, Christian Schneider
> <ch...@die-schneider.net> wrote:
>> Hi all,
>>
>> I discussed with Andreas on IRC that it is would be good to document
>> architectural decisions in the wiki. The idea is to extract the most
>> important informations from discussions on e.g. the mailing list. The list
>> should allow us to point new developers to decisions that were made so they
>> can inform themselves about these before dicussing the decisions. The list
>> should also allow to revisit decisions from time to time so we have the
>> chance to change a decision if for example the reasons for it change.
>>
>> See
>> https://cwiki.apache.org/confluence/display/KARAF/Architectural+decisions
>>
>> I currently added a first decision for console as it came up on the irc
>> channel. Please document further decisions as you see fit and also help
>> making existing ones more concise.
>> We should of course not document every little decision. I think a good
>> indicator that a decision should be documented is when it is discussed often
>> and or heated :-)
>>
>> Christian
>>
>>
>> --
>> Christian Schneider
>> http://www.liquid-reality.de
>>
>> Open Source Architect
>> Talend Application Integration Division http://www.talend.com
>>
>
>
--
Christian Schneider
http://www.liquid-reality.de
Open Source Architect
Talend Application Integration Division http://www.talend.com
Re: Document archtiectural decisions in Wiki
Posted by Guillaume Nodet <gn...@gmail.com>.
One important thing for everyone to keep in mind.
IRC is NOT the way to make decisions. The only way for that is the
mailing list.
On Tue, Feb 7, 2012 at 11:30, Christian Schneider
<ch...@die-schneider.net> wrote:
> Hi all,
>
> I discussed with Andreas on IRC that it is would be good to document
> architectural decisions in the wiki. The idea is to extract the most
> important informations from discussions on e.g. the mailing list. The list
> should allow us to point new developers to decisions that were made so they
> can inform themselves about these before dicussing the decisions. The list
> should also allow to revisit decisions from time to time so we have the
> chance to change a decision if for example the reasons for it change.
>
> See
> https://cwiki.apache.org/confluence/display/KARAF/Architectural+decisions
>
> I currently added a first decision for console as it came up on the irc
> channel. Please document further decisions as you see fit and also help
> making existing ones more concise.
> We should of course not document every little decision. I think a good
> indicator that a decision should be documented is when it is discussed often
> and or heated :-)
>
> Christian
>
>
> --
> Christian Schneider
> http://www.liquid-reality.de
>
> Open Source Architect
> Talend Application Integration Division http://www.talend.com
>
--
------------------------
Guillaume Nodet
------------------------
Blog: http://gnodet.blogspot.com/
------------------------
FuseSource, Integration everywhere
http://fusesource.com