[SPARK-11835] Adds a sidebar menu to MLlib's documentation

[thunterdb]

This PR adds a sidebar menu when browsing the user guide of MLlib. It uses a YAML file to describe the structure of the documentation. It should be trivial to adapt this to the other projects.

[SparkQA]

Test build #46280 has finished for PR 9826 at commit d67f060.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds the following public classes (experimental):\n * public final class UnsafeSorterSpillReader extends UnsafeSorterIterator implements Closeable\n * class CountVectorizerModelWriter(instance: CountVectorizerModel) extends Writer\n * final class IDF(override val uid: String) extends Estimator[IDFModel] with IDFBase with Writable\n * class MinMaxScalerModelWriter(instance: MinMaxScalerModel) extends Writer\n * class StandardScalerModelWriter(instance: StandardScalerModel) extends Writer\n * class StringIndexModelWriter(instance: StringIndexerModel) extends Writer\n * class ALS(override val uid: String) extends Estimator[ALSModel] with ALSParams with Writable\n * trait ScalaReflection\n * case class Schema(dataType: DataType, nullable: Boolean)\n * s\"Unable to generate an encoder for inner class$\n *case class EncodeUsingSerializer(child: Expression, kryo: Boolean) extends UnaryExpression \n *case class DecodeUsingSerializer[T](child: Expression, tag: ClassTag[T], kryo: Boolean)`\n

[mengxr]

elastic-net

[mengxr]

Great work! Shall we hide the side-nav-bar if width is not sufficient? See attached screenshot:

[thunterdb]

@mengxr with the fixes, the top menu breaks before the side menu :-)

[thunterdb]

This is about as much as I can do with my very limited knowledge of CSS, so additional fixes can be done in a separate PR.

[SparkQA]

Test build #46343 has finished for PR 9826 at commit c8a7cb2.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds no public classes.

[andrewor14]

nice! I wonder if there's something more general we can do. This is useful across all pages in the docs so it would be worth investigating if there are existing frameworks we can use. E.g. this format is nice: http://docs.scala-lang.org/overviews/core/futures.html

[thunterdb]

@andrewor14 this is a different issue: the SIPs show the table of contents within one document, which we already have with the {:toc} directive. This PR adds the per-project organization (linking various markdown files together). This is not something we can infer automatically because we show different levels of nesting for each of the pages. Each project already has this description in their overview pages, and I am proposing we move them to the side bar:

• http://spark.apache.org/docs/latest/streaming-programming-guide.html
• http://spark.apache.org/docs/latest/sql-programming-guide.html
• http://spark.apache.org/docs/latest/graphx-programming-guide.html
• http://spark.apache.org/docs/latest/sparkr.html

[thunterdb]

@mengxr based on our discussions, here is a slightly updated version:

• menu is fixed
• menu disappears under the page (but it looks half covered in the middle). Fixing that would require JS, I think (and sk-learn does not have a fixed menu):

[mengxr]

@thunterdb Could you try the following CSS:

.left-menu-wrapper {
  position: absolute;
  height: 100%;
  width: 256px;
  margin-top: -20px;
  padding-top: 20px;
  background-color: #F0F8FC;
}

.left-menu {
  position: fixed;
  width: 256px;
  padding-right: 10px;
}

It doesn't fix the issue with hiding the sidebar but makes the background lighter:

[thunterdb]

@mengxr comment addressed

[mengxr]

test this please

[mengxr]

test this please

[mengxr]

test this please

[SparkQA]

Test build #46457 has finished for PR 9826 at commit 0350265.

• This patch fails Spark unit tests.
• This patch merges cleanly.
• This patch adds no public classes.

[mengxr]

LGTM. Merged into master and branch-1.6. Thanks! (The Jenkins test failure is irrelevant. The PR build doesn't compile doc anyway. So I verified the changes on my local computer.)