- These are the docs for Metabase {{ page.version }}. - Check out the docs for the current stable version, Metabase {{site.docs_version}}. -+ {% assign support = site.data.version_support[page.version] %} + {% if support.status == "unsupported" %} +
+ Version {{ page.version }} of Metabase is no longer supported. Check out the docs for the current stable version, Metabase {{site.docs_version}}. ++ {% else %} +
+ These are the docs for Metabase {{ page.version }}. + Check out the docs for the current stable version, Metabase {{site.docs_version}}. ++ {% endif %} {% endif %} {% endif %} diff --git a/_includes/docs_version.html b/_includes/docs_version.html index 39337249a4..90034590c0 100644 --- a/_includes/docs_version.html +++ b/_includes/docs_version.html @@ -13,9 +13,19 @@
+ Version {{ page.version }} of Metabase is no longer supported. + Check out the docs for the current stable version, Metabase {{site.docs_version}}. ++ {% endif %} + {{ content }} diff --git a/_plugins/jekyll_version_support_plugin.rb b/_plugins/jekyll_version_support_plugin.rb new file mode 100644 index 0000000000..8b1b4c8345 --- /dev/null +++ b/_plugins/jekyll_version_support_plugin.rb @@ -0,0 +1,77 @@ +# Builds `site.data.version_support`, a lookup table of support status keyed by +# the version strings used throughout the site ("v0.63", "v0.57", ...). +# +# The source data is _data/major_version_support.json, refreshed nightly from +# the `major_version_support` key of https://static.metabase.com/version-info.json +# by .github/workflows/update-version-support.yml +# +# Templates just look a version up: +# +# {% assign support = site.data.version_support[page.version] %} +# {% if support.status == "unsupported" %}...{% endif %} +# {% if support.lts %}...{% endif %} +# +# The data file only tracks the most recent majors, so anything older than the +# oldest tracked major is unsupported. Versions with no entry and no verdict +# (such as "latest" and "master") are simply absent from the table, and a +# missing key renders as nil in Liquid — so callers need no special casing. +module Jekyll + class VersionSupportGenerator < Generator + safe true + priority :high + + SUPPORTED = "supported".freeze + UNSUPPORTED = "unsupported".freeze + + def generate(site) + entries = site.data["major_version_support"] || [] + by_major = entries.each_with_object({}) do |entry, acc| + major = entry["major"] + acc[major.to_i] = entry if major + end + + oldest_tracked = by_major.keys.min + today = site.time.to_date + + site.data["version_support"] = Array(site.config["available_versions"]) + .each_with_object({}) do |version, acc| + major = major_of(version) + status = status_for(major, by_major, oldest_tracked, today) + next if status.nil? + + acc[version] = { + "status" => status, + "lts" => by_major.dig(major, "lts") || false, + } + end + end + + private + + # "v0.63" -> 63 + def major_of(version) + version.to_s[/\Av\d+\.(\d+)\z/, 1]&.to_i + end + + def status_for(major, by_major, oldest_tracked, today) + return nil if major.nil? + + entry = by_major[major] + return UNSUPPORTED if entry.nil? && oldest_tracked && major < oldest_tracked + return nil if entry.nil? + + eol = parse_date(entry["eol"]) + return SUPPORTED if eol.nil? + + eol <= today ? UNSUPPORTED : SUPPORTED + end + + def parse_date(value) + return value.to_date if value.respond_to?(:to_date) && !value.is_a?(String) + + Date.parse(value.to_s) + rescue ArgumentError, TypeError + nil + end + end +end diff --git a/all.md b/all.md index 0a4b55df6c..ae718b8603 100644 --- a/all.md +++ b/all.md @@ -11,7 +11,10 @@ We version our docs for every major release, with docs for each major release co For product releases, see the list of [Metabase releases](https://github.com/metabase/metabase/releases). +Versions marked unsupported have passed their end-of-life date. See our [version support policy](/version-support) for details. + {% for version in site.available_versions reversed %} +{% assign support = site.data.version_support[version] %} -- [{{ version }}](/docs/{{ version }}/) +- [{{ version }}](/docs/{{ version }}/){% if support.status == "unsupported" %} unsupported{% elsif support.lts %} lts{% endif %} {% endfor %} diff --git a/docs/docs-local.css b/docs/docs-local.css new file mode 100644 index 0000000000..a8b2d7acca --- /dev/null +++ b/docs/docs-local.css @@ -0,0 +1,55 @@ +/* because stylesheets mainly live in the marketing repo, this is a subset of the styles + * that are specific to this repo, pending a larger refactor to move all docs-specific styles into this repo. */ + +.bootstrap .learn .version__dropdown { + width: auto !important; + + .version__dropdown--item { + align-items: center; + display: flex; + flex-wrap: nowrap; + gap: 0.5rem; + justify-content: space-between; + padding-inline: 1rem; + text-align: left; + } +} + +.version__tag { + border-radius: 4px; + font-size: 10px; + font-weight: 700; + letter-spacing: 0.02em; + line-height: 1; + padding: 3px 5px; + text-transform: uppercase; +} + +.version__tag--unsupported { + background-color: #f1f2f4; + color: #5a6072; +} + +.version__tag--lts { + background-color: #f3faec; + color: #669438; +} + +/* Notice on docs for versions past their EOL date. The `.docs` ancestor is + * present in both the current and legacy layouts, and matches the specificity + * of the blockquote rules in css/styles.css and css/docs.css — this file wins + * the tie because it's the last stylesheet in the head. */ +.docs blockquote.version-unsupported-notice { + background-color: #fef9e6; + border: 1px solid #f7be08; + border-radius: 0.625rem; + color: #4c5773; + font-size: 14px; + line-height: 1.5; + margin: 1.5rem 0; + padding: 0.75rem 1rem; +} + +.docs blockquote.version-unsupported-notice a { + display: inline; +}