Skip to content

Commit 5a791e3

Browse files
foxishfoxish
authored
Initial docs push (#1)
* Added TOC Removed redundant headers Added links * added contribute.md * Adding gemfile for netlify * remove extra heading
1 parent 2fbf604 commit 5a791e3

File tree

6 files changed

+660
-60
lines changed

6 files changed

+660
-60
lines changed

‎Gemfile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# frozen_string_literal: true
2+
source "https://rubygems.org"
3+
4+
gem "jekyll"
5+
gem "jekyll-toc"
6+
gem "jekyll-watch"
7+
gem "jekyll-redirect-from"

‎src/jekyll/_config.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ highlighter: pygments
22
markdown: kramdown
33
gems:
44
- jekyll-redirect-from
5+
- jekyll-toc
6+
- jekyll-watch
57

68
# For some reason kramdown seems to behave differently on different
79
# OS/packages wrt encoding. So we hard code this config.
@@ -14,10 +16,9 @@ include:
1416

1517
# These allow the documentation to be updated with newer releases
1618
# of Spark, Scala, and Mesos.
17-
SPARK_VERSION: 2.1.2-SNAPSHOT
18-
SPARK_VERSION_SHORT: 2.1.2
19+
SPARK_VERSION: 2.1.0-SNAPSHOT
20+
SPARK_VERSION_SHORT: 2.1.0
1921
SCALA_BINARY_VERSION: "2.11"
2022
SCALA_VERSION: "2.11.8"
21-
MESOS_VERSION: 1.0.0
2223
SPARK_ISSUE_TRACKER_URL: https://issues.apache.org/jira/browse/SPARK
2324
SPARK_GITHUB_URL: https://github.com/apache/spark

‎src/jekyll/_layouts/global.html

+1-56
Original file line numberDiff line numberDiff line change
@@ -49,59 +49,6 @@
4949
<ul class="nav">
5050
<!--TODO(andyk): Add class="active" attribute to li some how.-->
5151
<li><a href="index.html">Overview</a></li>
52-
53-
<li class="dropdown">
54-
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Programming Guides<b class="caret"></b></a>
55-
<ul class="dropdown-menu">
56-
<li><a href="quick-start.html">Quick Start</a></li>
57-
<li><a href="programming-guide.html">Spark Programming Guide</a></li>
58-
<li class="divider"></li>
59-
<li><a href="streaming-programming-guide.html">Spark Streaming</a></li>
60-
<li><a href="sql-programming-guide.html">DataFrames, Datasets and SQL</a></li>
61-
<li><a href="structured-streaming-programming-guide.html">Structured Streaming</a></li>
62-
<li><a href="ml-guide.html">MLlib (Machine Learning)</a></li>
63-
<li><a href="graphx-programming-guide.html">GraphX (Graph Processing)</a></li>
64-
<li><a href="sparkr.html">SparkR (R on Spark)</a></li>
65-
</ul>
66-
</li>
67-
68-
<li class="dropdown">
69-
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs<b class="caret"></b></a>
70-
<ul class="dropdown-menu">
71-
<li><a href="api/scala/index.html#org.apache.spark.package">Scala</a></li>
72-
<li><a href="api/java/index.html">Java</a></li>
73-
<li><a href="api/python/index.html">Python</a></li>
74-
<li><a href="api/R/index.html">R</a></li>
75-
</ul>
76-
</li>
77-
78-
<li class="dropdown">
79-
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Deploying<b class="caret"></b></a>
80-
<ul class="dropdown-menu">
81-
<li><a href="cluster-overview.html">Overview</a></li>
82-
<li><a href="submitting-applications.html">Submitting Applications</a></li>
83-
<li class="divider"></li>
84-
<li><a href="spark-standalone.html">Spark Standalone</a></li>
85-
<li><a href="running-on-mesos.html">Mesos</a></li>
86-
<li><a href="running-on-yarn.html">YARN</a></li>
87-
</ul>
88-
</li>
89-
90-
<li class="dropdown">
91-
<a href="api.html" class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a>
92-
<ul class="dropdown-menu">
93-
<li><a href="configuration.html">Configuration</a></li>
94-
<li><a href="monitoring.html">Monitoring</a></li>
95-
<li><a href="tuning.html">Tuning Guide</a></li>
96-
<li><a href="job-scheduling.html">Job Scheduling</a></li>
97-
<li><a href="security.html">Security</a></li>
98-
<li><a href="hardware-provisioning.html">Hardware Provisioning</a></li>
99-
<li class="divider"></li>
100-
<li><a href="building-spark.html">Building Spark</a></li>
101-
<li><a href="http://spark.apache.org/contributing.html">Contributing to Spark</a></li>
102-
<li><a href="http://spark.apache.org/third-party-projects.html">Third Party Projects</a></li>
103-
</ul>
104-
</li>
10552
</ul>
10653
<!--<p class="navbar-text pull-right"><span class="version-text">v{{site.SPARK_VERSION_SHORT}}</span></p>-->
10754
</div>
@@ -131,9 +78,7 @@ <h1 class="title">{{ page.displayTitle }}</h1>
13178
{% else %}
13279
<h1 class="title">{{ page.title }}</h1>
13380
{% endif %}
134-
135-
{{ content }}
136-
81+
{{ content | toc }}
13782
</div>
13883
{% endif %}
13984
<!-- /container -->

‎src/jekyll/contribute.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: global
3+
displayTitle: Contribute to Apache Spark on Kubernetes
4+
title: Contribute to Apache Spark on Kubernetes
5+
description: Contribute to Apache Spark on Kubernetes
6+
---
7+
8+
### Project Contributions
9+
10+
This is a collaborative effort completely in the open source community, involving several folks from
11+
different companies who are interested in seeing this feature successfully completed and merged.
12+
Companies currently active in this project include (alphabetically):
13+
14+
* Google
15+
* Haiwen
16+
* Hyperpilot
17+
* Intel
18+
* Palantir
19+
* Pepperdata
20+
* Red Hat
21+
22+
This effort is part of [SIG Big Data](https://github.com/kubernetes/community/tree/master/sig-big-data),
23+
a special interest group in the Kubernetes project dealing with building solutions and expertise around
24+
data processing applications like Apache Spark.
25+
26+
### Get Involved
27+
28+
Join us on #sig-big-data on slack at [kubernetes-slack](https://kubernetes.slack.com). Invites are
29+
self-serve and available through [http://slack.k8s.io](http://slack.k8s.io).
30+
31+
Weekly meetings are held via [Zoom](http://zoom.us/my/sig.big.data) at 10am PST on Wednesdays,
32+
are 45 minutes - 1 hour long, and are recorded. Join the official mailing list at
33+
[SIG Big Data - Google Group](https://groups.google.com/forum/#!forum/kubernetes-sig-big-data) to
34+
receive an invite.
35+
36+
<!---
37+
TODO: add link to roadmap and design docs
38+
-->
39+

‎src/jekyll/index.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,19 @@ description: User Documentation for Apache Spark on Kubernetes
77

88
### Overview
99

10-
This site is for user documentation for running Apache Spark with a native Kubernetes scheduling backend.
10+
This site is for user documentation for running Apache Spark with a native Kubernetes scheduling backend.
11+
This repository [apache-spark-on-k8s/spark](https://github.com/apache-spark-on-k8s/spark),
12+
contains a fork of Apache Spark that enables running Spark jobs natively on a Kubernetes cluster.
13+
14+
### What is this?
15+
16+
This is a collaboratively maintained project working on
17+
[SPARK-18278](https://issues.apache.org/jira/browse/SPARK-18278).
18+
The goal is to bring native support for Spark to use Kubernetes as a cluster manager,
19+
in a fully supported way on par with the Spark Standalone, Mesos, and Apache YARN cluster managers.
20+
21+
22+
### Contents
23+
24+
* [Running Spark on Kubernetes](./running-on-kubernetes.html)
25+
* [Contribute](./contribute.html)

0 commit comments

Comments
 (0)