Skip to content

Commit 3d59ced

Browse files
sarahssarahs
authored
Merge pull request #16770 from github/list-of-deprecated-versions
Enterprise Server releases page
2 parents b7739ec + a3f55d3 commit 3d59ced

7 files changed

Lines changed: 96 additions & 3 deletions

File tree

‎data/ui.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ contribution_cta:
6666
button: Make a contribution
6767
or: Or,
6868
to_guidelines: learn how to contribute.
69+
enterprise_releases_list:
70+
title: Enterprise Server Releases
71+
currently_supported: Currently supported
72+
currently_supported_message: See <a href="https://github.com/enterprise">GitHub Enterprise</a> for information about the latest release.
73+
deprecated: Deprecated
74+
deprecated_message: 'These docs remain available but are no longer maintained:'
75+
deprecated_developer: Deprecated on developer.github.com
76+
deprecated_developer_message: 'These docs remain available on the legacy <a href="https://developer.github.com">developer site</a> but are no longer maintained:'
6977
products:
7078
graphql:
7179
reference:

‎includes/article-version-switcher.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% if page.permalinks and page.permalinks.length > 1 %}
2-
<details class="dropdown-withArrow d-inline-block details details-reset mb-4 position-relative close-when-clicked-outside article-versions">
2+
<details class="dropdown-withArrow d-inline-block details details-reset mb-1 position-relative close-when-clicked-outside article-versions">
33
<summary class="d-flex flex-items-center flex-justify-between f4 h5-mktg btn-outline-mktg btn-mktg p-2">
44
<!-- GitHub.com, Enterprise Server 2.16, etc -->
55
<span class="d-md-none d-xl-inline-block mr-1">{% data ui.pages.article_version %}</span> {{ allVersions[currentVersion].versionTitle }}
@@ -14,6 +14,7 @@
1414
>
1515
{{ allVersions[permalink.pageVersion].versionTitle }}</a>
1616
{% endfor %}
17+
<a class="f6 no-underline text-gray-light pt-1" href="/enterprise-server-releases">See all Enterprise releases</a>
1718
</div>
1819
</details>
1920
{% endif %}

‎includes/head.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<head>
22
<meta charset="utf-8" />
3-
<title>{% if error == '404' %}{% data ui.errors.oops %}{% elsif currentVersion == 'homepage' %}GitHub Documentation{% else %}{{ page.fullTitle }}{% endif %}</title>
3+
<title>{% if error == '404' %}{% data ui.errors.oops %}{% elsif currentVersion == 'homepage' %}GitHub Documentation{% elsif page.fullTitle %}{{ page.fullTitle }}{% else %}GitHub Documentation{% endif %}</title>
44
<meta name="viewport" content="width=device-width, initial-scale=1">{% if page.hidden %}
55
<meta name="robots" content="noindex" />{% endif %}
66
<meta name="google-site-verification" content="OgdQc0GZfjDI52wDv1bkMT-SLpBUo_h5nn9mI9L22xQ" />

‎layouts/enterprise-server-releases.html‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!doctype html>
2+
<html lang="{{currentLanguage}}">
3+
{% include head %}
4+
5+
<body class="d-lg-flex">
6+
{% include sidebar %}
7+
8+
<main class="width-full">
9+
<main class="container-xl px-3 px-md-6 my-4 my-lg-4 d-xl-flex">
10+
<article class="markdown-body width-full">
11+
<div class="d-lg-flex flex-justify-between"></div>
12+
13+
<div class="mt-2 article-grid-container">
14+
15+
<div class="article-grid-head">
16+
<div class="d-flex flex-items-baseline flex-justify-between mt-3">
17+
<h1 class="border-bottom-0">{% data ui.enterprise_releases_list.title %}</h1>
18+
</div>
19+
</div>
20+
<div class="article-grid-toc border-bottom border-xl-0 pb-4 mb-5 pb-xl-0 mb-xl-0">
21+
<div class="article-grid-toc-content">
22+
{% if miniTocItems.size > 1 %}
23+
<h3 id="in-this-article" class="f5 mb-2"><a class="link-gray-dark" href="#in-this-article">{% data ui.pages.miniToc %}</a></h3>
24+
<ul class="list-style-none pl-0 f5 mb-0">
25+
{% for item in miniTocItems %}
26+
<li class="ml-{{ item.indentationLevel | times: 3 }} mb-2 lh-condensed">{{ item.contents }}</li>
27+
{% endfor %}
28+
</ul>
29+
{% endif %}
30+
</div>
31+
</div>
32+
<div id="article-contents" class="article-grid-body">
33+
<h2 id="currently-supported"><a href="#currently-supported">{% data ui.enterprise_releases_list.currently_supported %}</a></h2>
34+
<p>{% data ui.enterprise_releases_list.currently_supported_message %}</p>
35+
<ul>
36+
{% for version in enterpriseServerReleases.supported %}
37+
<li><a href="/{{currentLanguage}}/enterprise-server@{{version}}">Enterprise Server {{version}}</a></li>
38+
{% endfor %}
39+
</ul>
40+
<h2 id="deprecated"><a href="#deprecated">{% data ui.enterprise_releases_list.deprecated %}</a></h2>
41+
<p>{% data ui.enterprise_releases_list.deprecated_message %}</p>
42+
<ul>
43+
{% for version in enterpriseServerReleases.deprecatedReleasesWithNewFormat %}
44+
<li><a href="/{{currentLanguage}}/enterprise-server@{{version}}">Enterprise Server {{version}}</a></li>
45+
{% endfor %}
46+
{% for version in enterpriseServerReleases.deprecatedReleasesWithLegacyFormat %}
47+
<li><a href="/{{currentLanguage}}/enterprise/{{version}}">Enterprise Server {{version}}</a></li>
48+
{% endfor %}
49+
</ul>
50+
<h2 id="deprecated-on-developer.github.com"><a href="#deprecated-on-developer.github.com">{% data ui.enterprise_releases_list.deprecated_developer %}</a></h2>
51+
<p>{% data ui.enterprise_releases_list.deprecated_developer_message %}</p>
52+
{% for version in enterpriseServerReleases.deprecatedReleasesOnDeveloperSite %}
53+
<li><a href="https://developer.github.com/enterprise/{{version}}">Enterprise Server {{version}}</a></li>
54+
{% endfor %}
55+
{% include support %}
56+
{% include small-footer %}
57+
</div>
58+
</div>
59+
</article>
60+
</main>
61+
62+
</main>
63+
</body>
64+
</html>

‎lib/enterprise-server-releases.js‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ const lastVersionWithoutStubbedRedirectFiles = '2.17'
4444
// last version using paths like /enterprise/<release>/<user>/<product>/<category>/<article>
4545
// instead of /enterprise-server@<release>/<product>/<category>/<article>
4646
const lastReleaseWithLegacyFormat = '2.18'
47+
const deprecatedReleasesWithLegacyFormat = deprecated.filter(version => versionSatisfiesRange(version, '<=2.18'))
48+
const deprecatedReleasesWithNewFormat = deprecated.filter(version => versionSatisfiesRange(version, '>2.18'))
49+
const deprecatedReleasesOnDeveloperSite = deprecated.filter(version => versionSatisfiesRange(version, '<=2.16'))
4750

4851
module.exports = {
4952
supported,
@@ -57,5 +60,8 @@ module.exports = {
5760
dates,
5861
firstVersionDeprecatedOnNewSite,
5962
lastVersionWithoutStubbedRedirectFiles,
60-
lastReleaseWithLegacyFormat
63+
lastReleaseWithLegacyFormat,
64+
deprecatedReleasesWithLegacyFormat,
65+
deprecatedReleasesWithNewFormat,
66+
deprecatedReleasesOnDeveloperSite
6167
}

‎middleware/enterprise-server-releases.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const { liquid } = require('../lib/render-content')
2+
const layouts = require('../lib/layouts')
3+
const getMiniTocItems = require('../lib/get-mini-toc-items')
4+
5+
module.exports = async (req, res, next) => {
6+
if (!req.path.endsWith('/enterprise-server-releases')) return next()
7+
8+
const html = await liquid.parseAndRender(layouts['enterprise-server-releases'], req.context)
9+
10+
req.context.miniTocItems = getMiniTocItems(html)
11+
12+
return res.send(await liquid.parseAndRender(layouts['enterprise-server-releases'], req.context))
13+
}

‎middleware/index.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ module.exports = function (app) {
7474
app.use(require('./contextualizers/webhooks'))
7575
app.use(require('./breadcrumbs'))
7676
app.use(require('./early-access-breadcrumbs'))
77+
app.use(require('./enterprise-server-releases'))
7778
app.use(require('./dev-toc'))
7879
app.use(require('./featured-links'))
7980

0 commit comments

Comments
 (0)