Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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 src/current/.bundle/config
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
BUNDLE_PATH: "vendor/bundle"
BUNDLE_DEPLOYMENT: "false"
BUNDLE_WITHOUT: "production"
BUNDLE_BUILD__CBOR: "--with-cflags=-Wno-incompatible-function-pointer-types"
BUNDLE_BUILD__POSIX___SPAWN: "--with-cflags=-Wno-incompatible-function-pointer-types"
BUNDLE_WITHOUT: "production"
5 changes: 5 additions & 0 deletions src/current/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ gem "redcarpet", "~> 3.6"
gem "rss"
gem "webrick"
gem "jekyll-minifier"
gem 'csv'
gem 'logger'
gem 'base64'
gem 'bigdecimal'
gem 'mutex_m'

group :jekyll_plugins do
gem "jekyll-include-cache"
Expand Down
11 changes: 11 additions & 0 deletions src/current/_includes/corestyle.scss
Original file line number Diff line number Diff line change
Expand Up @@ -1064,6 +1064,16 @@ div#feature-highlights .feature-description {
}
}


.sidebar__tag--new {
background: #6933ff;
color: #fff;
font-size: 10px;
padding: 2px 6px;
border-radius: 4px;
margin-left: 8px;
}

.roles-table {
table {
width: 100%; // Let the table stretch to the full container width
Expand Down Expand Up @@ -1104,3 +1114,4 @@ div#feature-highlights .feature-description {
width: 1%; // Hint browser to minimize these columns if possible
}
}

8 changes: 8 additions & 0 deletions src/current/_includes/sidebar-all-releases.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,12 @@
"urls": [
"/releases/unsupported-versions.html"
]
},
{
"title": "Archived Documentation",
"tag": "NEW",
"urls": [

"/releases/archived-documentation.html"
]
}
35 changes: 19 additions & 16 deletions src/current/_includes/sidebar.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
// source for the underlying version, like v1.0 or v1.1.
// Otherwise, the sidebar for a `stable` page would
// inappropriately link to the underlying `v1.0` page instead
// of the `stable` alias.
const pageVersion = (function () {
const pathComponents = location.pathname
.replace(sidebar.baseUrl, '')
Expand Down Expand Up @@ -89,7 +88,7 @@
// entry, if any, into the `.collapsed-header` element above.
function renderItems(items, paths) {
if (!items || items.length == 0)
return $();
return $();

const lis = items.map(function (item) {
const urls = (item.urls || []).map(function (url) {
Expand All @@ -103,20 +102,13 @@
});

// this ensures page will be highlighted in sidebar if URL is accessed with or without `.html` appended
var activePathname
if (!/^https?:/.test(location.pathname)) {
activePathname = location.pathname
var activePathname = location.pathname;
if (activePathname.includes("/index.html")) {
activePathname = activePathname.replace("/index.html", "/");
}
else {
activePathname = location.pathname
if (activePathname.includes(".html")) {
activePathname = activePathname.replace(".html", "");
}
if (location.pathname.includes("/index.html")) {
activePathname = activePathname.replace("/index.html", "/")
}
if (location.pathname.includes(".html")) {
activePathname = activePathname.replace(".html", "")
}
// console.log(urls);

const active = (urls.indexOf(activePathname) !== -1);
if (active) {
Expand All @@ -136,8 +128,19 @@
.attr("href", urls[0] || "#")
.html(item.title);

// ── **INJECT TAG BADGE HERE** ─────────────────────────
if (item.tag) {
a.append(" ")
.append(
$("<span>")
.addClass("sidebar__tag sidebar__tag--new")
.text(item.tag)
);
}
// ──────────────────────────────────────────────────────

if (subitems.length > 0 && !item.is_top_level) {
a.append(" ").append($("<div>").addClass("nav-expand"));
a.append(" ").append($("<div>").addClass("nav-expand"));
}

return $("<li>")
Expand Down Expand Up @@ -165,7 +168,7 @@
// Version directories either are one of the named version
// aliases specified in _config.yml or have the form "vX.X",
// like "v1.0" or "v1.10".
return {{ site.versions | jsonify }}[d] || /^v\d+.\d+$/.test(d);
return {{ site.versions | jsonify }}[d] || /^v\d+\.\d+$/.test(d);
},
items: {%- include_cached {{ include.sidebar_data }} -%}
};
Expand Down
96 changes: 96 additions & 0 deletions src/current/releases/archived-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Archived Documentation
summary: Documentation for CockroachDB versions that are no longer actively maintained

toc: false # hide “On this page” nav
docs_area: releases
---

<!-- ✨ page-level style overrides -->
<style>
/* headline spacing */
h1 { margin-bottom: 1.75rem; }

/* section heading spacing */
h2 { margin-top: 3rem; margin-bottom: 1.25rem; }

/* selector card */
.archived-card {
background: #f6f7f8;
border: 1px solid #e6e6e6;
border-radius: 6px;
padding: 1.5rem 1.75rem 2rem;
}
/* spacing inside selector card */
.archived-card label { display:block; font-weight:600; margin-bottom:.5rem; }
.archived-card select { width:100%; font-size:1rem; padding:.65rem .75rem; }
.archived-card button { width:100%; margin-top:1.25rem; }

/* primary button (CRDB purple) */
button.button-primary,
button.button-primary:visited {
background:#6933ff;
color:#fff;
font-weight:500;
border:0;
border-radius:4px;
padding:.65rem 1rem;
}
button.button-primary:hover { background:#5f30e2; }

/* table styling */
table { width:100%; border-collapse:collapse; margin-top:1rem; }
th, td { padding:.75rem 1rem; text-align:left; }
thead th { background:#f6f7f8; font-weight:600; }
tbody tr:nth-child(even) { background:#fafafa; }

/* status pill */
.version-pill { border-radius:12px; padding:.2rem .65rem; font-size:.75rem; font-weight:500; }
.version-archived { background:#fde6e2; color:#b53b1b; }

/* download links */
.download-link { color:#6933ff; font-weight:500; text-decoration:none; }
.download-link:hover { text-decoration:underline; }
</style>

Access documentation for previous versions of CockroachDB that are no longer actively maintained.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest update to "This page contains downloads of archived documentation for CockroachDB versions that are no longer supported"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please update this to say "This page contains downloads of archived documentation for CockroachDB versions that are no longer supported"


{{ site.data.alerts.callout_info }}
CockroachDB recommends using the most recent version for the best experience and most up-to-date documentation. Archived documentation is provided **as-is** and is no longer actively maintained.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest update to the following:

Cockroach Labs recommends using a [supported version]({% link {{ page.version.version }}/releases/release-support-policy.md %}) of CockroachDB for which documentation is actively maintained. The archived documentation on this page is provided **as-is** and is no longer maintained.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update this to use the text i wrote in my previous comment

{{ site.data.alerts.end }}

## Select a Version
Choose a version to view its archived documentation:

<div class="archived-card" markdown="1">
<label for="version-select">Version:</label>
<select id="version-select" class="filter-select">
<option value="" disabled selected>Select a version</option>
<optgroup label="Major Releases">
<option value="v19.2">v19.2 (Archived)</option>
</optgroup>
</select>

<button type="button" class="button-primary">View Documentation</button>
</div>

## All Archived Versions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest changing the header and first line of text as follows:

## Archived versions

The table below contains links to archived documentation for versions of CockroachDB that are [no longer supported]({% link {{ page.version.version }}/releases/release-support-policy.md %}#unsupported-versions).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please update the header and text as described in my previous comment

Browse the full list of archived CockroachDB versions:

<div class="wide-overflow" markdown="1">

<table>
<thead>
<tr><th>Version</th><th>Release Date</th><th>EOL Date</th><th>Status</th><th>Downloads</th></tr>
</thead>
<tbody>
<tr><td><strong>v19.2</strong></td><td>November 2019</td><td>May 2021</td>
<td><span class="version-pill version-archived">Archived</span></td>
<td><a href="https://storage.googleapis.com/crdbdocs-archive/archive_19.2.zip" class="download-link">ZIP</a></td></tr>
</tbody>
</table>

</div>

## Looking for Current Documentation?
Visit our [current documentation](/docs/stable/) for the latest CockroachDB versions.
Loading