From 15ff2e2e986215c5090399b3b3ab0e13bf8b6b19 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Wed, 14 Apr 2021 10:34:49 -0400 Subject: [PATCH 01/10] update categories-for-support-team middleware --- middleware/categories-for-support-team.js | 111 ++++++++++------------ middleware/index.js | 2 +- 2 files changed, 51 insertions(+), 62 deletions(-) diff --git a/middleware/categories-for-support-team.js b/middleware/categories-for-support-team.js index b288bc3b13..b4ed5b3e82 100644 --- a/middleware/categories-for-support-team.js +++ b/middleware/categories-for-support-team.js @@ -1,65 +1,54 @@ -// This middleware serves a file that's used by the GitHub support team -// to quickly search for Help articles by title and insert the link to -// the article into a reply to a customer. const path = require('path') -const matter = require('gray-matter') -const readFileAsync = require('../lib/readfile-async') -const dotcomDir = path.join(__dirname, '../content/github') -const dotcomIndex = path.join(dotcomDir, 'index.md') -const linkRegex = /{% (?:topic_)?link_in_list ?\/(.*?) ?%}/g module.exports = async function categoriesForSupportTeam (req, res, next) { - if (req.path !== '/categories.json') return next() - const categories = await generateCategories() - return res.json(categories) -} - -async function generateCategories () { - // get links included in dotcom index page. - // each link corresponds to a dotcom subdirectory - // example: getting-started-with-github - const links = getLinks(await readFileAsync(dotcomIndex, 'utf8')) - - // get links included in each subdir's index page - // these are links to articles - const categories = await Promise.all(links.map(async link => { - const category = {} - const indexPath = getPath(link, 'index') - const indexContents = await readFileAsync(indexPath, 'utf8') - const { data, content } = matter(indexContents) - - // get name from title frontmatter - category.name = data.title - - // get child article links - const articleLinks = getLinks(content) - - category.published_articles = (await Promise.all(articleLinks.map(async articleLink => { - // get title from frontmatter - const articlePath = getPath(link, articleLink) - const articleContents = await readFileAsync(articlePath, 'utf8') - const { data } = matter(articleContents) - - // do not include map topics in list of published articles - if (data.mapTopic) return - - return { - title: data.title, - slug: articleLink - } - }))).filter(Boolean) - - return category - })) - - return categories -} - -function getLinks (contents) { - return contents.match(linkRegex) - .map(link => link.match(linkRegex.source)[1]) -} - -function getPath (link, filename) { - return path.join(dotcomDir, link, `${filename}.md`) + const englishSiteTree = req.context.siteTree.en + + const allCategories = [] + + Object.keys(englishSiteTree).forEach(version => { + const versionedProductsTree = englishSiteTree[version].products + + Object.values(versionedProductsTree).forEach(productObj => { + if (productObj.id === 'early-access') return + if (productObj.external) return + + Object.values(productObj.categories).forEach(categoryObj => { + const articlesArry = [] + + if (categoryObj.maptopics) { + Object.values(categoryObj.maptopics).forEach(maptopicObj => { + Object.values(maptopicObj.articles).forEach(articleObj => { + articlesArry.push({ + title: articleObj.title, + slug: path.basename(articleObj.href) + }) + }) + }) + } + + if (categoryObj.standalone) { + articlesArry.push({ + title: categoryObj.title, + slug: path.basename(categoryObj.href) + }) + } + + if (categoryObj.articles) { + Object.values(categoryObj.articles).forEach(articleObj => { + articlesArry.push({ + title: articleObj.title, + slug: path.basename(articleObj.href) + }) + }) + } + + allCategories.push({ + name: categoryObj.title, + published_articles: articlesArry + }) + }) + }) + }) + + return res.json(allCategories) } diff --git a/middleware/index.js b/middleware/index.js index a97f9e9d21..820888ebf8 100644 --- a/middleware/index.js +++ b/middleware/index.js @@ -97,7 +97,7 @@ module.exports = function (app) { app.use(asyncMiddleware(instrument('./archived-enterprise-versions'))) app.use(instrument('./robots')) app.use(/(\/.*)?\/early-access$/, instrument('./contextualizers/early-access-links')) - app.use(asyncMiddleware(instrument('./categories-for-support-team'))) + app.use('/categories.json', asyncMiddleware(instrument('./categories-for-support-team'))) app.use(instrument('./loaderio-verification')) app.get('/_500', asyncMiddleware(instrument('./trigger-error'))) From 3a2839cb17c44e7ad29ebdf7743fbfdafc9d78df Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Wed, 14 Apr 2021 10:35:10 -0400 Subject: [PATCH 02/10] differentiate between title and shortTitle in siteTree --- includes/sidebar-specific-product.html | 14 +++++++----- lib/site-tree-titles.js | 31 +++++++++++++++++--------- lib/site-tree.js | 6 +++-- 3 files changed, 34 insertions(+), 17 deletions(-) diff --git a/includes/sidebar-specific-product.html b/includes/sidebar-specific-product.html index e4684187de..99dc1c4d41 100644 --- a/includes/sidebar-specific-product.html +++ b/includes/sidebar-specific-product.html @@ -19,13 +19,14 @@ {% capture fullPathToCategory %}{{category[1].href}}{% endcapture %}
  • + {% if category[1].shortTitle %}{% assign categoryTitle = category[1].shortTitle %}{% else %}{% assign categoryTitle = category[1].title %}{% endif %} {% if category[1].standalone %} - {{ category[1].title }} + {{ categoryTitle }} {% else %}
    - {{ category[1].title }} + {{ categoryTitle }} {% if breadcrumbs.category.href == category[1].href or forloop.index < 4 %} {% endif %} @@ -39,16 +40,18 @@ {% for maptopic in category[1].maptopics %} {% unless maptopic[1].hidden %} {% capture fullPathToMaptopic %}{{maptopic[1].href}}{% endcapture %} + {% if maptopic[1].shortTitle %}{% assign maptopicTitle = maptopic[1].shortTitle %}{% else %}{% assign maptopicTitle = maptopic[1].title %}{% endif %}
  • - {{ maptopic[1].title }} + {{ maptopicTitle }}
      {% for article in maptopic[1].articles %} {% unless article[1].hidden %} {% capture fullPathToArticle %}{{article[1].href}}{% endcapture %} + {% if article[1].shortTitle %}{% assign articleTitle = article[1].shortTitle %}{% else %}{% assign articleTitle = article[1].title %}{% endif %}
    • - {{ article[1].title }} + {{ articleTitle }}
      • {% endunless %} {% endfor %} @@ -63,8 +66,9 @@ {% for article in category[1].articles %} {% unless article[1].hidden %} {% capture fullPathToArticle %}{{article[1].href}}{% endcapture %} + {% if article[1].shortTitle %}{% assign articleTitle = article[1].shortTitle %}{% else %}{% assign articleTitle = article[1].title %}{% endif %}
    • - {{ article[1].title }} + {{ articleTitle }}
      • {% endunless %} {% endfor %} diff --git a/lib/site-tree-titles.js b/lib/site-tree-titles.js index 0d8148db64..b1990deb8b 100644 --- a/lib/site-tree-titles.js +++ b/lib/site-tree-titles.js @@ -2,18 +2,19 @@ const flat = require('flat') const renderContent = require('./render-content') const delimiter = '#' -// render localized and product-version-aware page title -// note this only supports titles with liquid, not short titles +// render localized and product-version-aware page title or shortTitle module.exports = async function siteTreeTitles (siteTree, siteData) { // use a non-period delimiter because versions contain periods (like 2.19) const flatTree = flat(siteTree, { delimiter: delimiter }) const titlesWithLiquid = Object.entries(flatTree) - .filter(([path, title]) => path.endsWith('title') && title.includes('{')) + .filter(([path, shortOrLongTitle]) => path.endsWith('itle') && shortOrLongTitle && shortOrLongTitle.includes('{')) - await Promise.all(titlesWithLiquid.map(async ([path, title]) => { - path = path.replace(`${delimiter}title`, '') // ignore the `title` path part for now + await Promise.all(titlesWithLiquid.map(async ([path, shortOrLongTitle]) => { + const isShortTitle = /shortTitle$/.test(path) + + path = path.replace(`${delimiter}(shortT|t)itle`, '') // ignore the `title` path part for now // derive values from path parts const [ @@ -31,29 +32,39 @@ module.exports = async function siteTreeTitles (siteTree, siteData) { // create context object for rendering of dynamic liquid data in page titles const ctx = { - page: { version }, + currentVersion: version, site: siteData[languageCode].site } - const renderedTitle = await renderContent(title, ctx, { textOnly: true }) + const renderedShortOrLongTitle = await renderContent(shortOrLongTitle, ctx, { textOnly: true }) // no product titles have liquid because we get them from lib/all-products.js // so we can assume all titles processed here will be either a category, maptopic, or article // we can also assume a category value will exist for any of these const currentCategory = siteTree[languageCode][version][products][product][categories][category] - if (!maptopic) currentCategory.title = renderedTitle + if (!maptopic) { + isShortTitle + ? currentCategory.shortTitle = renderedShortOrLongTitle + : currentCategory.title = renderedShortOrLongTitle + } let currentMaptopic if (maptopic) { currentMaptopic = currentCategory[maptopics][maptopic] - if (!article) currentMaptopic.title = renderedTitle + if (!article) { + isShortTitle + ? currentMaptopic.shortTitle = renderedShortOrLongTitle + : currentMaptopic.title = renderedShortOrLongTitle + } } let currentArticle if (article) { currentArticle = currentMaptopic[articles][article] - currentArticle.title = renderedTitle + isShortTitle + ? currentArticle.shortTitle = renderedShortOrLongTitle + : currentArticle.title = renderedShortOrLongTitle } })) } diff --git a/lib/site-tree.js b/lib/site-tree.js index 4d68c4fc85..a7d8fb84df 100644 --- a/lib/site-tree.js +++ b/lib/site-tree.js @@ -78,7 +78,8 @@ function buildCategoriesTree (tocItems, versionedProductHref, pageMap, redirects if (!page) return if (!getApplicableVersions(page.versions).includes(version)) return - category.title = page.shortTitle || page.title + category.title = page.title + category.shortTitle = page.shortTitle // support standalone pages at the category level, like actions/quickstart.md if (!page.tocItems) { @@ -157,7 +158,8 @@ function buildArticlesTree (tocItems, versionedCategoryHref, pageMap, redirects, if (!page) return if (!getApplicableVersions(page.versions).includes(version)) return - article.title = page.shortTitle || page.title + article.title = page.title + article.shortTitle = page.shortTitle article.hidden = page.hidden articleTree[article.href] = article From 7b2ffb5eb7d664cdcff599d2a2811b752ad3f39d Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:29:56 -0400 Subject: [PATCH 03/10] rename action_code_examples.yml to actions_code_examples.yml so we can get it by product id --- .../{action_code_examples.yml => actions_code_examples.yml} | 0 .../{action_code_examples.yml => actions_code_examples.yml} | 0 .../{action_code_examples.yml => actions_code_examples.yml} | 0 .../{action_code_examples.yml => actions_code_examples.yml} | 0 .../{action_code_examples.yml => actions_code_examples.yml} | 0 .../{action_code_examples.yml => actions_code_examples.yml} | 0 .../{action_code_examples.yml => actions_code_examples.yml} | 0 .../{action_code_examples.yml => actions_code_examples.yml} | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) rename translations/de-DE/data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) rename translations/es-ES/data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) rename translations/ja-JP/data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) rename translations/ko-KR/data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) rename translations/pt-BR/data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) rename translations/ru-RU/data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) rename translations/zh-CN/data/variables/{action_code_examples.yml => actions_code_examples.yml} (100%) diff --git a/data/variables/action_code_examples.yml b/data/variables/actions_code_examples.yml similarity index 100% rename from data/variables/action_code_examples.yml rename to data/variables/actions_code_examples.yml diff --git a/translations/de-DE/data/variables/action_code_examples.yml b/translations/de-DE/data/variables/actions_code_examples.yml similarity index 100% rename from translations/de-DE/data/variables/action_code_examples.yml rename to translations/de-DE/data/variables/actions_code_examples.yml diff --git a/translations/es-ES/data/variables/action_code_examples.yml b/translations/es-ES/data/variables/actions_code_examples.yml similarity index 100% rename from translations/es-ES/data/variables/action_code_examples.yml rename to translations/es-ES/data/variables/actions_code_examples.yml diff --git a/translations/ja-JP/data/variables/action_code_examples.yml b/translations/ja-JP/data/variables/actions_code_examples.yml similarity index 100% rename from translations/ja-JP/data/variables/action_code_examples.yml rename to translations/ja-JP/data/variables/actions_code_examples.yml diff --git a/translations/ko-KR/data/variables/action_code_examples.yml b/translations/ko-KR/data/variables/actions_code_examples.yml similarity index 100% rename from translations/ko-KR/data/variables/action_code_examples.yml rename to translations/ko-KR/data/variables/actions_code_examples.yml diff --git a/translations/pt-BR/data/variables/action_code_examples.yml b/translations/pt-BR/data/variables/actions_code_examples.yml similarity index 100% rename from translations/pt-BR/data/variables/action_code_examples.yml rename to translations/pt-BR/data/variables/actions_code_examples.yml diff --git a/translations/ru-RU/data/variables/action_code_examples.yml b/translations/ru-RU/data/variables/actions_code_examples.yml similarity index 100% rename from translations/ru-RU/data/variables/action_code_examples.yml rename to translations/ru-RU/data/variables/actions_code_examples.yml diff --git a/translations/zh-CN/data/variables/action_code_examples.yml b/translations/zh-CN/data/variables/actions_code_examples.yml similarity index 100% rename from translations/zh-CN/data/variables/action_code_examples.yml rename to translations/zh-CN/data/variables/actions_code_examples.yml From 88034a3d979315dc6cf1a88f3da59e12f93ef61c Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:30:25 -0400 Subject: [PATCH 04/10] add code-examples include file --- includes/code-examples.html | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 includes/code-examples.html diff --git a/includes/code-examples.html b/includes/code-examples.html new file mode 100644 index 0000000000..cbd29a51cb --- /dev/null +++ b/includes/code-examples.html @@ -0,0 +1,20 @@ +
      +

      {% data ui.product_landing.code_examples %}

      + +
      + +
      + +
      + {% render code-example-card for productCodeExamples as example %} +
      + + + +
      +
      {% octicon "search" width="24" %}
      +

      {% data ui.product_landing.sorry %}

      +

      {% data ui.product_landing.no_result %}
      {% data ui.product_landing.try_another %}

      + {% data ui.product_landing.learn %} {% octicon "arrow-right" %} +
      +
      From 4c81500d923e0a8e28298dd1655d90a0fd5e1149 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:30:46 -0400 Subject: [PATCH 05/10] remove HTML from actions landing page content file --- content/actions/index.md | 27 +-------------------------- 1 file changed, 1 insertion(+), 26 deletions(-) diff --git a/content/actions/index.md b/content/actions/index.md index f289ebb7f7..62205a48e4 100644 --- a/content/actions/index.md +++ b/content/actions/index.md @@ -46,29 +46,4 @@ versions: - - - -{% assign actionsCodeExamples = site.data.variables.action_code_examples %} -{% if actionsCodeExamples %} -
      -

      Code examples

      - -
      - -
      - -
      - {% render code-example-card for actionsCodeExamples as example %} -
      - - - -
      -
      {% octicon "search" width="24" %}
      -

      Sorry, there is no result for

      -

      It looks like we don't have an example that fits your filter.
      Try another filter or add your code example

      - Learn how to add a code example {% octicon "arrow-right" %} -
      -
      -{% endif %} + \ No newline at end of file From 121a3be4fa3bf4464a62cb204329173223700e1f Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:30:59 -0400 Subject: [PATCH 06/10] add community-examples include file --- includes/community-examples.html | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 includes/community-examples.html diff --git a/includes/community-examples.html b/includes/community-examples.html new file mode 100644 index 0000000000..42a95855cb --- /dev/null +++ b/includes/community-examples.html @@ -0,0 +1,16 @@ +
      +

      {% data ui.product_landing.communities_using_discussions %}

      + +
      + {% render discussions-community-card for productCommunityExamples as example %} +
      + {% if productCommunityExamples.length > 6 %} + + {% endif %} +
      +
      {% octicon "search" width="24" %}
      +

      {% data ui.product_landing.sorry %}

      +

      {% data ui.product_landing.no_example %}
      {% data ui.product_landing.try_another %}

      + {% data ui.product_landing.add_your_community %} {% octicon "arrow-right" %} +
      +
      \ No newline at end of file From a5317d741254776310c34be0f915190df834c246 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:31:13 -0400 Subject: [PATCH 07/10] remove HTML from discussions landing page content file --- content/discussions/index.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/content/discussions/index.md b/content/discussions/index.md index e0092dcbc1..3c52fee2cf 100644 --- a/content/discussions/index.md +++ b/content/discussions/index.md @@ -34,24 +34,3 @@ versions: - - -{% assign discussionsCommunityExamples = site.data.variables.discussions_community_examples %} -{% if discussionsCommunityExamples %} -
      -

      Communities using discussions

      - -
      - {% render discussions-community-card for discussionsCommunityExamples as example %} -
      - {% if discussionsCommunityExamples.length > 6 %} - - {% endif %} -
      -
      {% octicon "search" width="24" %}
      -

      Sorry, there is no result for

      -

      It looks like we don't have an example that fits your filter.
      Try another filter or add your code example

      - Add your community {% octicon "arrow-right" %} -
      -
      -{% endif %} From 01931dd07f985b08ac06c2562d0991b822554aed Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:31:24 -0400 Subject: [PATCH 08/10] add strings to ui.yml for localization --- data/ui.yml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/data/ui.yml b/data/ui.yml index fac465f2b4..17425b6564 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -140,6 +140,16 @@ product_landing: quick_start: Quickstart reference_guides: Reference guides overview: Overview + code_examples: Code examples + search_code_examples: Search code examples + show_more: Show more + sorry: Sorry, there is no result for + no_example: It looks like we don't have an example that fits your filter. + try_another: Try another filter or add your code example. + no_result: Sorry, there is no guide that match your filter. + learn: Learn how to add a code example + communities_using_discussions: Communities using discussions + add_your_community: Add your community product_sublanding: start: Start start_path: Start path @@ -149,7 +159,6 @@ product_sublanding: more_guides: more guides load_more: Load more guides all_guides: 'All {{ productMap[currentProduct].name }} guides' - no_result: Sorry, there is no guide that match your filter. filters: type: Type topic: Topic From 30c2ec41f9264f619d80e77c686f719953362421 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:31:41 -0400 Subject: [PATCH 09/10] reference new include files in product-landing layout --- layouts/product-landing.html | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/layouts/product-landing.html b/layouts/product-landing.html index 6d0cf95a13..de9e83368d 100644 --- a/layouts/product-landing.html +++ b/layouts/product-landing.html @@ -117,6 +117,14 @@ {% endif %}
    • + {% if productCodeExamples %} + {% include code-examples %} + {% endif %} + + {% if productCommunityExamples %} + {% include community-examples %} + {% endif %} + {{ renderedPage }} From 56f1cdd12b616b3516afac5430b096785cf09d29 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 15 Apr 2021 12:31:59 -0400 Subject: [PATCH 10/10] add example variables to context via product ID --- middleware/context.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/middleware/context.js b/middleware/context.js index 58c463d685..7ec21bb788 100644 --- a/middleware/context.js +++ b/middleware/context.js @@ -51,6 +51,11 @@ module.exports = async function contextualize (req, res, next) { req.context.siteTree = siteTree req.context.pages = pageMap + if (productMap[req.context.currentProduct]) { + req.context.productCodeExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_code_examples`] + req.context.productCommunityExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_community_examples`] + } + // JS + CSS asset paths req.context.builtAssets = builtAssets