[jira] [Commented] (FLINK-4317) Restructure documentation

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

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

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

GitHub user uce opened a pull request:

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

    [FLINK-4317, FLIP-3] [docs] Restructure docs

    This is the initial layout for the docs restructuring as discussed in FLIP-3.
    
    We move the top level navigation to the left side and allow arbitrary nestings to be defined. The main goal is that users find more of the important content. Therefore the docs are now treating streaming as the default and move some streaming-only content to the top-level.
    
    This kind of left-side navigation layout is also followed by other popular projects like [Google DataFlow docs](https://cloud.google.com/dataflow/docs/) or http://readthedocs.org.
    
    You can preview the new layout here: http://uce.github.io/flink/
    
    We need to follow up with more actual content (see FLIP-3). If we adapt this layout, I would file the required content changes as JIRAs and ask someone to coordinate the writing process among the interested contributors.

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

    $ git pull https://github.com/uce/flink docs

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

    https://github.com/apache/flink/pull/2387.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 #2387
    
----
commit 724296b0376291e7f4a0e4031507f871f56395fa
Author: Ufuk Celebi <uc...@apache.org>
Date:   2016-08-17T13:06:04Z

    [FLINK-4317, FLIP-3] [docs] Restructure docs
    
    - Add redirect layout
    - Remove Maven artifact name warning
    - Add info box if stable, but not latest
    - Add font-awesome 4.6.3
    - Add sidenav layout

----


> Restructure documentation
> -------------------------
>
>                 Key: FLINK-4317
>                 URL: https://issues.apache.org/jira/browse/FLINK-4317
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 1.1.0
>            Reporter: Ufuk Celebi
>            Assignee: Ufuk Celebi
>             Fix For: 1.2.0
>
>
> - Documentation is not well grouped into categories according to what is relevant in different steps of the development and deployment process
> - The current layout has not enough top-level navigation menus to guide people that look for docs. Experience shows that anything hidden in a larger document linked from a sub-menu is overlooked by many people.
> Concepts
> - Overview: Similar to the current start page, stack and brief description
> - Concepts: Similar to what we currently have
> - Architecture: Process model (JM / TM / Client / …)
> - Project Structure: Core Maven artifacts, what needed when, relationships
> Semantics
> Setup & Operations
> - Setup: Downloading, Building from Source, Hadoop Versions / Scala Versions
> - Deployment Options: Yarn, Mesos, Standalone, etc
> - Configuration
> - Failure & Recovery Model
> - Security Model
> Application Development
> - Quickstarts 
> - APIs: Streaming, Batch, Table, SQL
> - Event Time and Windowing Semantics
> - Libraries
> - State Backends
> - Connectors, End-to-end Exactly-once
> - Data Types: Types, Serialization (Custom, Kryo, Avro), Lambdas, Hints, Extensibility
> Testing & Debugging
> - Testing and test utilities
> - Debugging
> - Monitoring: Web Frontend, Metrics
> - Tuning: Memory, CPU, GC
> - Operations: Version Upgrades, etc
> Internals
> - how does it work



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