flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ufuk Celebi (JIRA)" <j...@apache.org>
Subject [jira] [Created] (FLINK-4317) Restructure documentation
Date Fri, 05 Aug 2016 12:57:20 GMT
Ufuk Celebi created FLINK-4317:

             Summary: 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.

- 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

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

- how does it work

This message was sent by Atlassian JIRA

View raw message