You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2016/05/02 12:04:12 UTC

[jira] [Commented] (FLINK-3793) Re-organize the Table API and SQL docs

    [ https://issues.apache.org/jira/browse/FLINK-3793?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15266308#comment-15266308 ] 

ASF GitHub Bot commented on FLINK-3793:
---------------------------------------

GitHub user vasia opened a pull request:

    https://github.com/apache/flink/pull/1955

    [FLINK-3793][docs] re-organize table API and SQL docs

    - [X] General
      - The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
      - The pull request addresses only one issue
      - Each commit in the PR has a meaningful commit message (including the JIRA id)
    
    - [X] Documentation
      - Documentation has been added for new functionality
      - Old documentation affected by the pull request has been updated
      - JavaDoc for public methods has been added
    
    - [ ] Tests & Build
      - Functionality added by the pull request is covered by tests
      - `mvn clean verify` has been executed successfully locally or a Travis build has passed
    
    - The Table API and SQL guide has been moved to docs/apis and old pages redirect to the new location.
    - The separate Java and Scala guides have been merged with the tab format.
    - The Flink stack figure has been updated.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/vasia/flink table-docs

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/1955.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1955
    
----
commit 79be777b2ed412f39ad5d7f090138a76aa023466
Author: vasia <va...@apache.org>
Date:   2016-05-02T09:00:58Z

    [FLINK-3793][docs] re-organize table API and SQL docs

----


> Re-organize the Table API and SQL docs
> --------------------------------------
>
>                 Key: FLINK-3793
>                 URL: https://issues.apache.org/jira/browse/FLINK-3793
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation, Table API
>    Affects Versions: 1.1.0
>            Reporter: Vasia Kalavri
>            Assignee: Vasia Kalavri
>
> Now that we have added SQL and soon streaming SQL support, we need to reorganize the Table API documentation. 
> - The current guide is under "apis/batch/libs". We should either split it into a streaming and a batch part or move it to under "apis". The second option might be preferable, as the batch and stream APIs have a lot in common.
> - The current guide has separate sections for Java and Scala APIs. These can be merged and organized with tabs, like other parts of the docs.
> - Mentions of "Table API" can be renamed to "Table API and SQL", e.g. in the software stack figure and homepage.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)