Merge branch 'main' of github.com:github/docs-internal into refactor-site-tree

Author: sarahs

.github/allowed-actions.js

@@ -27,6 +27,7 @@ module.exports = [
   "juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9",
   "juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512",
   "lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8",
+  "lee-dohm/no-response@9bb0a4b5e6a45046f00353d5de7d90fb8bd773bb",
   "pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0
   "peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326",
   "peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd",

.github/workflows/no-response.yaml

@@ -0,0 +1,30 @@
+name: No Response
+
+# **What it does**: Closes issues that don't have enough information to be
+#                   actionable.
+# **Why we have it**: To remove the need for maintainers to remember to check
+#                     back on issues periodically to see if contributors have
+#                     responded.
+# **Who does it impact**: Everyone that works on docs or docs-internal.
+
+on:
+  issue_comment:
+    types: created
+
+  schedule:
+    # Schedule for five minutes after the hour every hour
+    - cron: '5 * * * *'
+
+jobs:
+  noResponse:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: lee-dohm/no-response@9bb0a4b5e6a45046f00353d5de7d90fb8bd773bb
+        with:
+          token: ${{ github.token }}
+          closeComment: >
+            This issue has been automatically closed because there has been no response
+            to our request for more information from the original author. With only the
+            information that is currently in the issue, we don't have enough information
+            to take action. Please reach out if you have or find the answers we need so
+            that we can investigate further. See [this blog post on bug reports and the importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/) for more information about the kind of information that may be helpful.

.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

@@ -50,6 +50,7 @@ Proctorio | Proctorio Registration Key
 Proctorio | Proctorio Secret Key
 Pulumi | Pulumi Access Token
 PyPI | PyPI API Token
+RubyGems | RubyGems API Key
 Samsara | Samsara API Token
 Samsara | Samsara OAuth Access Token
 Shopify | Shopify App Shared Secret

data/reusables/secret-scanning/partner-secret-list-public-repo.md

@@ -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

@@ -129,6 +129,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/', ''))