[
https://issues.apache.org/jira/browse/SPARK-22630?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16268880#comment-16268880
]
Sean Owen commented on SPARK-22630:
-----------------------------------
The flip-side is that you end up duplicating documentation. They're not only in
the source code, but mentioned in module-specific pages, and now possibly again
on a single configuration page.
It's at least useful to advertise that main page as a list of "important
options" only and link to other relevant docs. It may be useful to repeat some
important configs in the main doc that are obviously missing (which ones?) It
may not be a goal to list every config also in this main doc.
> Consolidate all configuration properties into one page
> ------------------------------------------------------
>
> Key: SPARK-22630
> URL: https://issues.apache.org/jira/browse/SPARK-22630
> Project: Spark
> Issue Type: Documentation
> Components: Documentation
> Affects Versions: 2.2.0
> Reporter: Andreas Maier
>
> The page https://spark.apache.org/docs/2.2.0/configuration.html gives the
> impression as if all configuration properties of Spark are described on this
> page. Unfortunately this is not true. The description of important properties
> is spread through the documentation. The following pages list properties,
> which are not described on the configuration page:
> https://spark.apache.org/docs/2.2.0/sql-programming-guide.html#performance-tuning
> https://spark.apache.org/docs/2.2.0/monitoring.html#spark-configuration-options
> https://spark.apache.org/docs/2.2.0/security.html#ssl-configuration
> https://spark.apache.org/docs/2.2.0/sparkr.html#starting-up-from-rstudio
> https://spark.apache.org/docs/2.2.0/running-on-yarn.html#spark-properties
> https://spark.apache.org/docs/2.2.0/running-on-mesos.html#configuration
> https://spark.apache.org/docs/2.2.0/spark-standalone.html#cluster-launch-scripts
> As a reader of the documentation I would like to have single central webpage
> describing all Spark configuration properties. Alternatively it would be nice
> to at least add links from the configuration page to the other pages of the
> documentation, where configuration properties are described.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
