You are viewing a plain text version of this content. The canonical link for it is here.

Posted to oak-dev@jackrabbit.apache.org by Miroslav Smiljanic <mi...@apache.org> on 2021/01/20 12:13:41 UTC

When to update the documentation

Hi All,

I have created an issue and proposed a patch to improve execution of
multiple benchmarks with Oak-Segment-Azure fixture. Feedback in the issue
is welcome.

https://issues.apache.org/jira/browse/OAK-9328

I have a question about updating the documentation. The patch is
introducing the new system property which should be documented. In this
case do we update documentation immediately after applying the patch, or we
wait till after the next release?

Regards,
Miroslav

Re: When to update the documentation

Posted by Miroslav Smiljanic <mi...@apache.org>.

Thank you both for feedback.

I guess I can reference the unreleased version, copying the value form the
JIRA issue field "Fix Versions/s"?


On Thu, Jan 21, 2021 at 9:57 AM Angela Schreiber <an...@adobe.com.invalid>
wrote:

> hi
>
> same here... for new features i usually refer to jira or the released
> version to clarify that it's not available in older versions.
>
> if i remember correctly we discussed this in the past. afaik the
> conclusion was back then that the documentation should reflect the latest
> trunk as we don't keep seperate doc versions for the different branches.
>
> kind regards
> angela
> ________________________________
> From: Andrei Dulceanu <an...@gmail.com>
> Sent: Thursday, January 21, 2021 9:42 AM
> To: oak-dev@jackrabbit.apache.org <oa...@jackrabbit.apache.org>
> Subject: Re: When to update the documentation
>
> Hi Miroslav,
>
> I always included any documentation updates in the same commit introducing
> the change. I guess it's more transparent and this way one makes sure not
> to forget about it later.
>
> Regards,
> Andrei
>
> On Wed, Jan 20, 2021 at 1:13 PM Miroslav Smiljanic <mi...@apache.org>
> wrote:
>
> > Hi All,
> >
> > I have created an issue and proposed a patch to improve execution of
> > multiple benchmarks with Oak-Segment-Azure fixture. Feedback in the issue
> > is welcome.
> >
> > https://issues.apache.org/jira/browse/OAK-9328
> >
> > I have a question about updating the documentation. The patch is
> > introducing the new system property which should be documented. In this
> > case do we update documentation immediately after applying the patch, or
> we
> > wait till after the next release?
> >
> > Regards,
> > Miroslav
> >
>

Re: When to update the documentation

Posted by Angela Schreiber <an...@adobe.com.INVALID>.

hi

same here... for new features i usually refer to jira or the released version to clarify that it's not available in older versions.

if i remember correctly we discussed this in the past. afaik the conclusion was back then that the documentation should reflect the latest trunk as we don't keep seperate doc versions for the different branches.

kind regards
angela
________________________________
From: Andrei Dulceanu <an...@gmail.com>
Sent: Thursday, January 21, 2021 9:42 AM
To: oak-dev@jackrabbit.apache.org <oa...@jackrabbit.apache.org>
Subject: Re: When to update the documentation

Hi Miroslav,

I always included any documentation updates in the same commit introducing
the change. I guess it's more transparent and this way one makes sure not
to forget about it later.

Regards,
Andrei

On Wed, Jan 20, 2021 at 1:13 PM Miroslav Smiljanic <mi...@apache.org>
wrote:

> Hi All,
>
> I have created an issue and proposed a patch to improve execution of
> multiple benchmarks with Oak-Segment-Azure fixture. Feedback in the issue
> is welcome.
>
> https://issues.apache.org/jira/browse/OAK-9328
>
> I have a question about updating the documentation. The patch is
> introducing the new system property which should be documented. In this
> case do we update documentation immediately after applying the patch, or we
> wait till after the next release?
>
> Regards,
> Miroslav
>

Re: When to update the documentation

Posted by Andrei Dulceanu <an...@gmail.com>.

Hi Miroslav,

I always included any documentation updates in the same commit introducing
the change. I guess it's more transparent and this way one makes sure not
to forget about it later.

Regards,
Andrei

On Wed, Jan 20, 2021 at 1:13 PM Miroslav Smiljanic <mi...@apache.org>
wrote:

> Hi All,
>
> I have created an issue and proposed a patch to improve execution of
> multiple benchmarks with Oak-Segment-Azure fixture. Feedback in the issue
> is welcome.
>
> https://issues.apache.org/jira/browse/OAK-9328
>
> I have a question about updating the documentation. The patch is
> introducing the new system property which should be documented. In this
> case do we update documentation immediately after applying the patch, or we
> wait till after the next release?
>
> Regards,
> Miroslav
>