Merge pull request github#17364 from github/repo-sync

repo sync

Author: Octomerger

.github/workflows/hubber-contribution-help.yml

@@ -41,7 +41,7 @@ jobs:
         run: |
           gh pr comment $PR --body "Thanks so much for opening this PR and contributing to GitHub Docs!
 
-          - When you're ready for the Docs team to review this PR, add the *ready-for-doc-review* label to your PR to the [Docs Content review board](https://github.com/orgs/github/memexes/901?layout=table&groupedBy%5BcolumnId%5D=11024). **Please factor in at least 72 hours for a review, even longer if this is a substantial change.**
+          - When you're ready for the Docs team to review this PR, add the *ready-for-doc-review* label to your PR, and it will be automatically added to the [Docs Content review board](https://github.com/orgs/github/memexes/901?layout=table&groupedBy%5BcolumnId%5D=11024). **Please factor in at least 72 hours for a review, even longer if this is a substantial change.**
           - If this is a major update to the docs, you might want to go back and open an [issue](https://github.com/github/docs-content/issues/new/choose) to ensure we've covered all areas of the docs in these updates. Not doing so may result in delays or inaccurate documentation."
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

components/article/ClientsideRedirectExceptions.tsx

@@ -1,35 +1,67 @@
 import { useEffect } from 'react'
 import { useRouter } from 'next/router'
 
-import restApiOverrides from '../../lib/redirects/static/client-side-rest-api-redirects.json'
-import productOverrides from '../../lib/redirects/static/client-side-product-redirects.json'
-const overrideRedirects: Record<string, string> = { ...restApiOverrides, ...productOverrides }
-
+// We recently moved several rest api operations around
+// in the docs. That means that we are out of sync with
+// the urls defined in the OpenAPI. We will eventually
+// update those urls but for now we want to ensure that
+// we have client-side redirects in place for any urls
+// in the product that link to the rest docs (e.g., error
+// code urls from the apis).
+// The client-side redirects can consist of operation urls
+// being redirected to the new operation url or headings
+// on a page that need to be redirected to the new page (e.g.,
+// /rest/reference/repos#statuses to
+// /rest/reference/commits#commit-statuses)
 export default function ClientSideRedirectExceptions() {
   const router = useRouter()
   useEffect(() => {
-    // We have some one-off redirects for rest api docs
-    // currently those are limited to the repos page, but
-    // that will grow soon as we restructure the rest api docs.
-    // This is a workaround to updating the hardcoded links
-    // directly in the REST API code in a separate repo, which
-    // requires many file changes and teams to sign off.
-    // While the organization is turbulent, we can do this.
-    // Once it's more settled, we can refactor the rest api code
-    // to leverage the OpenAPI urls rather than hardcoded urls.
-    const { hash, pathname } = window.location
+    // Because we have an async call to fetch, it's possible that this
+    // component unmounts before we perform the redirect, however, React
+    // will still try to perform the redirect even after the component
+    // is unmounted. To prevent this, we can use the AbortController signal
+    // to abort the Web request when the component unmounts.
+    const controller = new AbortController()
+    const signal = controller.signal
 
-    // The `hash` will start with a `#` but all the keys in
-    // `overrideRedirects` do not. Hence, this slice.
-    const combined = pathname + hash
-    const overrideKey = combined
+    const { hash, pathname } = window.location
+    // path without a version or language
+    const barePath = pathname
       .replace(`/${router.locale}`, '')
       .replace(`/${router.query.versionId || ''}`, '')
-    const redirectToName = overrideRedirects[overrideKey]
-    if (redirectToName) {
-      const newPathname = combined.replace(overrideKey, redirectToName)
-      router.replace(newPathname)
+
+    async function getRedirect() {
+      try {
+        const sp = new URLSearchParams()
+        sp.set('path', barePath)
+        sp.set('hash', hash.replace(/^#/, ''))
+
+        // call the anchor-redirect endpoint to get the redirect url
+        const response = await fetch(`/anchor-redirect?${sp.toString()}`, {
+          signal,
+        })
+
+        // the response status will always be 200 unless there
+        // was a problem with the fetch request. When the
+        // redirect doesn't exist the json response will be empty
+        if (response.ok) {
+          const { to } = await response.json()
+          if (to) {
+            // we want to redirect with the language and version in tact
+            // so we'll replace the full url's path and hash
+            const fromUrl = pathname + hash
+            const bareUrl = barePath + hash
+            const toUrl = fromUrl.replace(bareUrl, to)
+            router.replace(toUrl)
+          }
+        }
+      } catch (error) {
+        console.warn('Unable to fetch client-side redirect:', error)
+      }
     }
+    getRedirect()
+
+    return () => controller.abort()
   }, [])
 
   return null

data/reusables/organizations/security-manager-beta-note.md

@@ -1,5 +1,5 @@
 {% note %}
 
-**Note:** The security manager role is in public beta and subject to change. This feature is not available for organizations using legacy per-repository billing plans. 
+**Note:** The security manager role is in public beta and subject to change.{% ifversion fpt %} This feature is not available for organizations using legacy per-repository billing plans.{% endif %}
 
 {% endnote %}

lib/redirects/static/client-side-product-redirects.json

@@ -155,6 +155,7 @@
   "/rest/orgs#list-custom-repository-roles-in-an-organization": "/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization",
   "/rest/repos#deploy-keys": "/rest/deploy-keys",
   "/rest/deployments#deploy-keys": "/rest/deploy-keys",
+  "/rest/repos#statuses": "/rest/commits/statuses",
   "/rest/apps#get-the-authenticated-app": "/rest/apps/apps#get-the-authenticated-app",
   "/rest/apps#create-a-github-app-from-a-manifest": "/rest/apps/apps#create-a-github-app-from-a-manifest",
   "/rest/apps#get-a-webhook-configuration-for-an-app": "/rest/apps/webhooks#get-a-webhook-configuration-for-an-app",