Merge pull request #17211 from github/remove-fpt

Remove free-pro-team from URLs

Author: sarahs

content/github/creating-cloning-and-archiving-repositories/about-repositories.md

@@ -22,8 +22,8 @@ Each person and organization can own unlimited repositories and invite an unlimi
 {% endif %}
 
 You can use repositories to manage your work and collaborate with others.
-- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."
-- {% data reusables.discussions.you-can-use-discussions %}
+- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% if currentVersion == "free-pro-team@latest" %}
+- {% data reusables.discussions.you-can-use-discussions %}{% endif %}
 - You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)."
 - You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)."
 

content/github/getting-started-with-github/keyboard-shortcuts.md

@@ -33,7 +33,7 @@ Below is a list of some of the available keyboard shortcuts.
 |-----------|------------
 |<kbd>g</kbd> <kbd>c</kbd> | Go to the **Code** tab
 |<kbd>g</kbd> <kbd>i</kbd> | Go to the **Issues** tab. For more information, see "[About issues](/articles/about-issues)."
-|<kbd>g</kbd> <kbd>p</kbd> | Go to the **Pull requests** tab. For more information, see "[About pull requests](/articles/about-pull-requests)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
+|<kbd>g</kbd> <kbd>p</kbd> | Go to the **Pull requests** tab. For more information, see "[About pull requests](/articles/about-pull-requests)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
 |<kbd>g</kbd> <kbd>a</kbd> | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."{% endif %}
 |<kbd>g</kbd> <kbd>b</kbd> | Go to the **Projects** tab. For more information, see "[About project boards](/articles/about-project-boards)."
 |<kbd>g</kbd> <kbd>w</kbd> | Go to the **Wiki** tab. For more information, see "[About wikis](/articles/about-wikis)."

content/github/managing-your-work-on-github/about-issues.md

@@ -14,9 +14,11 @@ versions:
 
 You can collect user feedback, report software bugs, and organize tasks you'd like to accomplish with issues in a repository. Issues can act as more than just a place to report software bugs.
 
+{% if currentVersion == "free-pro-team@latest" %}
 Other conversations are more suitable for discussions. {% data reusables.discussions.you-can-use-discussions %}
 
 {% data reusables.discussions.you-cannot-convert-a-discussion %}
+{% endif %}
 
 {% data reusables.pull_requests.close-issues-using-keywords %}
 

lib/find-page-in-version.js

@@ -1,69 +1,17 @@
-const slash = require('slash')
-const patterns = require('./patterns')
-const allVersions = Object.keys(require('./all-versions'))
-const { getVersionedPathWithLanguage } = require('./path-utils')
+const { getLanguageCode } = require('./patterns')
 
-module.exports = function findPage (href, pageMap, redirects = {}, languageCode = 'en', sourceLanguage = null) {
-  // Convert Windows backslashes to forward slashes
-  // remove trailing slash
-  href = slash(href).replace(patterns.trailingSlash, '$1')
+module.exports = function findPage (href, pageMap, redirects) {
+  // remove any fragments
+  href = href.replace(/#.*$/, '')
 
-  // do an initial lookup on the path as-is
-  let page = pageMap[removeFragment(href)]
+  // find the page
+  const page = pageMap[href] || pageMap[redirects[href]]
   if (page) return page
 
-  // check all potential versions
-  const versionedPathsToCheck = [...new Set(allVersions.map(version => {
-    return getVersionedPathWithLanguage(href, version, languageCode)
-  }))]
+  // get the current language
+  const currentLang = getLanguageCode.test(href) ? href.match(getLanguageCode)[1] : 'en'
 
-  // get the first found path of the page (account for redirects)
-  let pathToPage = versionedPathsToCheck.find(path => {
-    path = redirects[path] || path
-    return pageMap[removeFragment(path)]
-  })
-
-  // need to account for redirects again
-  pathToPage = redirects[pathToPage] || pathToPage
-
-  // try finding the page again
-  page = pageMap[removeFragment(pathToPage)]
-
-  if (page) return page
-
-  if (process.env.NODE_ENV !== 'test' && languageCode === 'en') {
-    const error = sourceLanguage
-      ? `href not found in ${sourceLanguage} pages (no English fallback found)`
-      : 'href not found'
-
-    // if English page can't be found, throw an error
-    // because these errors should be surfaced and fixed right away
-    if (sourceLanguage === 'en') {
-      throw new Error(`${error}: ${href}`)
-    } else {
-      console.error(`${error}: ${href}`)
-    }
-  }
-
-  // if English page can't be found in tests, don't throw an error
-  // or the tests will stall
-  if (process.env.NODE_ENV === 'test' && languageCode === 'en') {
-    if (sourceLanguage === 'en') console.log(`href not found: ${href}`)
-    return null
-  }
-
-  // if localized page can't be found, fall back to English
-  // because localized content is not yet synced
-  if (languageCode !== 'en') {
-    // pass the source language so we can surface it in error messages
-    return findPage(href, pageMap, redirects, 'en', languageCode)
-  }
-}
-
-// some redirects include fragments
-// need to remove the fragment to find the page
-function removeFragment (path) {
-  if (!path) return
-
-  return path.replace(/#.*$/, '')
+  // try to fall back to English if the translated page can't be found
+  const englishHref = href.replace(`/${currentLang}/`, '/en/')
+  return pageMap[englishHref] || pageMap[redirects[englishHref]]
 }

lib/find-page.js

@@ -1,5 +1,6 @@
-const findPageInVersion = require('../lib/find-page-in-version')
-const { getVersionedPathWithLanguage } = require('../lib/path-utils')
+const path = require('path')
+const findPage = require('./find-page')
+const nonEnterpriseDefaultVersion = require('./non-enterprise-default-version')
 
 // rawLinks is an array of paths: [ '/foo' ]
 // we need to convert it to an array of localized objects: [ { href: '/en/foo', title: 'Foo', intro: 'Description here' } ]
@@ -9,11 +10,11 @@ module.exports = async (rawLinks, context, additionalProperties = []) => {
   const links = []
 
   for (const link of rawLinks) {
-    const href = link.href
-      ? getVersionedPathWithLanguage(link.href, context.currentVersion, context.currentLanguage)
-      : getVersionedPathWithLanguage(link, context.currentVersion, context.currentLanguage)
+    const linkPath = link.href || link
+    const version = context.currentVersion === 'homepage' ? nonEnterpriseDefaultVersion : context.currentVersion
+    const href = path.join('/', context.currentLanguage, version, linkPath)
 
-    const linkedPage = findPageInVersion(href, context.pages, context.redirects, context.currentLanguage, context.currentVersion)
+    const linkedPage = findPage(href, context.pages, context.redirects)
     if (!linkedPage) continue
 
     const opts = { textOnly: true, encodeEntities: true }

lib/get-link-data.js

@@ -2,9 +2,9 @@ const path = require('path')
 const assert = require('assert')
 const Liquid = require('liquid')
 const liquid = new Liquid.Engine()
-const { getPathWithLanguage } = require('../path-utils')
 const LiquidTag = require('./liquid-tag')
-const findPageInVersion = require('../find-page-in-version')
+const findPage = require('../find-page')
+const getApplicableVersions = require('../get-applicable-versions')
 
 // This class supports a set of link tags. Each tag expects one parameter, a language-agnostic href:
 //
@@ -52,17 +52,21 @@ module.exports = class Link extends LiquidTag {
     }
 
     // add language code
-    fullPath = getPathWithLanguage(fullPath, ctx.currentLanguage)
+    fullPath = path.join('/', ctx.currentLanguage, fullPath)
 
     // find the page based on the full path
-    const page = findPageInVersion(fullPath, ctx.pages, ctx.redirects, ctx.currentLanguage, ctx.currentVersion)
+    const page = findPage(fullPath, ctx.pages, ctx.redirects)
 
-    // if found page should NOT render in current version, return early with an empty string
-    // also return if it's a hidden link on a non-hidden page (hidden links on hidden pages are OK)
+    // return an empty string if it's a hidden link on a non-hidden page (hidden links on hidden pages are OK)
     if (!page || (page.hidden && !ctx.page.hidden)) {
       return ''
     }
 
+    // also return early if the found page should not render in current version
+    if (!getApplicableVersions(page.versions).includes(ctx.currentVersion)) {
+      return ''
+    }
+
     // find and render the props
     const title = await page.renderProp('title', ctx, { textOnly: true, encodeEntities: true })
 

lib/liquid-tags/link.js

@@ -1,77 +1,11 @@
 const slash = require('slash')
 const path = require('path')
 const patterns = require('./patterns')
-const { deprecated, latest } = require('./enterprise-server-releases')
+const { latest } = require('./enterprise-server-releases')
 const allProducts = require('./all-products')
 const allVersions = require('./all-versions')
 const supportedVersions = new Set(Object.keys(allVersions))
-const { getNewVersionedPath } = require('./old-versions-utils')
-
-// This function constructs an appropriate versioned path for any given HREF.
-// NOTE: this gets called by findPage and various other functions, and
-// has to return a proper versioned link given a wide variety of incoming
-// modern or legacy-formatted links, so it is somewhat overloaded. At some point
-// this could probably be broken up into separate functions to handle different incoming
-// paths. But it is currently optimized to handle lots of edge cases.
-function getVersionedPathWithoutLanguage (href, version) {
-  // Start clean without language code or trailing slash
-  href = getPathWithoutLanguage(href.replace(patterns.trailingSlash, '$1'))
-
-  // If this is an old versioned path that includes a deprecated version, do not change!
-  // example: /enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release
-  const oldEnterpriseVersionNumber = href.match(patterns.getEnterpriseVersionNumber)
-  if (oldEnterpriseVersionNumber && deprecated.includes(oldEnterpriseVersionNumber[1])) {
-    return href
-  }
-
-  // Try to derive the current version from the path
-  // example: enterprise-server@2.22 or free-pro-team@latest
-  let versionFromPath = getVersionStringFromPath(href)
-
-  // If a supported version was found, add it to the path so we can go through the rest of the checks
-  if (supportedVersions.has(versionFromPath)) {
-    href = href.replace(href.split('/')[1], versionFromPath)
-  }
-
-  // If a currently supported version was NOT found...
-  let productObjectFromPath
-  if (!supportedVersions.has(versionFromPath)) {
-    // First check if the segment is instead a current product;
-    // example: /admin/foo or /desktop/foo
-    productObjectFromPath = allProducts[versionFromPath]
-
-    // If so, add the first supported version for that product to the href
-    // (this is just to get a path with all the expected segments; the version will be updated later if needed)
-    if (productObjectFromPath) {
-      href = path.join('/', productObjectFromPath.versions[0], href)
-      versionFromPath = productObjectFromPath.versions[0]
-    } else {
-      // Otherwise, this may be an old path that should be converted to new path;
-      // OLD: /enterprise/2.22/admin/installation OR /enterprise/admin/installation
-      // NEW: /enterprise-server@2.22/admin/installation
-      href = getNewVersionedPath(href)
-      versionFromPath = getVersionStringFromPath(href)
-    }
-  }
-
-  // If not previously found, derive the product object from the path (e.g., github or admin)
-  if (!productObjectFromPath) {
-    productObjectFromPath = getProductObjectFromPath(href)
-  }
-
-  // If the product's versions don't include the specified version, nothing to change!
-  if (productObjectFromPath && !productObjectFromPath.versions.includes(version)) {
-    return slash(href)
-  }
-
-  // Update the version and return the path
-  return slash(href.replace(versionFromPath, version))
-}
-
-// Add language code to a versioned path
-function getVersionedPathWithLanguage (href, version, languageCode) {
-  return getPathWithLanguage(getVersionedPathWithoutLanguage(href, version), languageCode)
-}
+const nonEnterpriseDefaultVersion = require('./non-enterprise-default-version')
 
 // Add the language to the given HREF
 // /articles/foo -> /en/articles/foo
@@ -100,9 +34,15 @@ function getVersionStringFromPath (href) {
     return 'homepage'
   }
 
-  // Check if the first segment is a supported version
+  // Get the first segment
   const versionFromPath = href.split('/')[1]
 
+  // If the first segment is a supported product, assume this is FPT
+  if (allProducts[versionFromPath]) {
+    return nonEnterpriseDefaultVersion
+  }
+
+  // Otherwise, check if it's a supported version
   if (supportedVersions.has(versionFromPath)) {
     return versionFromPath
   }
@@ -133,9 +73,12 @@ function getVersionObjectFromPath (href) {
 // Return the product segment from the path
 function getProductStringFromPath (href) {
   href = getPathWithoutLanguage(href)
-  const productString = href.split('/')[2]
 
-  return productString || 'homepage'
+  if (href === '/') return 'homepage'
+
+  return allProducts[href.split('/')[2]]
+    ? href.split('/')[2]
+    : href.split('/')[1]
 }
 
 // Return the corresponding object for the product segment in a path
@@ -146,8 +89,6 @@ function getProductObjectFromPath (href) {
 }
 
 module.exports = {
-  getVersionedPathWithLanguage,
-  getVersionedPathWithoutLanguage,
   getPathWithLanguage,
   getPathWithoutLanguage,
   getPathWithoutVersion,

lib/path-utils.js

@@ -39,6 +39,7 @@ module.exports = {
   oldEnterprisePath: /\/([a-z]{2}\/)?(enterprise\/)?(\S+?@(\S+?\/))?(\d.\d+\/)?(user[/$])?/,
   // new versioning format patterns
   adminProduct: /\/admin(\/|$|\?|#)/,
+  insightsProduct: /\/insights(\/|$|\?|#)/,
   enterpriseServer: /\/enterprise-server@/,
   getEnterpriseServerNumber: /enterprise-server@(\d+\.\d+)/
 }

lib/patterns.js

@@ -1,7 +1,6 @@
 const assert = require('assert')
 const path = require('path')
 const patterns = require('./patterns')
-const pathUtils = require('./path-utils')
 const getApplicableVersions = require('./get-applicable-versions')
 const allVersions = require('./all-versions')
 
@@ -14,7 +13,8 @@ class Permalink {
 
     const permalinkSuffix = this.constructor.relativePathToSuffix(relativePath)
 
-    this.href = pathUtils.getVersionedPathWithLanguage(permalinkSuffix, pageVersion, languageCode)
+    this.href = path.join('/', languageCode, pageVersion, permalinkSuffix)
+      .replace(patterns.trailingSlash, '$1')
 
     this.pageVersionTitle = allVersions[pageVersion].versionTitle
 
@@ -49,7 +49,6 @@ class Permalink {
     return '/' + relativePath
       .replace('index.md', '')
       .replace('.md', '')
-      .replace(patterns.trailingSlash, '$1')
   }
 }