[jira] [Created] (FLINK-15683) Restructure Documentation Docs

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-15683) Restructure Documentation Docs

Shang Yuanchun (Jira)
Stephan Ewen created FLINK-15683:
------------------------------------

             Summary: Restructure Documentation Docs
                 Key: FLINK-15683
                 URL: https://issues.apache.org/jira/browse/FLINK-15683
             Project: Flink
          Issue Type: Improvement
          Components: Documentation, Runtime / Configuration
            Reporter: Stephan Ewen
             Fix For: 1.11.0


Currently, the configuration docs are very hard to parse. There is a minimal "common" section, and then all options are clustered by code component.

The common options misses quite a lot of common options.

The clustering by code component is not helpful to users, because it mixes options that are frequently necessary to adjust (for example task manager host) are mixed with options that should pretty much never be touched (other than during debugging), like taskmanager.registration.backoff.

The subtasks will outline suggestions for improvements.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)