It seems like the documentation that should be in the trunk for version 3.0, 
should include information for users of version 3.0 and 2.1; the documentation 
that should in 4.0 (when its released), should include information for users of 
4.0 and at least one previous version, etc. 

 

How about if we do it that way?

 

Kenneth Brotman    

 

From: Jonathan Haddad [mailto:j...@jonhaddad.com] 
Sent: Monday, March 12, 2018 9:10 AM
To: user@cassandra.apache.org
Subject: Re: What versions should the documentation support now?

 

Right now they can’t.

On Mon, Mar 12, 2018 at 9:03 AM Kenneth Brotman <kenbrot...@yahoo.com.invalid> 
wrote:

I see how that makes sense Jon but how does a user then select the 
documentation for the version they are running on the Apache Cassandra web site?

 

Kenneth Brotman

 

From: Jonathan Haddad [mailto:j...@jonhaddad.com] 
Sent: Monday, March 12, 2018 8:40 AM


To: user@cassandra.apache.org
Subject: Re: What versions should the documentation support now?

 

The docs are in tree, meaning they are versioned, and should be written for the 
version they correspond to. Trunk docs should reflect the current state of 
trunk, and shouldn’t have caveats for other versions. 

On Mon, Mar 12, 2018 at 8:15 AM Kenneth Brotman <kenbrotman@yahoocom.invalid 
<mailto:kenbrot...@yahoo.com.invalid> > wrote:

If we use DataStax’s example, we would have instructions for v3.0 and v2.1.  
How’s that?  

 

We should have to be instructions for the cloud platforms like AWS but how do 
you do that and stay vendor neutral?

 

Kenneth Brotman

 

From: Hannu Kröger [mailto:hkro...@gmail.com] 
Sent: Monday, March 12, 2018 7:40 AM
To: user@cassandra.apache.org
Subject: Re: What versions should the documentation support now?

 

In my opinion, a good documentation should somehow include version specific 
pieces of information. Whether it is nodetool command that came in certain 
version or parameter for something or something else.

 

That would very useful. It’s confusing if I see documentation talking about 4.0 
specifics and I try to find that in my 3.11.x

 

Hannu

 

On 12 Mar 2018, at 16:38, Kenneth Brotman <kenbrot...@yahoo.com.INVALID> wrote:

 

I’m unclear what versions are most popular right now? What version are you 
running?

 

What version should still be supported in the documentation?  For example, I’m 
turning my attention back to writing a section on adding a data center.  What 
versions should I support in that information?

 

I’m working on it right now.  Thanks,

 

Kenneth Brotman

 

Reply via email to