This is an automated email from the ASF dual-hosted git repository.
pjfanning pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 1f573c9932 docs: remove unused warnOldDocs.js and
projectSpecificFooter template (#3547)
1f573c9932 is described below
commit 1f573c993284158aea9bdd51818b4d6e949c76ab
Author: PJ Fanning <[email protected]>
AuthorDate: Fri Sep 18 14:47:29 2026 +0100
docs: remove unused warnOldDocs.js and projectSpecificFooter template
(#3547)
Motivation:
warnOldDocs.js is the Akka-era "old docs version" banner script. It is
only referenced from _template/projectSpecificFooter.st, a footer hook
that the pekko-theme-paradox page templates never include, so no
generated page loads the script (confirmed on the published site). Even
if it were loaded, it fetches //pekko.io/versions.json, which does not
exist, and its URL parsing does not match the /docs/pekko/<version>/
layout.
Modification:
Delete docs/src/main/paradox/assets/js/warnOldDocs.js and
docs/src/main/paradox/_template/projectSpecificFooter.st.
Result:
Dead docs assets are gone; generated docs are unchanged apart from no
longer shipping the unused script.
Tests:
- Not run locally - docs only; CI builds the docs
References:
None - cleanup of unused Akka-era docs assets
---
.../paradox/_template/projectSpecificFooter.st | 1 -
docs/src/main/paradox/assets/js/warnOldDocs.js | 188 ---------------------
2 files changed, 189 deletions(-)
diff --git a/docs/src/main/paradox/_template/projectSpecificFooter.st
b/docs/src/main/paradox/_template/projectSpecificFooter.st
deleted file mode 100644
index a10db6f4e7..0000000000
--- a/docs/src/main/paradox/_template/projectSpecificFooter.st
+++ /dev/null
@@ -1 +0,0 @@
-<script type="text/javascript"
src="$page.base$assets/js/warnOldDocs.js"></script>
diff --git a/docs/src/main/paradox/assets/js/warnOldDocs.js
b/docs/src/main/paradox/assets/js/warnOldDocs.js
deleted file mode 100644
index 91529c71bc..0000000000
--- a/docs/src/main/paradox/assets/js/warnOldDocs.js
+++ /dev/null
@@ -1,188 +0,0 @@
-jQuery(document).ready(function ($) {
-
- function initOldVersionWarnings($) {
- $.get("//pekko.io/versions.json", function (pekkoVersionsData) {
- var site = extractCurrentPageInfo();
- if (site.v === 'snapshot') {
- showSnapshotWarning(site)
- } else {
- var matchingMinor =
- Object.keys(pekkoVersionsData[site.p])
- .find(function(s) { return site.v.startsWith(s) })
- if (matchingMinor) {
- showVersionWarning(site, pekkoVersionsData, matchingMinor)
- }
- }
- })
- }
-
- function getInstead(pekkoVersionsData, project, instead) {
- if (Array.isArray(instead)) {
- var found = pekkoVersionsData[instead[0]][instead[1]]
- var proj = instead[0]
- } else {
- var found = pekkoVersionsData[project][instead]
- var proj = project
- }
- return {"latest": found.latest, "project": proj}
- }
-
- function targetUrl(samePage, site, instead) {
- var page = site.r
- if (samePage !== true) {
- // FIXME not valid anymore
- if (page.substring(0, 5) == 'scala') {
- page = 'scala.html'
- } else if (page.substring(0, 4) == 'java') {
- page = 'java.html'
- } else {
- page = 'index.html'
- }
- }
- var project = instead.project
- if (!project) {
- project = site.p
- }
- return site.b + project + '/' + instead.latest + '/' + page
- }
-
- function showWarning(site, visitedVersion, text) {
- // sneaking the style in here to make life simple
- $('head').append('<style>' +
- '.page-content .oldVersion.callout .ack-button {' +
- ' display: inline-block;' +
- ' background-color: rgb(255, 83, 75);' +
- 'color: #fff;' +
- ' text-decoration: none;' +
- ' padding: 10px;' +
- '})')
- var $warningPopup = $('<div class="callout warning
oldVersion">').append(text)
- var $close = $('<a href="#" class="ack-button">✓ Dismiss Warning for a
Day</a>')
- .click(function () {
- ackVersionForADay(site.p, visitedVersion)
- $warningPopup.animate({ height: 0 }, 400, "swing", function() {
- $warningPopup.hide()
- })
- })
-
- $warningPopup
- .hide()
- .append($close)
- .prependTo("#docs")
- .show()
- }
-
- function showVersionWarning(site, pekkoVersionsData, series) {
- var version = site.v,
- seriesInfo = pekkoVersionsData[site.p][series]
-
-
- if (versionWasAcked(site.p, version)) {
- // hidden for a day
- } else if (seriesInfo.outdated) {
- var instead = getInstead(pekkoVersionsData, site.p, seriesInfo.instead)
- var insteadSeries = targetUrl(false, site, instead)
- var insteadPage = targetUrl(true, site, instead)
-
- showWarning(
- site,
- version,
- '<h3 class="callout-title">Old Version</h3>' +
- '<p><span style="font-weight: bold">This version of Pekko (' + site.p
+ ' / ' + version + ') is outdated and not supported! </span></p>' +
- '<p>Please upgrade to version <a href="' + insteadSeries + '">' +
instead.latest + '</a> as soon as possible.</p>' +
- '<p id="samePageLink"></p>')
-
- $.ajax({
- url: insteadPage,
- type: 'HEAD',
- success: function () {
- $('#samePageLink').html('<a href="' + insteadPage + '">Click here to
go to the same page on the ' + instead.latest + ' version of the docs.</a>');
- }
- });
- } else if (version == series) {
- // The series already points to the latest version in that series
- } else if (version != seriesInfo.latest) {
- showWarning(
- site,
- version,
- '<h3 class="callout-title">Outdated version</h3>' +
- '<p>You are browsing the docs for Pekko ' + version + ', however the
latest release in this series is: ' +
- '<a href="' + targetUrl(true, site, seriesInfo) + '">' +
seriesInfo.latest + '</a>. <br/></p>');
- }
- }
-
- function showSnapshotWarning(site) {
- if (!versionWasAcked(site.p, 'snapshot')) {
- var instead = {'latest': 'current'};
- var insteadSeries = targetUrl(false, site, instead);
- var insteadPage = targetUrl(true, site, instead);
-
- showWarning(
- site,
- 'snapshot',
- '<h3 class="callout-title">Snapshot docs</h3>' +
- '<p><span style="font-weight: bold">You are browsing the snapshot
documentation, which most likely does not correspond to the artifacts you are
using! </span></p>' +
- '<p>We recommend that you head over to <a href="' + insteadSeries +
'">the latest stable version</a> instead.</p>' +
- '<p id="samePageLink"></p>')
- $.ajax({
- url: insteadPage,
- type: 'HEAD',
- success: function () {
- $('#samePageLink').html('<a href="' + insteadPage + '">Click here to
go to the same page on the latest stable version of the docs.</a>');
- }
- })
- }
- }
-
-
- function extractCurrentPageInfo() {
- var path = window.location.pathname,
- base = '' + window.location
-
- // strip off leading /docs/
- path = path.substring(path.indexOf("pekko"))
- base = base.substring(0, base.indexOf(path))
- var projectEnd = path.indexOf("/")
- var versionEnd = path.indexOf("/", projectEnd + 1)
- var project = path.substring(0, projectEnd)
- var version = path.substring(projectEnd + 1, versionEnd)
- var rest = path.substring(versionEnd + 1)
- return {"b": base, "p": project, "v": version, "r": rest}
- }
-
-
-// --- ack outdated versions ---
-
- function ackVersionCookieName(project, version) {
- return "ack-" + project + "-" + version
- }
-
- function ackVersionForADay(project, version) {
- function setCookie(cname, cvalue, exdays) {
- var d = new Date()
- d.setTime(d.getTime() + (exdays * 24 * 60 * 60 * 1000))
- var expires = "expires=" + d.toUTCString()
- document.cookie = cname + "=" + cvalue + "; " + expires
- }
-
- setCookie(ackVersionCookieName(project, version), 'true', 1)
- }
-
- function versionWasAcked(project, version) {
- function getCookie(cname) {
- var name = cname + "="
- var ca = document.cookie.split(';')
- for (var i = 0; i < ca.length; i++) {
- var c = ca[i];
- while (c.charAt(0) == ' ') c = c.substring(1)
- if (c.indexOf(name) == 0) return c.substring(name.length, c.length)
- }
- return ""
- }
-
- return getCookie(ackVersionCookieName(project, version)) === 'true';
- }
-
-
- initOldVersionWarnings($)
-})
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
