4267ca98fa
### What changes were proposed in this pull request? Make the API key of DocSearch configurable and avoid hardcoding in the HTML template ### Why are the changes needed? After https://github.com/apache/spark/pull/30292, our Spark documentation site supports searching. However, the default API key always points to the latest release doc. We have to set different API keys for different releases. Otherwise, the search results are always based on the latest documentation(https://spark.apache.org/docs/latest/) even when visiting the documentation of previous releases. As per discussion in https://github.com/apache/spark/pull/30292#issuecomment-725613417, we should make the API key configurable and set different values for different releases. ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? Manual test Closes #30409 from gengliangwang/apiKey. Authored-by: Gengliang Wang <gengliang.wang@databricks.com> Signed-off-by: Takeshi Yamamuro <yamamuro@apache.org>
224 lines
13 KiB
HTML
Executable file
224 lines
13 KiB
HTML
Executable file
|
|
<!DOCTYPE html>
|
|
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>{{ page.title }} - Spark {{site.SPARK_VERSION_SHORT}} Documentation</title>
|
|
{% if page.description %}
|
|
<meta name="description" content="{{page.description | replace: 'SPARK_VERSION_SHORT', site.SPARK_VERSION_SHORT}}">
|
|
{% endif %}
|
|
|
|
{% if page.redirect %}
|
|
<meta http-equiv="refresh" content="0; url={{page.redirect}}">
|
|
<link rel="canonical" href="{{page.redirect}}" />
|
|
{% endif %}
|
|
|
|
<link rel="stylesheet" href="css/bootstrap.min.css">
|
|
<style>
|
|
body {
|
|
padding-top: 60px;
|
|
padding-bottom: 40px;
|
|
}
|
|
</style>
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="stylesheet" href="css/main.css">
|
|
|
|
<script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script>
|
|
|
|
<link rel="stylesheet" href="css/pygments-default.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
<link rel="stylesheet" href="css/docsearch.css">
|
|
|
|
{% production %}
|
|
<!-- Google analytics script -->
|
|
<script type="text/javascript">
|
|
var _gaq = _gaq || [];
|
|
_gaq.push(['_setAccount', 'UA-32518208-2']);
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
(function() {
|
|
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
|
})();
|
|
</script>
|
|
{% endproduction %}
|
|
|
|
</head>
|
|
<body>
|
|
<!--[if lt IE 7]>
|
|
<p class="chromeframe">You are using an outdated browser. <a href="https://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p>
|
|
<![endif]-->
|
|
|
|
<!-- This code is taken from http://twitter.github.com/bootstrap/examples/hero.html -->
|
|
|
|
<nav class="navbar fixed-top navbar-expand-md navbar-light bg-light" id="topbar">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<div class="navbar-brand"><a href="index.html">
|
|
<img src="img/spark-logo-hd.png" style="height:50px;"/></a><span class="version">{{site.SPARK_VERSION_SHORT}}</span>
|
|
</div>
|
|
</div>
|
|
<button class="navbar-toggler" type="button" data-toggle="collapse"
|
|
data-target="#navbarCollapse" aria-controls="navbarCollapse"
|
|
aria-expanded="false" aria-label="Toggle navigation">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navbarCollapse">
|
|
<ul class="navbar-nav">
|
|
<!--TODO(andyk): Add class="active" attribute to li some how.-->
|
|
<li class="nav-item"><a href="index.html" class="nav-link">Overview</a></li>
|
|
|
|
<li class="nav-item dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle" id="navbarQuickStart" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Programming Guides</a>
|
|
<div class="dropdown-menu" aria-labelledby="navbarQuickStart">
|
|
<a class="dropdown-item" href="quick-start.html">Quick Start</a>
|
|
<a class="dropdown-item" href="rdd-programming-guide.html">RDDs, Accumulators, Broadcasts Vars</a>
|
|
<a class="dropdown-item" href="sql-programming-guide.html">SQL, DataFrames, and Datasets</a>
|
|
<a class="dropdown-item" href="structured-streaming-programming-guide.html">Structured Streaming</a>
|
|
<a class="dropdown-item" href="streaming-programming-guide.html">Spark Streaming (DStreams)</a>
|
|
<a class="dropdown-item" href="ml-guide.html">MLlib (Machine Learning)</a>
|
|
<a class="dropdown-item" href="graphx-programming-guide.html">GraphX (Graph Processing)</a>
|
|
<a class="dropdown-item" href="sparkr.html">SparkR (R on Spark)</a>
|
|
</div>
|
|
</li>
|
|
|
|
<li class="nav-item dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle" id="navbarAPIDocs" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">API Docs</a>
|
|
<div class="dropdown-menu" aria-labelledby="navbarAPIDocs">
|
|
<a class="dropdown-item" href="api/scala/org/apache/spark/index.html">Scala</a>
|
|
<a class="dropdown-item" href="api/java/index.html">Java</a>
|
|
<a class="dropdown-item" href="api/python/index.html">Python</a>
|
|
<a class="dropdown-item" href="api/R/index.html">R</a>
|
|
<a class="dropdown-item" href="api/sql/index.html">SQL, Built-in Functions</a>
|
|
</div>
|
|
</li>
|
|
|
|
<li class="nav-item dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle" id="navbarDeploying" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Deploying</a>
|
|
<div class="dropdown-menu" aria-labelledby="navbarDeploying">
|
|
<a class="dropdown-item" href="cluster-overview.html">Overview</a>
|
|
<a class="dropdown-item" href="submitting-applications.html">Submitting Applications</a>
|
|
<div class="dropdown-divider"></div>
|
|
<a class="dropdown-item" href="spark-standalone.html">Spark Standalone</a>
|
|
<a class="dropdown-item" href="running-on-mesos.html">Mesos</a>
|
|
<a class="dropdown-item" href="running-on-yarn.html">YARN</a>
|
|
<a class="dropdown-item" href="running-on-kubernetes.html">Kubernetes</a>
|
|
</div>
|
|
</li>
|
|
|
|
<li class="nav-item dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle" id="navbarMore" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">More</a>
|
|
<div class="dropdown-menu" aria-labelledby="navbarMore">
|
|
<a class="dropdown-item" href="configuration.html">Configuration</a>
|
|
<a class="dropdown-item" href="monitoring.html">Monitoring</a>
|
|
<a class="dropdown-item" href="tuning.html">Tuning Guide</a>
|
|
<a class="dropdown-item" href="job-scheduling.html">Job Scheduling</a>
|
|
<a class="dropdown-item" href="security.html">Security</a>
|
|
<a class="dropdown-item" href="hardware-provisioning.html">Hardware Provisioning</a>
|
|
<a class="dropdown-item" href="migration-guide.html">Migration Guide</a>
|
|
<div class="dropdown-divider"></div>
|
|
<a class="dropdown-item" href="building-spark.html">Building Spark</a>
|
|
<a class="dropdown-item" href="https://spark.apache.org/contributing.html">Contributing to Spark</a>
|
|
<a class="dropdown-item" href="https://spark.apache.org/third-party-projects.html">Third Party Projects</a>
|
|
</div>
|
|
</li>
|
|
|
|
<li class="nav-item">
|
|
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
|
</li>
|
|
</ul>
|
|
<!--<span class="navbar-text navbar-right"><span class="version-text">v{{site.SPARK_VERSION_SHORT}}</span></span>-->
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="container-wrapper">
|
|
|
|
{% if page.url contains "/ml" or page.url contains "/sql" or page.url contains "migration-guide.html" %}
|
|
{% if page.url contains "migration-guide.html" %}
|
|
{% include nav-left-wrapper-migration.html nav-migration=site.data.menu-migration %}
|
|
{% elsif page.url contains "/ml" %}
|
|
{% include nav-left-wrapper-ml.html nav-mllib=site.data.menu-mllib nav-ml=site.data.menu-ml %}
|
|
{% else %}
|
|
{% include nav-left-wrapper-sql.html nav-sql=site.data.menu-sql %}
|
|
{% endif %}
|
|
<input id="nav-trigger" class="nav-trigger" checked type="checkbox">
|
|
<label for="nav-trigger"></label>
|
|
<div class="content-with-sidebar mr-3" id="content">
|
|
{% if page.displayTitle %}
|
|
<h1 class="title">{{ page.displayTitle }}</h1>
|
|
{% else %}
|
|
<h1 class="title">{{ page.title }}</h1>
|
|
{% endif %}
|
|
|
|
{{ content }}
|
|
|
|
</div>
|
|
{% else %}
|
|
<div class="content mr-3" id="content">
|
|
{% if page.displayTitle %}
|
|
<h1 class="title">{{ page.displayTitle }}</h1>
|
|
{% else %}
|
|
<h1 class="title">{{ page.title }}</h1>
|
|
{% endif %}
|
|
|
|
{{ content }}
|
|
|
|
</div>
|
|
{% endif %}
|
|
<!-- /container -->
|
|
</div>
|
|
|
|
<script src="js/vendor/jquery-3.5.1.min.js"></script>
|
|
<script src="js/vendor/bootstrap.bundle.min.js"></script>
|
|
<script src="js/vendor/anchor.min.js"></script>
|
|
<script src="js/main.js"></script>
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
// DocSearch is entirely free and automated. DocSearch is built in two parts:
|
|
// 1. a crawler which we run on our own infrastructure every 24 hours. It follows every link
|
|
// in your website and extract content from every page it traverses. It then pushes this
|
|
// content to an Algolia index.
|
|
// 2. a JavaScript snippet to be inserted in your website that will bind this Algolia index
|
|
// to your search input and display its results in a dropdown UI. If you want to find more
|
|
// details on how works DocSearch, check the docs of DocSearch.
|
|
{{site.DOCSEARCH_SCRIPT}}
|
|
</script>
|
|
|
|
<!-- MathJax Section -->
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
TeX: { equationNumbers: { autoNumber: "AMS" } }
|
|
});
|
|
</script>
|
|
<script>
|
|
// Note that we load MathJax this way to work with local file (file://), HTTP and HTTPS.
|
|
// We could use "//cdn.mathjax...", but that won't support "file://".
|
|
(function(d, script) {
|
|
script = d.createElement('script');
|
|
script.type = 'text/javascript';
|
|
script.async = true;
|
|
script.onload = function(){
|
|
MathJax.Hub.Config({
|
|
tex2jax: {
|
|
inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ],
|
|
displayMath: [ ["$$","$$"], ["\\[", "\\]"] ],
|
|
processEscapes: true,
|
|
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre']
|
|
}
|
|
});
|
|
};
|
|
script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') +
|
|
'cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js' +
|
|
'?config=TeX-AMS-MML_HTMLorMML';
|
|
d.getElementsByTagName('head')[0].appendChild(script);
|
|
}(document));
|
|
</script>
|
|
</body>
|
|
</html>
|