[ZEPPELIN-575] Cassandra interpreter V2 documentation

[doanduyhai]

What is this PR for?

Update official documentation for Cassandra interpreter V2
Related to PR: #600

What type of PR is it?

[Documentation]

Is there a relevant Jira issue?

ZEPPELIN-575

How should this be tested?

Just check the doc after the build to see if you can see the chapter 14 Change Log

Questions:

• Does the licenses files need update? --> No
• Is there breaking changes for older versions? --> No
• Does this needs documentation? --> No

[felixcheung]

this versioning might be a bit confusing? I don't know if we have separate version for built-in interpreters but it is definitely useful to highlight changes.

[doanduyhai]

The versioning of the interpreter is here to track changes/bug fixes and new features in line with Cassandra versions.

I don't see why it is confusing. Zeppelin version relates to all core/infrastructure code. Interpreter version relates to features of custom backend

[felixcheung]

what I mean is the interpreter jar or code itself does not have 1.0 or 2.0 version though? how would a user know which one they have? or which binary release of zeppelin has which?

[Leemoonsoo]

I think 1.0 and 2.0 versioning here could confusing while users can not know which Zeppelin version includes 1.0 and which Zeppelin version includes 2.0 of Cassandra interpreter.

At least mapping version with Zeppelin release version, like

2.0 - (zeppelin 0.5.6-incubating)
1.0 - (zeppelin 0.5.5-incubating)

would help user get idea about the version he is using.

Or just removing Cassandera interpreter version information (1.0, 2.0) from this doc would also fine, while the Zeppelin documentation it-self published version by version

It implies which features of Cassandera interpreters are release with which version of Zeppelin.

[doanduyhai]

I'm pretty attached to the versioning of the Cassandra interpreter because it allows users to know what has been changed/added/removed.

But your remark also makes sense because this specific versioning can be confusing for people.

The best strategy would be to specify the interpreter version along side with the Zeppelin version (SNAPSHOT or RELEASE does not matter)

[elbamos]

@doanduyhai Its fine. Its not confusing at all.

[felixcheung]

You probably want to merge with master and bring this up-to-date with changes from PR #648 as well.

[doanduyhai]

@Leemoonsoo Done, I've added corresponding Zeppelin version along with each Cassandra interpreter version

[Leemoonsoo]

I'm not sure we're planning to have 0.5.7 before we go 0.6.0.

If you mean current version of Zeppelin, i think you can define a variable ZEPPELIN_VERSION https://github.com/apache/incubator-zeppelin/blob/master/docs/_config.yml, like BASE_PATH.

And reference it in the md
Zeppelin {{ ZEPPELIN_VERSION}} :

[doanduyhai]

Didn't know about the {{ ZEPPELIN_VERSION}} trick, will update the doc right now. Thanks

[Leemoonsoo]

Regarding version, I tried and it seems need to be defined in this way

https://github.com/Leemoonsoo/incubator-zeppelin/blob/ZEPPELIN-559-ver/docs/_config.yml#L24

and reference like

**2.0** _(Zeppelin {{ site.ZEPPELIN_VERSION }})_ : 

[doanduyhai]

Ok, will fix

[Leemoonsoo]

Could you also add ZEPPELIN_VERSION field in _config.yml like https://github.com/Leemoonsoo/incubator-zeppelin/blob/ZEPPELIN-559-ver/docs/_config.yml#L24 ?

[doanduyhai]

Done

[Leemoonsoo]

Thanks @doanduyhai
LGTM and merge if there're no more discussion!

[AhyoungRyu]

Hi @doanduyhai : )
I think there are still some rest of numbering.

[doanduyhai]

Thank you @AhyoungRyu !!! Good catch! Those whitespaces are tricky errors

[doanduyhai]

@AhyoungRyu Can you please tell me if the last update is ok ?

[AhyoungRyu]

@doanduyhai Sorry for the late response. Looks good! : )

[jongyoul]

I just read that docs but It looks pretty good to me.

[felixcheung]

merging today then...