[
https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14306036#comment-14306036
]
Vasia Kalavri commented on FLINK-1462:
--------------------------------------
I'm definitely planning to add some pictures for the more complex operations.
I'm on it.. quite slowly because of limited time this week, but it will soon be
ready. And the GraphX guide is indeed very nice!
I have a practical question though: which editor would you people recommend for
writing the guide? I'm using UberWriter but the preview doesn't work so well.
Also, is there a reference for the markdown flavor we're using for the
programming guides? For now, I'm using the existing guides as an example, but
it would be nice to have a full syntax reference.
Thanks!
> Add documentation guide for the graph API
> -----------------------------------------
>
> Key: FLINK-1462
> URL: https://issues.apache.org/jira/browse/FLINK-1462
> Project: Flink
> Issue Type: Task
> Components: Documentation
> Affects Versions: 0.9
> Reporter: Vasia Kalavri
> Assignee: Vasia Kalavri
> Labels: documentation
>
> We should write a guide for Gelly, describing what methods are provided and
> how they can be used.
> It should at least cover the following: graph creation, mutations,
> transformations, neighborhood functions, vertex-centric iteration, validation
> and the library methods.
> We can use a format similar to the Flink streaming guide, which I like a lot
> :)
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
