refactor early access breadcrumbs (#26558)

* refactor early access breadcrumbs

* Update permissions metadata to include users and teams with explicit access

* Inform users of permission requirement for dependabot alerts

* Apply suggestions from code review

* version previews (github#26571)

* update search indexes

* New translation batch for pt (github#26591)

* Add crowdin translations

* Run script/i18n/homogenize-frontmatter.js

* Run script/i18n/fix-translation-errors.js

* Run script/i18n/lint-translation-files.js --check rendering

* run script/i18n/reset-files-with-broken-liquid-tags.js --language=pt

* run script/i18n/reset-known-broken-translation-files.js

* Update subcategories for Codespaces (github#25812)

* Version actions for GHES, use reusables (github#26004)

Co-authored-by: Kevin Heis <[email protected]>
Co-authored-by: Sarah Edwards <[email protected]>

* New translation batch for ja (github#26599)

* Add crowdin translations

* Run script/i18n/homogenize-frontmatter.js

* Run script/i18n/lint-translation-files.js --check rendering

* run script/i18n/reset-files-with-broken-liquid-tags.js --language=ja

* run script/i18n/reset-known-broken-translation-files.js

* Check in ja CSV report

Co-authored-by: Grace Park <[email protected]>

* New translation batch for cn (github#26598)

* Add crowdin translations

* Run script/i18n/homogenize-frontmatter.js

* Run script/i18n/lint-translation-files.js --check rendering

* run script/i18n/reset-files-with-broken-liquid-tags.js --language=cn

* run script/i18n/reset-known-broken-translation-files.js

* Check in cn CSV report

Co-authored-by: Grace Park <[email protected]>

* New translation batch for es (github#26597)

* Add crowdin translations

* Run script/i18n/homogenize-frontmatter.js

* Run script/i18n/fix-translation-errors.js

* Run script/i18n/lint-translation-files.js --check rendering

* run script/i18n/reset-files-with-broken-liquid-tags.js --language=es

* run script/i18n/reset-known-broken-translation-files.js

* Check in es CSV report

Co-authored-by: Grace Park <[email protected]>

* update search indexes

* Rename xxtest-devcontainer.json to devcontainer.json

* Delete .devcontainer/java-environment directory

* Delete .devcontainer/ruby-environment directory

* Update development.md

* Update CONTRIBUTING.md

* Add link to troubleshooting (github#26514)

* update search indexes

* fix old tests

Co-authored-by: Anthony Swierkosz <[email protected]>
Co-authored-by: mc <[email protected]>
Co-authored-by: Sarah Edwards <[email protected]>
Co-authored-by: GitHub Actions <[email protected]>
Co-authored-by: docubot <[email protected]>
Co-authored-by: Brian McManus <[email protected]>
Co-authored-by: Lucas Costi <[email protected]>
Co-authored-by: Kevin Heis <[email protected]>
Co-authored-by: Grace Park <[email protected]>
Co-authored-by: hubwriter <[email protected]>

Author: 11 people

middleware/contextualizers/breadcrumbs.js

@@ -2,7 +2,8 @@ import liquid from '../../lib/render-content/liquid.js'
 
 export default async function breadcrumbs(req, res, next) {
   if (!req.context.page) return next()
-  if (req.context.page.hidden) return next()
+  const isEarlyAccess = req.context.page.relativePath.startsWith('early-access')
+  if (req.context.page.hidden && !isEarlyAccess) return next()
 
   req.context.breadcrumbs = []
 
@@ -11,16 +12,40 @@ export default async function breadcrumbs(req, res, next) {
     return next()
   }
 
-  req.context.breadcrumbs = await getBreadcrumbs(req)
+  req.context.breadcrumbs = await getBreadcrumbs(req, isEarlyAccess)
 
   return next()
 }
 
-async function getBreadcrumbs(req) {
+async function getBreadcrumbs(req, isEarlyAccess = false) {
   const crumbs = []
   const { currentPath, currentVersion } = req.context
   const split = currentPath.split('/')
-  while (split.length > 2 && split[split.length - 1] !== currentVersion) {
+  let cutoff = 2
+  if (isEarlyAccess) {
+    // When in Early access docs consider the "root" be much higher.
+    // E.g. /en/early-access/github/migrating/understanding/about
+    // we only want it start at /migrating/understanding/about
+    // Essentially, we're skipping "/early-access" and its first
+    // top-level like "/github"
+    cutoff++
+
+    // The only exception to this rule is for the
+    // /{version}/early-access/insights/... URLs because they're a
+    // bit different.
+    // If there are more known exceptions, extend this conditional.
+    if (!split.includes('insights')) {
+      cutoff++
+    }
+
+    // If the URL is early access AND has a version in it, go even further
+    // E.g. /en/[email protected]/early-access/admin/hosting/mysql
+    // should start at /hosting/mysql.
+    if (currentVersion !== 'free-pro-team@latest') {
+      cutoff++
+    }
+  }
+  while (split.length > cutoff && split[split.length - 1] !== currentVersion) {
     const href = split.join('/')
     const page = req.context.pages[href]
     if (page) {

middleware/contextualizers/early-access-breadcrumbs.js

@@ -52,7 +52,6 @@ import layout from './contextualizers/layout.js'
 import currentProductTree from './contextualizers/current-product-tree.js'
 import genericToc from './contextualizers/generic-toc.js'
 import breadcrumbs from './contextualizers/breadcrumbs.js'
-import earlyAccessBreadcrumbs from './contextualizers/early-access-breadcrumbs.js'
 import features from './contextualizers/features.js'
 import productExamples from './contextualizers/product-examples.js'
 import featuredLinks from './featured-links.js'
@@ -297,11 +296,6 @@ export default function (app) {
   app.use(instrument(currentProductTree, './contextualizers/current-product-tree'))
   app.use(asyncMiddleware(instrument(genericToc, './contextualizers/generic-toc')))
   app.use(asyncMiddleware(instrument(breadcrumbs, './contextualizers/breadcrumbs')))
-  app.use(
-    asyncMiddleware(
-      instrument(earlyAccessBreadcrumbs, './contextualizers/early-access-breadcrumbs')
-    )
-  )
   app.use(asyncMiddleware(instrument(features, './contextualizers/features')))
   app.use(asyncMiddleware(instrument(productExamples, './contextualizers/product-examples')))
 

middleware/index.js

@@ -104,10 +104,8 @@ describe('breadcrumbs', () => {
       const $breadcrumbTitles = $('[data-testid=breadcrumbs] [data-testid=breadcrumb-title]')
       const $breadcrumbLinks = $('[data-testid=breadcrumbs] a')
 
-      expect($breadcrumbTitles).toHaveLength(4)
+      expect($breadcrumbTitles).toHaveLength(0)
       expect($breadcrumbLinks).toHaveLength(4)
-      expect($breadcrumbTitles[0].children[0].data).toBe('Early Access documentation')
-      expect($breadcrumbTitles[1].children[0].data).toBe('GitHub')
       expect($breadcrumbLinks[0].attribs.title).toBe(
         'Enforcing best practices with GitHub Policies'
       )