Merge pull request #18551 from github/move-product-list-to-frontmatter

Move products list to frontmatter

Author: sarahs

.github/workflows/send-prs-to-how-how-we-work-boards.yml

@@ -35,11 +35,15 @@ jobs:
 
             var column_id = 13445681;
             try {
-              github.projects.createCard({
+              await github.projects.createCard({
                 column_id: column_id,
                 content_id: context.payload.pull_request.id,
                 content_type: "PullRequest"
               });
             } catch (error) {
-              console.log(error);
+              if (error.includes('Project already has the associated issue')) {
+                return
+              } else {
+                console.log(error);
+              }
             }

content/index.md

@@ -13,5 +13,42 @@ featuredLinks:
     - /github/getting-started-with-github/managing-remote-repositories
     - /github/working-with-github-pages
 versions: '*'
+children:
+  - github
+  - admin
+  - discussions
+  - code-security
+  - actions
+  - packages
+  - developers
+  - rest
+  - graphql
+  - insights
+  - communities
+  - pages
+  - education
+  - desktop
+  - early-access
+externalProducts:
+  cli:
+    id: cli
+    name: GitHub CLI
+    href: 'https://cli.github.com/manual'
+    external: true
+  atom:
+    id: atom
+    name: Atom
+    href: 'https://atom.io/docs'
+    external: true
+  electron:
+    id: electron
+    name: Electron
+    href: 'https://electronjs.org/docs'
+    external: true
+  codeql:
+    id: codeql
+    name: 'CodeQL'
+    href: 'https://codeql.github.com/docs'
+    external: true
 ---
 

data/products.yml

@@ -26,7 +26,7 @@ <h4 class="text-mono f5 text-normal text-gray d-md-none">{% data ui.homepage.exp
                   <div id="current-product" class="d-flex flex-items-center flex-justify-between" style="padding-top: 2px;">
                     <!-- Product switcher - GitHub.com, Enterprise Server, etc -->
                     <!-- 404 and 500 error layouts are not real pages so we need to hardcode the name for those -->
-                    {{ allProducts[currentProduct].name }}
+                    {{ productMap[currentProduct].name }}
                     <svg class="arrow ml-md-1" width="14px" height="8px" viewBox="0 0 14 8" xml:space="preserve" fill="none" stroke="#1277eb"><path d="M1,1l6.2,6L13,1"></path></svg>
                   </div>
                 </summary>

includes/header.html

@@ -1,53 +1,28 @@
 const fs = require('fs')
 const path = require('path')
-const slash = require('slash')
-const assert = require('assert')
-const { difference } = require('lodash')
-const yaml = require('js-yaml')
-const contentDir = path.join(process.cwd(), 'content')
 const frontmatter = require('./read-frontmatter')
 const getApplicableVersions = require('./get-applicable-versions')
 const removeFPTFromPath = require('./remove-fpt-from-path')
 
-// the product order is determined by data/products.yml
-const productsFile = path.join(process.cwd(), 'data/products.yml')
-const productsYml = yaml.load(fs.readFileSync(productsFile, 'utf8'))
-const sortedProductIds = productsYml.productsInOrder
-
-const contentProductIds = fs.readdirSync(contentDir, { withFileTypes: true })
-  .map(entry => {
-    // `fs.readdir` provides file entries based on `fs.lstat`, which doesn't
-    // resolve symbolic links to their target file/directory. We need to take
-    // an extra step here to resolve the Early Access symlinked directory.
-    const { name } = entry
-    if (entry.isSymbolicLink()) {
-      entry = fs.statSync(path.join(contentDir, entry.name))
-      entry.name = name
-    }
-    return entry
-  })
-  .filter(entry => entry.isDirectory())
-  .map(entry => entry.name)
-
-// require the content/<subdir> list to match the list in data/products.yml,
-// with the exception of content/early-access, which lives in a separate private repo
-const publicContentProductIds = contentProductIds.filter(id => id !== 'early-access')
-assert(difference(sortedProductIds, publicContentProductIds).length === 0)
-assert(difference(publicContentProductIds, sortedProductIds).length === 0)
+// Both internal and external products are specified in content/index.md
+const homepage = path.posix.join(process.cwd(), 'content/index.md')
+const { data } = frontmatter(fs.readFileSync(homepage, 'utf8'))
+const productIds = data.children
+const externalProducts = data.externalProducts
 
 const internalProducts = {}
 
-// add optional early access content dir to sorted products list if present
-const earlyAccessId = contentProductIds.find(id => id === 'early-access')
-if (earlyAccessId) sortedProductIds.push(earlyAccessId)
-
-sortedProductIds.forEach(productId => {
+productIds.forEach(productId => {
   const relPath = productId
-  const dir = slash(path.join('content', relPath))
-  const toc = slash(path.join(dir, 'index.md'))
+  const dir = path.posix.join('content', relPath)
+
+  // Early Access may not exist in the current checkout
+  if (!fs.existsSync(dir)) return
+
+  const toc = path.posix.join(dir, 'index.md')
   const { data } = frontmatter(fs.readFileSync(toc, 'utf8'))
   const applicableVersions = getApplicableVersions(data.versions, toc)
-  const href = removeFPTFromPath(slash(path.join('/', applicableVersions[0], productId)))
+  const href = removeFPTFromPath(path.posix.join('/', applicableVersions[0], productId))
 
   internalProducts[productId] = {
     id: productId,
@@ -62,33 +37,9 @@ sortedProductIds.forEach(productId => {
   internalProducts[productId].versions = applicableVersions
 })
 
-const externalProducts = {
-  cli: {
-    id: 'cli',
-    name: 'GitHub CLI',
-    href: 'https://cli.github.com/manual',
-    external: true
-  },
-  atom: {
-    id: 'atom',
-    name: 'Atom',
-    href: 'https://atom.io/docs',
-    external: true
-  },
-  electron: {
-    id: 'electron',
-    name: 'Electron',
-    href: 'https://electronjs.org/docs',
-    external: true
-  },
-  codeql: {
-    id: 'codeql',
-    name: 'CodeQL',
-    href: 'https://codeql.github.com/docs',
-    external: true
-  }
-}
+const productMap = Object.assign({}, internalProducts, externalProducts)
 
-const allProducts = Object.assign({}, internalProducts, externalProducts)
-
-module.exports = allProducts
+module.exports = {
+  productIds,
+  productMap
+}

lib/all-products.js

@@ -126,6 +126,46 @@ const schema = {
         name: { type: 'string' },
         URL: { type: 'string' }
       }
+    },
+    // Child links specified on any TOC page
+    children: {
+      type: 'array'
+    },
+    // External products specified on the homepage
+    externalProducts: {
+      type: 'object',
+      properties: {
+        cli: {
+          type: 'object',
+          required: true,
+          properties: {
+            id: { type: 'string', required: true },
+            name: { type: 'string', required: true },
+            href: { type: 'string', format: 'url', required: true },
+            external: { type: 'boolean', required: true }
+          }
+        },
+        atom: {
+          type: 'object',
+          required: true,
+          properties: {
+            id: { type: 'string', required: true },
+            name: { type: 'string', required: true },
+            href: { type: 'string', format: 'url', required: true },
+            external: { type: 'boolean', required: true }
+          }
+        },
+        electron: {
+          type: 'object',
+          required: true,
+          properties: {
+            id: { type: 'string', required: true },
+            name: { type: 'string', required: true },
+            href: { type: 'string', format: 'url', required: true },
+            external: { type: 'boolean', required: true }
+          }
+        }
+      }
     }
   }
 }

lib/frontmatter.js

@@ -1,4 +1,5 @@
-const productTOCs = Object.values(require('./all-products'))
+const { productMap } = require('./all-products')
+const productTOCs = Object.values(productMap)
   .filter(product => !product.external)
   .map(product => product.toc.replace('content/', ''))
 

lib/get-toc-items.js

@@ -12,7 +12,7 @@ const Permalink = require('./permalink')
 const languages = require('./languages')
 const renderContent = require('./render-content')
 const { renderReact } = require('./react/engine')
-const products = require('./all-products')
+const { productMap } = require('./all-products')
 const slash = require('slash')
 const statsd = require('./statsd')
 const readFileContents = require('./read-file-contents')
@@ -76,8 +76,11 @@ class Page {
       this.introLinks.rawOverview = this.introLinks.overview
     }
 
+    // Get array of versions that the page is available in for fast lookup
+    this.applicableVersions = getApplicableVersions(this.versions, this.fullPath)
+
     // a page should only be available in versions that its parent product is available in
-    const versionsParentProductIsNotAvailableIn = getApplicableVersions(this.versions, this.fullPath)
+    const versionsParentProductIsNotAvailableIn = this.applicableVersions
       // only the homepage will not have this.parentProduct
       .filter(availableVersion => this.parentProduct && !this.parentProduct.versions.includes(availableVersion))
 
@@ -124,7 +127,7 @@ class Page {
     // make sure the ID is valid
     if (process.env.NODE_ENV !== 'test') {
       assert(
-        Object.keys(products).includes(id),
+        Object.keys(productMap).includes(id),
         `page ${this.fullPath} has an invalid product ID: ${id}`
       )
     }
@@ -133,7 +136,7 @@ class Page {
   }
 
   get parentProduct () {
-    return products[this.parentProductId]
+    return productMap[this.parentProductId]
   }
 
   async renderTitle (context, opts = {}) {

lib/page.js

@@ -2,7 +2,7 @@ const slash = require('slash')
 const path = require('path')
 const patterns = require('./patterns')
 const { latest } = require('./enterprise-server-releases')
-const allProducts = require('./all-products')
+const { productIds } = require('./all-products')
 const allVersions = require('./all-versions')
 const supportedVersions = new Set(Object.keys(allVersions))
 const nonEnterpriseDefaultVersion = require('./non-enterprise-default-version')
@@ -43,7 +43,7 @@ function getVersionStringFromPath (href) {
   const versionFromPath = href.split('/')[1]
 
   // If the first segment is a supported product, assume this is FPT
-  if (allProducts[versionFromPath]) {
+  if (productIds.includes(versionFromPath)) {
     return nonEnterpriseDefaultVersion
   }
 
@@ -85,7 +85,7 @@ function getProductStringFromPath (href) {
 
   if (pathParts.includes('early-access')) return 'early-access'
 
-  return allProducts[pathParts[2]]
+  return productIds.includes(pathParts[2])
     ? pathParts[2]
     : pathParts[1]
 }
@@ -99,27 +99,19 @@ function getCategoryStringFromPath (href) {
 
   if (pathParts.includes('early-access')) return null
 
-  const productIndex = allProducts[pathParts[2]]
+  const productIndex = productIds.includes(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)
-
-  return allProducts[productFromPath]
-}
-
 module.exports = {
   getPathWithLanguage,
   getPathWithoutLanguage,
   getPathWithoutVersion,
   getVersionStringFromPath,
   getVersionObjectFromPath,
   getProductStringFromPath,
-  getCategoryStringFromPath,
-  getProductObjectFromPath
+  getCategoryStringFromPath
 }

lib/path-utils.js

@@ -1,5 +1,5 @@
 const path = require('path')
-const products = Object.values(require('./all-products'))
+const { productMap } = require('./all-products')
 const languageCodes = Object.keys(require('./languages'))
 const addTitlesToTree = require('./site-tree-titles')
 const allVersions = Object.keys(require('./all-versions'))
@@ -26,7 +26,7 @@ module.exports = async function buildSiteTree (pageMap, site, redirects) {
       siteTree[languageCode][version] = {}
       const productTree = {}
 
-      products.forEach(item => {
+      Object.values(productMap).forEach(item => {
         const product = { title: item.name }
 
         // return early if the product has external docs, like Atom