[ZEPPELIN-575] Cassandra interpreter V2 documentation by doanduyhai · Pull Request #604 · apache/zeppelin

doanduyhai · 2016-01-06T09:35:07Z

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 · 2016-01-11T01:30:41Z

docs/interpreter/cassandra.md

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.

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

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?

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.

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 · 2016-01-13T00:51:05Z

@doanduyhai Its fine. Its not confusing at all.

felixcheung · 2016-01-24T00:20:15Z

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

… pages

doanduyhai · 2016-01-27T17:02:25Z

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

Leemoonsoo · 2016-01-27T22:13:05Z

docs/interpreter/cassandra.md

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}} :

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

### What is this PR for? Update official documentation for **Cassandra interpreter V2** Related to PR: apache#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** [ZEPPELIN-575]: https://issues.apache.org/jira/browse/ZEPPELIN-575 Author: DuyHai DOAN <[email protected]> Closes apache#604 from doanduyhai/CassandraInterpreterDocumentation and squashes the following commits: d3f7871 [DuyHai DOAN] Use ZEPPELIN_VERSION variable instead of hard-coding c05d489 [DuyHai DOAN] Revert commit of doc cleaning PR apache#648 88811ee [DuyHai DOAN] Add Zeppelin version along-side with interpreter version 01716e1 [DuyHai DOAN] Cassandra Interpreter V2 doc e3dd18b [DuyHai DOAN] [ZEPPELIN-382] Add Documentation for Cassandra interpreter in the doc pages

Leemoonsoo · 2016-02-04T04:14:22Z

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 · 2016-02-04T14:26:42Z

Ok, will fix

Leemoonsoo · 2016-02-04T23:52:56Z

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 · 2016-02-05T00:03:06Z

Done

Leemoonsoo · 2016-02-05T00:04:38Z

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

AhyoungRyu · 2016-02-05T02:04:09Z

docs/interpreter/cassandra.md

-    </td>
-  </tr>
-</table>
+## 6. Comments in statements


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

doanduyhai · 2016-02-05T11:07:13Z

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

doanduyhai · 2016-02-09T15:04:50Z

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

doanduyhai changed the title ~~[ZEPPELIN-575] Cassandra interpreter documentation~~ [ZEPPELIN-575] Cassandra interpreter V2 documentation Jan 6, 2016

felixcheung reviewed Jan 11, 2016
View reviewed changes

doanduyhai added 3 commits January 27, 2016 14:34

[ZEPPELIN-382] Add Documentation for Cassandra interpreter in the doc…

e3dd18b

… pages

Cassandra Interpreter V2 doc

01716e1

Add Zeppelin version along-side with interpreter version

88811ee

doanduyhai force-pushed the CassandraInterpreterDocumentation branch from bc5538f to 88811ee Compare January 27, 2016 13:37

Leemoonsoo reviewed Jan 27, 2016
View reviewed changes

doanduyhai added 2 commits January 27, 2016 23:44

Revert commit of doc cleaning PR apache#648

c05d489

Use ZEPPELIN_VERSION variable instead of hard-coding

d3f7871

doanduyhai force-pushed the CassandraInterpreterDocumentation branch from 648c6f9 to d3f7871 Compare January 28, 2016 09:52

Fixes reference to ZEPPELIN_VERSION in markdown

f052bd8

Add ZEPPELIN_VERSION in _config.yml

80fcea4

AhyoungRyu reviewed Feb 5, 2016
View reviewed changes

doanduyhai force-pushed the CassandraInterpreterDocumentation branch from 49192a6 to 4f6c07f Compare February 6, 2016 19:20

Remove un-necessary whitespaces

b1e70cb

doanduyhai force-pushed the CassandraInterpreterDocumentation branch from 4f6c07f to b1e70cb Compare February 8, 2016 10:23

Conversation

doanduyhai commented Jan 6, 2016

What is this PR for?

What type of PR is it?

Is there a relevant Jira issue?

How should this be tested?

Questions:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elbamos commented Jan 13, 2016

Uh oh!

felixcheung commented Jan 24, 2016

Uh oh!

doanduyhai commented Jan 27, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Leemoonsoo commented Feb 4, 2016

Uh oh!

doanduyhai commented Feb 4, 2016

Uh oh!

Leemoonsoo commented Feb 4, 2016

Uh oh!

doanduyhai commented Feb 5, 2016

Uh oh!

Leemoonsoo commented Feb 5, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

doanduyhai commented Feb 5, 2016

Uh oh!

doanduyhai commented Feb 9, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants