Skip to content

Commit

Permalink
add Developer deprecated docs to the list and also add a mini-toc
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahs committed Dec 8, 2020
1 parent c52a9ba commit 3ca261a
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 6 deletions.
4 changes: 3 additions & 1 deletion data/ui.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,11 @@ contribution_cta:
enterprise_releases_list:
title: Enterprise Server Releases
currently_supported: Currently supported
currently_supported_message: See <a href="https://github.com/enterprise">GitHub Enterprise</a> for more information.
currently_supported_message: See <a href="https://github.com/enterprise">GitHub Enterprise</a> for information about the latest release.
deprecated: Deprecated
deprecated_message: 'These docs remain available but are no longer maintained:'
deprecated_developer: Deprecated on developer.github.com
deprecated_developer_message: 'These docs remain available on the legacy <a href="https://developer.github.com">developer site</a> but are no longer maintained:'
products:
graphql:
reference:
Expand Down
23 changes: 20 additions & 3 deletions layouts/enterprise-server-releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<main class="width-full">
<main class="container-xl px-3 px-md-6 my-4 my-lg-4 d-xl-flex">
<article class="markdown-body width-full">
<div class="d-lg-flex flex-justify-between"> </div>
<div class="d-lg-flex flex-justify-between"></div>

<div class="mt-2 article-grid-container">

Expand All @@ -17,15 +17,27 @@
<h1 class="border-bottom-0">{% data ui.enterprise_releases_list.title %}</h1>
</div>
</div>
<div class="article-grid-toc border-bottom border-xl-0 pb-4 mb-5 pb-xl-0 mb-xl-0">
<div class="article-grid-toc-content">
{% if miniTocItems.size > 1 %}
<h3 id="in-this-article" class="f5 mb-2"><a class="link-gray-dark" href="#in-this-article">{% data ui.pages.miniToc %}</a></h3>
<ul class="list-style-none pl-0 f5 mb-0">
{% for item in miniTocItems %}
<li class="ml-{{ item.indentationLevel | times: 3 }} mb-2 lh-condensed">{{ item.contents }}</li>
{% endfor %}
</ul>
{% endif %}
</div>
</div>
<div id="article-contents" class="article-grid-body">
<h2>{% data ui.enterprise_releases_list.currently_supported %}</h2>
<h2 id="currently-supported"><a href="#currently-supported">{% data ui.enterprise_releases_list.currently_supported %}</a></h2>
<p>{% data ui.enterprise_releases_list.currently_supported_message %}</p>
<ul>
{% for version in enterpriseServerReleases.supported %}
<li><a href="/{{currentLanguage}}/enterprise-server@{{version}}">Enterprise Server {{version}}</a></li>
{% endfor %}
</ul>
<h2>{% data ui.enterprise_releases_list.deprecated %}</h2>
<h2 id="deprecated"><a href="#deprecated">{% data ui.enterprise_releases_list.deprecated %}</a></h2>
<p>{% data ui.enterprise_releases_list.deprecated_message %}</p>
<ul>
{% for version in enterpriseServerReleases.deprecatedReleasesWithNewFormat %}
Expand All @@ -35,6 +47,11 @@ <h2>{% data ui.enterprise_releases_list.deprecated %}</h2>
<li><a href="/{{currentLanguage}}/enterprise/{{version}}">Enterprise Server {{version}}</a></li>
{% endfor %}
</ul>
<h2 id="deprecated-on-developer.github.com"><a href="#deprecated-on-developer.github.com">{% data ui.enterprise_releases_list.deprecated_developer %}</a></h2>
<p>{% data ui.enterprise_releases_list.deprecated_developer_message %}</p>
{% for version in enterpriseServerReleases.deprecatedReleasesOnDeveloperSite %}
<li><a href="https://developer.github.com/enterprise/{{version}}">Enterprise Server {{version}}</a></li>
{% endfor %}
{% include support %}
{% include small-footer %}
</div>
Expand Down
4 changes: 3 additions & 1 deletion lib/enterprise-server-releases.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ const lastVersionWithoutStubbedRedirectFiles = '2.17'
const lastReleaseWithLegacyFormat = '2.18'
const deprecatedReleasesWithLegacyFormat = deprecated.filter(version => versionSatisfiesRange(version, '<=2.18'))
const deprecatedReleasesWithNewFormat = deprecated.filter(version => versionSatisfiesRange(version, '>2.18'))
const deprecatedReleasesOnDeveloperSite = deprecated.filter(version => versionSatisfiesRange(version, '<=2.16'))

module.exports = {
supported,
Expand All @@ -61,5 +62,6 @@ module.exports = {
lastVersionWithoutStubbedRedirectFiles,
lastReleaseWithLegacyFormat,
deprecatedReleasesWithLegacyFormat,
deprecatedReleasesWithNewFormat
deprecatedReleasesWithNewFormat,
deprecatedReleasesOnDeveloperSite
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
const { liquid } = require('../lib/render-content')
const layouts = require('../lib/layouts')
const getMiniTocItems = require('../lib/get-mini-toc-items')

module.exports = async (req, res, next) => {
if (!req.path.endsWith('/enterprise-server-releases')) return next()

const html = await liquid.parseAndRender(layouts['enterprise-server-releases'], req.context)

req.context.miniTocItems = getMiniTocItems(html)

return res.send(await liquid.parseAndRender(layouts['enterprise-server-releases'], req.context))
}
2 changes: 1 addition & 1 deletion middleware/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ module.exports = function (app) {
app.use(require('./contextualizers/rest'))
app.use(require('./contextualizers/webhooks'))
app.use(require('./breadcrumbs'))
app.use(require('./enterprise-releases'))
app.use(require('./enterprise-server-releases'))
app.use(require('./dev-toc'))
app.use(require('./featured-links'))

Expand Down

0 comments on commit 3ca261a

Please sign in to comment.