From 4be12d97ec4a6ca0acaf324799156e219732a11e Mon Sep 17 00:00:00 2001
From: Matei Zaharia <matei@eecs.berkeley.edu>
Date: Sat, 13 Oct 2012 19:05:11 -0700
Subject: [PATCH] Some doc fixes, including showing version number in nav bar
again
---
.../spark/bagel/examples/WikipediaPageRank.scala | 5 +++++
docs/_config.yml | 3 ++-
docs/_layouts/global.html | 4 +++-
docs/bagel-programming-guide.md | 2 +-
docs/css/main.css | 15 ++++++++++++---
docs/index.md | 8 ++++----
6 files changed, 27 insertions(+), 10 deletions(-)
diff --git a/bagel/src/main/scala/spark/bagel/examples/WikipediaPageRank.scala b/bagel/src/main/scala/spark/bagel/examples/WikipediaPageRank.scala
index f37ee01fd2..03843019c0 100644
--- a/bagel/src/main/scala/spark/bagel/examples/WikipediaPageRank.scala
+++ b/bagel/src/main/scala/spark/bagel/examples/WikipediaPageRank.scala
@@ -8,6 +8,11 @@ import spark.bagel.Bagel._
import scala.xml.{XML,NodeSeq}
+/**
+ * Run PageRank on XML Wikipedia dumps from http://wiki.freebase.com/wiki/WEX. Uses the "articles"
+ * files from there, which contains one line per wiki article in a tab-separated format
+ * (http://wiki.freebase.com/wiki/WEX/Documentation#articles).
+ */
object WikipediaPageRank {
def main(args: Array[String]) {
if (args.length < 5) {
diff --git a/docs/_config.yml b/docs/_config.yml
index 07d068fecb..ad07e3c40d 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -3,6 +3,7 @@ markdown: kramdown
# These allow the documentation to be updated with nerw releases
# of Spark, Scala, and Mesos.
-SPARK_VERSION: 0.6.0-SNAPSHOT
+SPARK_VERSION: 0.6.0
+SPARK_VERSION_SHORT: 0.6.0
SCALA_VERSION: 2.9.2
MESOS_VERSION: 0.9.0-incubating
diff --git a/docs/_layouts/global.html b/docs/_layouts/global.html
index dbae371513..41ad5242c9 100755
--- a/docs/_layouts/global.html
+++ b/docs/_layouts/global.html
@@ -34,7 +34,9 @@
<div class="navbar navbar-fixed-top" id="topbar">
<div class="navbar-inner">
<div class="container">
- <a class="brand" href="index.html"></a>
+ <div class="brand"><a href="index.html">
+ <img src="../img/spark-logo-77x50px-hd.png" /></a><span class="version">{{site.SPARK_VERSION_SHORT}}</span>
+ </div>
<ul class="nav">
<!--TODO(andyk): Add class="active" attribute to li some how.-->
<li><a href="index.html">Overview</a></li>
diff --git a/docs/bagel-programming-guide.md b/docs/bagel-programming-guide.md
index e8d3865d75..8a0fa42d94 100644
--- a/docs/bagel-programming-guide.md
+++ b/docs/bagel-programming-guide.md
@@ -158,4 +158,4 @@ trait Message[K] {
## Where to Go from Here
-Two example jobs, PageRank and shortest path, are included in `bagel/src/main/scala/spark/bagel/examples`. You can run them by passing the class name to the `run` script included in Spark -- for example, `./run spark.bagel.examples.ShortestPath`. Each example program prints usage help when run without any arguments.
+Two example jobs, PageRank and shortest path, are included in `bagel/src/main/scala/spark/bagel/examples`. You can run them by passing the class name to the `run` script included in Spark -- for example, `./run spark.bagel.examples.WikipediaPageRank`. Each example program prints usage help when run without any arguments.
diff --git a/docs/css/main.css b/docs/css/main.css
index f9f5c7f8dd..31122d5633 100755
--- a/docs/css/main.css
+++ b/docs/css/main.css
@@ -3,11 +3,20 @@
========================================================================== */
.navbar .brand {
- background: url(../img/spark-logo-77x50px-hd.png) no-repeat left center;
height: 50px;
- width: 77px;
+ width: 110px;
margin-left: 1px;
- padding: 0 10px 0 0;
+ padding: 0;
+}
+
+.version {
+ line-height: 30px;
+ vertical-align: bottom;
+ font-size: 12px;
+ padding: 0;
+ margin: 0;
+ font-weight: bold;
+ color: #777;
}
.navbar-inner {
diff --git a/docs/index.md b/docs/index.md
index 791be4c097..ed9953a590 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -79,13 +79,13 @@ of `project/SparkBuild.scala`, then rebuilding Spark (`sbt/sbt clean compile`).
**External resources:**
* [Spark Homepage](http://www.spark-project.org)
-* [AMP Camp](http://ampcamp.berkeley.edu/): a two-day training camp at UC Berkeley that featured talks and exercises
- about Spark, Shark, Mesos, and more. [Videos](http://ampcamp.berkeley.edu/agenda-2012),
+* [Mailing List](http://groups.google.com/group/spark-users): ask questions about Spark here
+* [AMP Camp](http://ampcamp.berkeley.edu/): a two-day training camp at UC Berkeley that featured talks and exercises
+ about Spark, Shark, Mesos, and more. [Videos](http://ampcamp.berkeley.edu/agenda-2012),
[slides](http://ampcamp.berkeley.edu/agenda-2012) and [exercises](http://ampcamp.berkeley.edu/exercises-2012) are
available online for free.
* [Code Examples](http://spark-project.org/examples.html): more are also available in the [examples subfolder](https://github.com/mesos/spark/tree/master/examples/src/main/scala/spark/examples) of Spark
-* [Paper describing the Spark system](http://www.cs.berkeley.edu/~matei/papers/2012/nsdi_spark.pdf)
-* [Mailing List](http://groups.google.com/group/spark-users)
+* [Paper Describing the Spark System](http://www.cs.berkeley.edu/~matei/papers/2012/nsdi_spark.pdf)
# Community
--
GitLab