mirror of
https://github.com/hanzo-ml/spark-operator.git
synced 2026-10-30 20:39:07 +00:00
4879adacdb
* new local website docs Signed-off-by: vara-bonthu <[email protected]> * homepage UX: ribbon logo, architecture diagram, CNCF footer, code-block fixes Signed-off-by: vara-bonthu <[email protected]> * docs: favicon, social cards, image optimization, consistent paragraph sizing Signed-off-by: vara-bonthu <[email protected]> * Potential fix for pull request finding Signed-off-by: Vara Bonthu <[email protected]> * docs: address PR review feedback (brand link, storage guard, cron, typos) Signed-off-by: vara-bonthu <[email protected]> * docs: address PR review (spec.mode, jar typo, CSS @import order, external-link host check, brand-link fallback) + strict docs build gate Signed-off-by: vara-bonthu <[email protected]> * docs: embed Kubeflow Spark Operator intro video on homepage Signed-off-by: vara-bonthu <[email protected]> * docs: clarify homepage video is the CNCF KubeCon NA 2024 best-practices talk Signed-off-by: vara-bonthu <[email protected]> * docs: fix header logo opening homepage in a new tab (exclude brand link from external-link handling) Signed-off-by: vara-bonthu <[email protected]> * docs: fix header logo navigation and point Kubeflow.org links to kubeflow.org Signed-off-by: vara-bonthu <[email protected]> * ci: add documentation build and link-check workflow Signed-off-by: vara-bonthu <[email protected]> * ci(docs): make linkcheck non-blocking; fix broken links and ignore JS-rendered anchors Signed-off-by: vara-bonthu <[email protected]> * docs: fix benchmarking links (Data on EKS benchmark kit and contributor handle) Signed-off-by: vara-bonthu <[email protected]> * docs: refine homepage copy and add muted color accents to landing cards Signed-off-by: vara-bonthu <[email protected]> * docs: move website under docs/website and manage Python deps with uv - Move the Sphinx site from docs/ to docs/website/ - Replace requirements.txt with pyproject.toml (uv 'docs' group) and uv.lock - Build with uv in Read the Docs, the Makefile targets, and CI - Leave pre-existing docs/{api-docs,kustomize-installation,release}.md in place Signed-off-by: vara-bonthu <[email protected]> * docs: improve sidebar navigation readability and hierarchy Signed-off-by: vara-bonthu <[email protected]> --------- Signed-off-by: vara-bonthu <[email protected]> Signed-off-by: Vara Bonthu <[email protected]> Co-authored-by: Hanzo Dev <[email protected]>
29 lines
1.1 KiB
JavaScript
29 lines
1.1 KiB
JavaScript
// Point the ribbon brand/logo at the documentation root *relative to the current
|
|
// page*, so it works under any hosting base path — Read the Docs (/en/latest/),
|
|
// a GitHub Pages project subpath (/spark-operator/), or a local build — without
|
|
// hardcoding an absolute URL. Sphinx (>= 7.2) exposes the per-page root via the
|
|
// `data-content_root` attribute on the <html> element; older versions expose it
|
|
// via DOCUMENTATION_OPTIONS.URL_ROOT.
|
|
document.addEventListener("DOMContentLoaded", function () {
|
|
var brand = document.querySelector(".top-nav-brand");
|
|
if (!brand) return;
|
|
|
|
var root = null;
|
|
var el = document.querySelector("[data-content_root]");
|
|
if (el) {
|
|
root = el.getAttribute("data-content_root");
|
|
} else if (
|
|
typeof DOCUMENTATION_OPTIONS !== "undefined" &&
|
|
DOCUMENTATION_OPTIONS.URL_ROOT != null
|
|
) {
|
|
root = DOCUMENTATION_OPTIONS.URL_ROOT;
|
|
}
|
|
if (!root) root = "./";
|
|
if (root.charAt(root.length - 1) !== "/") root += "/";
|
|
|
|
brand.setAttribute("href", root + "index.html");
|
|
// It is internal navigation — ensure it stays in the same tab.
|
|
brand.removeAttribute("target");
|
|
brand.removeAttribute("rel");
|
|
});
|