[FLINK-15683] Restructure Configuration Docs

• Type: Improvement
• Status: Closed
• Priority: Blocker
• Resolution: Fixed
• Fix Version/s: 1.11.0
• Component/s: Documentation, Runtime / Configuration
• Labels: pull-request-available usability
• Assignee: Stephan Ewen
• Reporter: Stephan Ewen
• Created: 20/Jan/20 10:06
• Updated: 05/Feb/20 09:28
• Resolved: 05/Feb/20 09:28

Description

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.

Issue Links

• links to: GitHub Pull Request #10982

Sub-Tasks

• Remove outdated section of Configuration Page: Closed
• Remove HDFS Section of Configuration Page: Closed
• Update description of "RocksDB Configurable Options" for new options: Closed
• Remove Options that are not configured in "flink-conf.yaml" from Configuration Docs: Closed
• Restructure Configuration Docs to separate "Getting Started", "Common Operations" and "Tuning/Debugging": Closed
• Generalize CommonOption to support other option groups as well: Closed