StephanEwen opened a new pull request #10982: [FLINK-15683][docs] Restructure 
Configuration page
URL: https://github.com/apache/flink/pull/10982
 
 
   ## What is the purpose of the change
   
   This restructures the documentation page to make it less confusing and more 
easily digestible for users. This also removes some 
outdated/confusing/misleading background sections.
   
   The improvements are twofold:
     - Group the parameters by "use case" and "user-facing behavior", rather 
than by the class in which they are defined.
     - Distinguish between parameters that are required or typically use to set 
up some functionality, and parameters you should not worry about in most cases 
(only you really need to do advanced trouble-shooting).
   
   ![Annotation 2020-01-31 
103900](https://user-images.githubusercontent.com/1727146/73529250-b3849000-4416-11ea-841a-b1bebfe00488.png)
   
   ## Follow-up
   
   This PR does not yet update and descriptions or resolve the issue that 
`(none)` as the default value does not tell the user if this is a required 
parameter (for a certain feature), it has an internal default behavior or 
fallback, or it is purely optional.
   
   ## Brief change log
   
   Main changes:
     - Generalize the `@CommonOption` annotation to `@Section` to support 
putting options in different (multiple) sections independent of the source code 
file in which they are defined
     - Rework the configuration.md page to set up a different structure of 
grouping the options
       
https://github.com/apache/flink/compare/master...StephanEwen:restructure_docs?expand=1#diff-b98ef45d30f932983679d102102dd8f0
   
   Additional changes:
     - Removes outdated section on HDFS config variables
     - Removes outdated background section and places extra links to other 
parts of the docs in the relevant sections.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to