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

Posted to dev@knox.apache.org by Lars Francke <la...@gmail.com> on 2016/01/12 12:01:52 UTC

Documentation contributions

Just a quick question about your documentation.

I see that it's in SVN and versioned but what if I want to contribute a fix
now for the next version? Generate a patch for the latest (0.7.0) or copy
the docs over to a 0.8.0 directory and make my change there? Or something
different entirely.

Thanks,
Lars

Re: Documentation contributions

Posted by larry mccay <la...@gmail.com>.

Awesome - thanks, Lars!

On Tue, Jan 12, 2016 at 8:06 AM, Lars Francke <la...@gmail.com>
wrote:

> Thanks Larry,
>
> I only have minor things, formatting and typos etc. so I'll just do a patch
> against 0.7.0.
>
> On Tue, Jan 12, 2016 at 1:24 PM, larry mccay <lm...@apache.org> wrote:
>
> > Hi Lars -
> >
> > That period between a release and when the next version is copied to a
> new
> > directory does happen to be a slightly awkward spot.
> > Generally, yes, you copy the 0.7.0 version to an 0.8.0 directory and
> > rebuild it all with 'ant'.
> >
> > Now, if you have a contribution for the docs then you can certainly do it
> > in 0.7.0 - as long as it is for a feature that exists in 0.7.0.
> > Then when someone else copies it to 0.8.0 it will move with it.
> >
> > We treat the current release docs as a living breathing documentation
> > rather than freezing it with the release. This way we can fix
> > things in it while working on the next release.
> >
> > It might make sense to add the copying of the directory to the next
> release
> > as part of the release process. Though fixes to the docs for a recent
> > release are easier when it is the latest version in the docs too. It is
> > something to consider anyway.
> >
> > thanks,
> >
> > --larry
> >
> > On Tue, Jan 12, 2016 at 6:01 AM, Lars Francke <la...@gmail.com>
> > wrote:
> >
> > > Just a quick question about your documentation.
> > >
> > > I see that it's in SVN and versioned but what if I want to contribute a
> > fix
> > > now for the next version? Generate a patch for the latest (0.7.0) or
> copy
> > > the docs over to a 0.8.0 directory and make my change there? Or
> something
> > > different entirely.
> > >
> > > Thanks,
> > > Lars
> > >
> >
>

Re: Documentation contributions

Posted by Lars Francke <la...@gmail.com>.

Thanks Larry,

I only have minor things, formatting and typos etc. so I'll just do a patch
against 0.7.0.

On Tue, Jan 12, 2016 at 1:24 PM, larry mccay <lm...@apache.org> wrote:

> Hi Lars -
>
> That period between a release and when the next version is copied to a new
> directory does happen to be a slightly awkward spot.
> Generally, yes, you copy the 0.7.0 version to an 0.8.0 directory and
> rebuild it all with 'ant'.
>
> Now, if you have a contribution for the docs then you can certainly do it
> in 0.7.0 - as long as it is for a feature that exists in 0.7.0.
> Then when someone else copies it to 0.8.0 it will move with it.
>
> We treat the current release docs as a living breathing documentation
> rather than freezing it with the release. This way we can fix
> things in it while working on the next release.
>
> It might make sense to add the copying of the directory to the next release
> as part of the release process. Though fixes to the docs for a recent
> release are easier when it is the latest version in the docs too. It is
> something to consider anyway.
>
> thanks,
>
> --larry
>
> On Tue, Jan 12, 2016 at 6:01 AM, Lars Francke <la...@gmail.com>
> wrote:
>
> > Just a quick question about your documentation.
> >
> > I see that it's in SVN and versioned but what if I want to contribute a
> fix
> > now for the next version? Generate a patch for the latest (0.7.0) or copy
> > the docs over to a 0.8.0 directory and make my change there? Or something
> > different entirely.
> >
> > Thanks,
> > Lars
> >
>

Re: Documentation contributions

Posted by larry mccay <lm...@apache.org>.

Hi Lars -

That period between a release and when the next version is copied to a new
directory does happen to be a slightly awkward spot.
Generally, yes, you copy the 0.7.0 version to an 0.8.0 directory and
rebuild it all with 'ant'.

Now, if you have a contribution for the docs then you can certainly do it
in 0.7.0 - as long as it is for a feature that exists in 0.7.0.
Then when someone else copies it to 0.8.0 it will move with it.

We treat the current release docs as a living breathing documentation
rather than freezing it with the release. This way we can fix
things in it while working on the next release.

It might make sense to add the copying of the directory to the next release
as part of the release process. Though fixes to the docs for a recent
release are easier when it is the latest version in the docs too. It is
something to consider anyway.

thanks,

--larry

On Tue, Jan 12, 2016 at 6:01 AM, Lars Francke <la...@gmail.com>
wrote:

> Just a quick question about your documentation.
>
> I see that it's in SVN and versioned but what if I want to contribute a fix
> now for the next version? Generate a patch for the latest (0.7.0) or copy
> the docs over to a 0.8.0 directory and make my change there? Or something
> different entirely.
>
> Thanks,
> Lars
>