+
+
+
+
+
+
+
### Table of Contents
@@ -26,29 +52,36 @@ versions:
{% link_in_list /create-a-repo %}
{% link_in_list /fork-a-repo %}
{% link_in_list /be-social %}
+ {% link_in_list /github-glossary %}
+ {% link_in_list /git-cheatsheet %}
+ {% link_in_list /git-and-github-learning-resources %}
+
{% topic_link_in_list /learning-about-github %}
{% link_in_list /githubs-products %}
{% link_in_list /about-github-advanced-security %}
- {% link_in_list /exploring-early-access-releases-with-feature-preview %}
- {% link_in_list /types-of-github-accounts %}
+ {% link_in_list /types-of-github-accounts %}
+ {% link_in_list /access-permissions-on-github %}
{% link_in_list /faq-about-changes-to-githubs-plans %}
- {% link_in_list /github-cli %}
- {% link_in_list /github-desktop %}
- {% link_in_list /github-for-mobile %}
- {% link_in_list /access-permissions-on-github %}
- {% link_in_list /github-glossary %}
- {% link_in_list /git-cheatsheet %}
- {% link_in_list /git-and-github-learning-resources %}
+
+
{% topic_link_in_list /signing-up-for-github %}
{% link_in_list /signing-up-for-a-new-github-account %}
{% link_in_list /verifying-your-email-address %}
{% link_in_list /setting-up-a-trial-of-github-enterprise-cloud %}
{% link_in_list /setting-up-a-trial-of-github-enterprise-server %}
+
+{% topic_link_in_list /using-github %}
+ {% link_in_list /exploring-early-access-releases-with-feature-preview %}
+ {% link_in_list /supported-browsers %}
+ {% link_in_list /github-cli %}
+ {% link_in_list /github-desktop %}
+ {% link_in_list /github-for-mobile %}
+ {% link_in_list /keyboard-shortcuts %}
+ {% link_in_list /troubleshooting-connectivity-problems %}
+
{% topic_link_in_list /exploring-projects-on-github %}
{% link_in_list /finding-ways-to-contribute-to-open-source-on-github %}
{% link_in_list /saving-repositories-with-stars %}
{% link_in_list /following-people %}
-{% topic_link_in_list /using-github %}
- {% link_in_list /supported-browsers %}
- {% link_in_list /troubleshooting-connectivity-problems %}
- {% link_in_list /keyboard-shortcuts %}
+
+
diff --git a/includes/all-articles-category.html b/includes/all-articles-category.html
new file mode 100644
index 000000000000..0e1fdbd61bf4
--- /dev/null
+++ b/includes/all-articles-category.html
@@ -0,0 +1,32 @@
+{% assign category = siteTree[currentLanguage][currentVersion].products[currentProduct].categories[currentPath] %}
+
+{% assign maxArticles = 10 %}
+
+
+
{{ category.title }} docs
+
+
+ {% for xmaptopic in category.maptopics %}
+ {% assign maptopic = xmaptopic[1] %}
+ {% unless maptopic.hidden %}
+
+
+
+ {% for xarticle in maptopic.articles %}
+ {% assign article = xarticle[1] %}
+ -
+
+ {{ article.title }}
+
+
+ {% endfor %}
+ {% assign numArticles = maptopic.childArticles | obj_size %}
+ {% if numArticles > maxArticles %}
+
+ {% endif %}
+
+
+ {% endunless %}
+ {% endfor %}
+
+
{% for link in featuredLinks.guides %}
@@ -125,13 +127,19 @@ Guides
{% render guide-card for guideCards as guide %}
- Explore guides {% octicon "arrow-right" %}
+ {% unless currentCategory %}
+ Explore guides {% octicon "arrow-right" %}
+ {% endunless %}
{% endif %}
- {% include all-articles %}
+ {% if currentCategory %}
+ {% include all-articles-category %}
+ {% else %}
+ {% include all-articles-product %}
+ {% endif %}
diff --git a/lib/path-utils.js b/lib/path-utils.js
index 83a966985fe7..68a6f899a94a 100644
--- a/lib/path-utils.js
+++ b/lib/path-utils.js
@@ -90,6 +90,22 @@ function getProductStringFromPath (href) {
: pathParts[1]
}
+function getCategoryStringFromPath (href) {
+ href = getPathWithoutLanguage(href)
+
+ if (href === '/') return null
+
+ const pathParts = href.split('/')
+
+ if (pathParts.includes('early-access')) return null
+
+ const productIndex = allProducts[pathParts[2]]
+ ? 2
+ : 1
+
+ return pathParts[productIndex + 1]
+}
+
// Return the corresponding object for the product segment in a path
function getProductObjectFromPath (href) {
const productFromPath = getProductStringFromPath(href)
@@ -104,5 +120,6 @@ module.exports = {
getVersionStringFromPath,
getVersionObjectFromPath,
getProductStringFromPath,
+ getCategoryStringFromPath,
getProductObjectFromPath
}
diff --git a/middleware/context.js b/middleware/context.js
index a2508138aacd..3a00064c90b9 100644
--- a/middleware/context.js
+++ b/middleware/context.js
@@ -3,7 +3,12 @@ const enterpriseServerReleases = require('../lib/enterprise-server-releases')
const allVersions = require('../lib/all-versions')
const allProducts = require('../lib/all-products')
const activeProducts = Object.values(allProducts).filter(product => !product.wip && !product.hidden)
-const { getVersionStringFromPath, getProductStringFromPath, getPathWithoutLanguage } = require('../lib/path-utils')
+const {
+ getVersionStringFromPath,
+ getProductStringFromPath,
+ getCategoryStringFromPath,
+ getPathWithoutLanguage
+} = require('../lib/path-utils')
const productNames = require('../lib/product-names')
const warmServer = require('../lib/warm-server')
const featureFlags = Object.keys(require('../feature-flags'))
@@ -31,6 +36,7 @@ module.exports = async function contextualize (req, res, next) {
req.context.currentLanguage = req.language
req.context.currentVersion = getVersionStringFromPath(req.path)
req.context.currentProduct = getProductStringFromPath(req.path)
+ req.context.currentCategory = getCategoryStringFromPath(req.path)
req.context.allProducts = allProducts
req.context.activeProducts = activeProducts
req.context.allVersions = allVersions
diff --git a/tests/rendering/breadcrumbs.js b/tests/rendering/breadcrumbs.js
index 81f4249207e2..b95fe1b0cd06 100644
--- a/tests/rendering/breadcrumbs.js
+++ b/tests/rendering/breadcrumbs.js
@@ -49,13 +49,13 @@ describe('breadcrumbs', () => {
})
test('English breadcrumbs link to English pages', async () => {
- const $ = await getDOM('/en/github/getting-started-with-github')
+ const $ = await getDOM('/en/github/setting-up-and-managing-your-github-user-account')
const $breadcrumbs = $('.breadcrumbs a')
expect($breadcrumbs.eq(0).attr('href')).toBe('/en/github')
})
test('localized breadcrumbs link to localize pages', async () => {
- const $ = await getDOM('/ja/github/getting-started-with-github')
+ const $ = await getDOM('/ja/github/setting-up-and-managing-your-github-user-account')
const $breadcrumbs = $('.breadcrumbs a')
expect($breadcrumbs.eq(0).attr('href')).toBe('/ja/github')
})
diff --git a/tests/rendering/server.js b/tests/rendering/server.js
index c9cabb77d0ce..7b7e316c308d 100644
--- a/tests/rendering/server.js
+++ b/tests/rendering/server.js
@@ -756,15 +756,15 @@ describe('static routes', () => {
})
describe('index pages', () => {
- const nonEnterpriseOnlyPath = '/en/github/getting-started-with-github/verifying-your-email-address'
+ const nonEnterpriseOnlyPath = '/en/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings'
test('includes dotcom-only links in dotcom TOC', async () => {
- const $ = await getDOM('/en/github/getting-started-with-github')
+ const $ = await getDOM('/en/github/setting-up-and-managing-your-github-user-account')
expect($(`article a[href="${nonEnterpriseOnlyPath}"]`).length).toBe(1)
})
test('excludes dotcom-only from GHE TOC', async () => {
- const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/github/getting-started-with-github`)
+ const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/github/setting-up-and-managing-your-github-user-account`)
expect($(`a[href="${nonEnterpriseOnlyPath}"]`).length).toBe(0)
})