Skip to content

DOC-609 | DOC-670 | Mark 3.10 as deprecated, fix cards and link aliases #512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 15, 2024
Merged

DOC-609 | DOC-670 | Mark 3.10 as deprecated, fix cards and link aliases #512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
949d9e7
Mark 3.10 as deprecated
Simran-B Apr 8, 2024
765932c
DOC-609 | Fix aliasing and deprecation admonition
Simran-B Apr 8, 2024
98f1c3e
DOC-670 | Soft-navigation and version aliases for cards
Simran-B Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/data/versions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
- name: "3.10"
version: "3.10.14"
alias: "3.10"
deprecated: false
deprecated: true
2 changes: 1 addition & 1 deletion site/themes/arangodb-docs-theme/layouts/partials/deprecated.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<i class="fas fa-exclamation-triangle"></i>
<div class="box-text">
<p>ArangoDB v{{ $shortVersion }} reached End of Life (EOL) and is no longer supported.</p>
<p>This documentation is outdated. Please see the most recent <a href="{{ $href }}" class="link">{{ $stableVersion }} version</a>.</p>
<p>This documentation is outdated. Please see the most recent <a href="{{ $href }}" class="link">stable version</a>.</p>
</div>
</div>
</div>
Expand Down
7 changes: 5 additions & 2 deletions site/themes/arangodb-docs-theme/layouts/partials/shortcodes/card.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{{- $context := .context }} {{- $title := .title }} {{- $image := .icon }} {{- $link := .link }} {{-
$content := .Inner }}
{{- $context := .context }}
{{- $title := .title }}
{{- $image := .icon }}
{{- $link := .link }}
{{- $content := .Inner }}

{{ $destinationPage := "" }}
{{ if hasPrefix $link "/" }}
Expand Down
56 changes: 39 additions & 17 deletions site/themes/arangodb-docs-theme/static/js/theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ function closeAllEntries() {

function loadMenu(url) {
closeAllEntries();
var version = getVersionByURL()
var version = getVersionFromURL()

$('.version-menu.'+version).find('a').each(function() {
$(this).attr("href", function(index, old) {
Expand Down Expand Up @@ -146,29 +146,29 @@ function loadNotFoundPage() {
function loadPage(target) {
var href = target;

if (getVersionInfo(getVersionByURL()) == undefined) {
if (getVersionInfo(getVersionFromURL()) == undefined) {
loadNotFoundPage();
return;
}

getCurrentVersion(href);
renderVersion();
loadMenu(new URL(href).pathname);
var version = getVersionInfo(getVersionByURL()).name;
href = href.replace(getVersionByURL(), version);
var version = getVersionInfo(getVersionFromURL()).name;
href = href.replace(getVersionFromURL(), version);
var xhr = new XMLHttpRequest();
$.get({
xhr: function() { return xhr; },
url: href,
success: function(newDoc) {
if (xhr.responseURL && href.replace(/#.*/, "") !== xhr.responseURL) {
updateHistory(xhr.responseURL.replace(version, getVersionByURL()));
updateHistory(xhr.responseURL.replace(version, getVersionFromURL()));
return;
}
if (!newDoc.includes("<body>")) {
// https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/alias.html
var match = /<title>(.*?)<\/title>/.exec(newDoc)[1];
updateHistory(match.replace(version, getVersionByURL()))
updateHistory(match.replace(version, getVersionFromURL()))
return;
}
replaceArticle(href, newDoc)
Expand All @@ -190,7 +190,12 @@ function internalLinkListener() {
}
event.preventDefault();
updateHistory(event.target.getAttribute('href'))
})
});

$('.card-link').click(function(event) {
event.preventDefault();
updateHistory(this.getAttribute('href'))
});
}

function codeShowMoreListener() {
Expand Down Expand Up @@ -222,8 +227,7 @@ function initArticle(url) {
styleImages();
internalLinkListener();
codeShowMoreListener();
aliazeLinks('article', 'a.link:not([target])');
aliazeLinks('article', 'a.header-link');
aliazeLinks('article', 'a.link:not([target]), a.card-link, a.header-link');
aliazeLinks('#breadcrumbs', 'a')
}

Expand Down Expand Up @@ -370,15 +374,33 @@ function getVersionInfo(version) {
return undefined;
}

function getVersionByURL() {
function getVersionFromURL() {
return window.location.pathname.split("/")[1]
}

function isUsingAlias() {
let urlVersion = getVersionFromURL();
for (let v of versions) {
if (urlVersion == v.alias) return true;
}
return false;
}

function aliazeLinks(parentSelector, linkSelector) {
if (!isUsingAlias()) return;
let nameAliasMapping = {};
for (let v of versions) {
nameAliasMapping[v.name] = v.alias;
}

$(parentSelector).find(linkSelector).each(function() {
$(this).attr("href", function(index, old) {
if (old == undefined) return old
return old.replace(old.split("/")[1], getVersionByURL());
if (old == undefined) return old;
let splitLink = old.split("/");
let linkVersion = splitLink[1];
let alias = nameAliasMapping[linkVersion] || linkVersion;
splitLink.splice(1, 1, alias);
return splitLink.join("/");
});
});
}
Expand All @@ -402,7 +424,7 @@ function getCurrentVersion() {
var urlVersion = stableVersion.name

if (window.location.pathname.split("/").length > 0) {
newVersion = getVersionByURL()
newVersion = getVersionFromURL()

if (newVersion === "3.8" || newVersion === "3.9") {
handleOldDocsVersion(newVersion)
Expand Down Expand Up @@ -444,7 +466,7 @@ function changeVersion() {
}


var newUrl = window.location.pathname.replace(getVersionByURL(), getVersionInfo(newVersion).alias) + window.location.hash;
var newUrl = window.location.pathname.replace(getVersionFromURL(), getVersionInfo(newVersion).alias) + window.location.hash;
updateHistory(newUrl);
}

Expand Down Expand Up @@ -533,7 +555,7 @@ const goToTop = (event) => {

function goToHomepage(event){
event.preventDefault();
var homepage = "/" + getVersionByURL() + "/";
var homepage = "/" + getVersionFromURL() + "/";
updateHistory(homepage);
}

Expand Down Expand Up @@ -574,8 +596,8 @@ window.onload = () => {
renderVersion();
loadPage(window.location.href)

if (getVersionInfo(getVersionByURL()) != undefined) {
window.setupDocSearch(getVersionInfo(getVersionByURL()).name);
if (getVersionInfo(getVersionFromURL()) != undefined) {
window.setupDocSearch(getVersionInfo(getVersionFromURL()).name);
} else {
window.setupDocSearch(stableVersion);

Expand Down