Re: RE: RE: What versions should the documentation support now?
trunk is the next release which is 4.0. You won't find a branch named 4.0 yet.
Dinesh
On Tuesday, March 13, 2018, 11:39:44 PM PDT, Kenneth Brotman
wrote:
#yiv3841634821 #yiv3841634821 -- _filtered #yiv3841634821
{font-family:Helvetica;panose-1:2 11 6 4 2 2 2 2 2 4;} _filtered #yiv3841634821
{font-family:Helvetica;panose-1:2 11 6 4 2 2 2 2 2 4;} _filtered #yiv3841634821
{font-family:Calibri;panose-1:2 15 5 2 2 2 4 3 2 4;} _filtered #yiv3841634821
{font-family:Tahoma;panose-1:2 11 6 4 3 5 4 4 2 4;} _filtered #yiv3841634821
{panose-1:2 11 6 9 4 5 4 2 2 4;}#yiv3841634821 #yiv3841634821
p.yiv3841634821MsoNormal, #yiv3841634821 li.yiv3841634821MsoNormal,
#yiv3841634821 div.yiv3841634821MsoNormal
{margin:0in;margin-bottom:.0001pt;font-size:12.0pt;}#yiv3841634821 a:link,
#yiv3841634821 span.yiv3841634821MsoHyperlink
{color:blue;text-decoration:underline;}#yiv3841634821 a:visited, #yiv3841634821
span.yiv3841634821MsoHyperlinkFollowed
{color:purple;text-decoration:underline;}#yiv3841634821
p.yiv3841634821MsoAcetate, #yiv3841634821 li.yiv3841634821MsoAcetate,
#yiv3841634821 div.yiv3841634821MsoAcetate
{margin:0in;margin-bottom:.0001pt;font-size:8.0pt;}#yiv3841634821
p.yiv3841634821msonormal, #yiv3841634821 li.yiv3841634821msonormal,
#yiv3841634821 div.yiv3841634821msonormal
{margin-right:0in;margin-left:0in;font-size:12.0pt;}#yiv3841634821
span.yiv3841634821msohyperlink {}#yiv3841634821
span.yiv3841634821msohyperlinkfollowed {}#yiv3841634821
span.yiv3841634821emailstyle17 {}#yiv3841634821 p.yiv3841634821msonormal1,
#yiv3841634821 li.yiv3841634821msonormal1, #yiv3841634821
div.yiv3841634821msonormal1
{margin:0in;margin-bottom:.0001pt;font-size:12.0pt;}#yiv3841634821
span.yiv3841634821msohyperlink1
{color:blue;text-decoration:underline;}#yiv3841634821
span.yiv3841634821msohyperlinkfollowed1
{color:purple;text-decoration:underline;}#yiv3841634821
span.yiv3841634821emailstyle171 {color:#1F497D;}#yiv3841634821
span.yiv3841634821BalloonTextChar {}#yiv3841634821
span.yiv3841634821EmailStyle27 {color:#1F497D;}#yiv3841634821
.yiv3841634821MsoChpDefault {font-size:10.0pt;} _filtered #yiv3841634821
{margin:1.0in 1.0in 1.0in 1.0in;}#yiv3841634821 div.yiv3841634821WordSection1
{}#yiv3841634821
I show a 3.0 and a 3.11 branch but no 4.0. I’m at
https://github.com/apache/cassandra .
From: Dinesh Joshi [mailto:dinesh.jo...@yahoo.com.INVALID]
Sent: Tuesday, March 13, 2018 11:30 PM
To: user@cassandra.apache.org
Subject: Re: RE: What versions should the documentation support now?
Kenneth,
The only 4.x docs should go in trunk. If you would like to contribute docs to
the 2.x and/or 3.x releases, please make pull requests against branches for
those versions.
During normal development process, the docs should be updated in trunk. When a
release is cut from trunk, any further fixes to the docs pertaining to that
release should go into that branch. This is in principle the same process that
the code follows. So the docs will live with their respective branches. You
should not put the documentation for older releases in trunk because it will
end up confusing the user.
It looks like the in-tree docs were introduced in 4.x. They seem to also be
present in the 3.11 branch. If you're inclined, you might back port them to the
older 3.x & 2.x releases and update them.
Personally, I think focusing on making the 4.x docs awesome is a better use of
your time.
Thanks,
Dinesh
On Tuesday, March 13, 2018, 11:03:04 PM PDT, Kenneth Brotman
wrote:
I made sub directories “2_x” and “3_x” under docs and put a copy of the doc in
each. No links were changed yet. We can work on the files first and discuss
how we want to change the template and links. I did the pull request already.
Kenneth Brotman
From: Jonathan Haddad [mailto:j...@jonhaddad.com]
Sent: Tuesday, March 13, 2018 6:19 PM
To: user@cassandra.apache.org
Subject: Re: What versions should the documentation support now?
Yes, I agree, we should host versioned docs. I don't think anyone is against
it, it's a matter of someone having the time to do it.
On Tue, Mar 13, 2018 at 6:14 PM kurt greaves wrote:
I’ve never heard of anyone shipping docs for multiple versions, I don’t know
why we’d do that. You can get the docs for any version you need by downloading
C*, the docs are included. I’m a firm -1 on changing that process.
We should still host versioned docs on the website however. Either that or we
specify "since version x" for each component in the docs with notes on
behaviour.
RE: RE: What versions should the documentation support now?
I show a 3.0 and a 3.11 branch but no 4.0. I’m at https://github.com/apache/cassandra . From: Dinesh Joshi [mailto:dinesh.jo...@yahoo.com.INVALID] Sent: Tuesday, March 13, 2018 11:30 PM To: user@cassandra.apache.org Subject: Re: RE: What versions should the documentation support now? Kenneth, The only 4.x docs should go in trunk. If you would like to contribute docs to the 2.x and/or 3.x releases, please make pull requests against branches for those versions. During normal development process, the docs should be updated in trunk. When a release is cut from trunk, any further fixes to the docs pertaining to that release should go into that branch. This is in principle the same process that the code follows. So the docs will live with their respective branches. You should not put the documentation for older releases in trunk because it will end up confusing the user. It looks like the in-tree docs were introduced in 4.x. They seem to also be present in the 3.11 branch. If you're inclined, you might back port them to the older 3.x & 2.x releases and update them. Personally, I think focusing on making the 4.x docs awesome is a better use of your time. Thanks, Dinesh On Tuesday, March 13, 2018, 11:03:04 PM PDT, Kenneth Brotman wrote: I made sub directories “2_x” and “3_x” under docs and put a copy of the doc in each. No links were changed yet. We can work on the files first and discuss how we want to change the template and links. I did the pull request already. Kenneth Brotman From: Jonathan Haddad [mailto:j...@jonhaddad.com] Sent: Tuesday, March 13, 2018 6:19 PM To: user@cassandra.apache.org Subject: Re: What versions should the documentation support now? Yes, I agree, we should host versioned docs. I don't think anyone is against it, it's a matter of someone having the time to do it. On Tue, Mar 13, 2018 at 6:14 PM kurt greaves wrote: I’ve never heard of anyone shipping docs for multiple versions, I don’t know why we’d do that. You can get the docs for any version you need by downloading C*, the docs are included. I’m a firm -1 on changing that process. We should still host versioned docs on the website however. Either that or we specify "since version x" for each component in the docs with notes on behaviour.
Re: RE: What versions should the documentation support now?
Kenneth,
The only 4.x docs should go in trunk. If you would like to contribute docs to
the 2.x and/or 3.x releases, please make pull requests against branches for
those versions.
During normal development process, the docs should be updated in trunk. When a
release is cut from trunk, any further fixes to the docs pertaining to that
release should go into that branch. This is in principle the same process that
the code follows. So the docs will live with their respective branches. You
should not put the documentation for older releases in trunk because it will
end up confusing the user.
It looks like the in-tree docs were introduced in 4.x. They seem to also be
present in the 3.11 branch. If you're inclined, you might back port them to the
older 3.x & 2.x releases and update them.
Personally, I think focusing on making the 4.x docs awesome is a better use of
your time.
Thanks,
Dinesh
On Tuesday, March 13, 2018, 11:03:04 PM PDT, Kenneth Brotman
wrote:
#yiv9726083586 #yiv9726083586 -- _filtered #yiv9726083586
{font-family:Calibri;panose-1:2 15 5 2 2 2 4 3 2 4;} _filtered #yiv9726083586
{font-family:Tahoma;panose-1:2 11 6 4 3 5 4 4 2 4;}#yiv9726083586
#yiv9726083586 p.yiv9726083586MsoNormal, #yiv9726083586
li.yiv9726083586MsoNormal, #yiv9726083586 div.yiv9726083586MsoNormal
{margin:0in;margin-bottom:.0001pt;font-size:12.0pt;}#yiv9726083586 a:link,
#yiv9726083586 span.yiv9726083586MsoHyperlink
{color:blue;text-decoration:underline;}#yiv9726083586 a:visited, #yiv9726083586
span.yiv9726083586MsoHyperlinkFollowed
{color:purple;text-decoration:underline;}#yiv9726083586
span.yiv9726083586EmailStyle17 {color:#1F497D;}#yiv9726083586
.yiv9726083586MsoChpDefault {} _filtered #yiv9726083586 {margin:1.0in 1.0in
1.0in 1.0in;}#yiv9726083586 div.yiv9726083586WordSection1 {}#yiv9726083586
I made sub directories “2_x” and “3_x” under docs and put a copy of the doc in
each. No links were changed yet. We can work on the files first and discuss
how we want to change the template and links. I did the pull request already.
Kenneth Brotman
From: Jonathan Haddad [mailto:j...@jonhaddad.com]
Sent: Tuesday, March 13, 2018 6:19 PM
To: user@cassandra.apache.org
Subject: Re: What versions should the documentation support now?
Yes, I agree, we should host versioned docs. I don't think anyone is against
it, it's a matter of someone having the time to do it.
On Tue, Mar 13, 2018 at 6:14 PM kurt greaves wrote:
I’ve never heard of anyone shipping docs for multiple versions, I don’t know
why we’d do that. You can get the docs for any version you need by downloading
C*, the docs are included. I’m a firm -1 on changing that process.
We should still host versioned docs on the website however. Either that or we
specify "since version x" for each component in the docs with notes on
behaviour.
