Merge branch 'main' into patch-2

Author: ramyaparimi

.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 }}

assets/images/help/codespaces/add-constraint-dropdown-ports.png

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

assets/images/help/codespaces/add-constraint-dropdown-timeout.png

@@ -253,8 +253,7 @@ When code scanning identifies a problem in a pull request, you can review the hi
 code and resolve the alert. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests)."
 
 If you have write permission to a repository you can manage code scanning alerts for that
-repository. With write permission to a repository, you can view, fix, dismiss, or delete alerts for potential
-vulnerabilities or errors in your repository's code. For more information, see "[Managing code scanning alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository)."
+repository. With write permission to a repository, {% if delete-code-scanning-alerts %}you can view, fix, dismiss, or delete alerts {% else %}you can view, fix, or dismiss alerts{% endif %} for potential vulnerabilities or errors in your repository's code. For more information, see "[Managing code scanning alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository)."
 
 #### Generate reports of {% data variables.product.prodname_code_scanning %} alerts
 

assets/images/help/codespaces/add-constraint-dropdown.png

@@ -14,9 +14,14 @@ redirect_from:
   - /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage
 shortTitle: MinIO Gateway for NAS storage
 ---
-## Prerequisites
 
-{% data reusables.actions.enterprise-s3-support-warning %}
+{% warning %}
+
+**Warning**: MinIO has announced removal of MinIO Gateways. Starting June 1st, 2022, support and bug fixes for the current MinIO NAS Gateway implementation will only be available for paid customers via their LTS support contract. If you want to continue using MinIO Gateways with {% data variables.product.prodname_actions %}, we recommend moving to MinIO LTS support. For more information, see [Scheduled removal of MinIO Gateway for GCS, Azure, HDFS](https://github.com/minio/minio/issues/14331) in the minio/minio repository.
+
+{% endwarning %}
+
+## Prerequisites
 
 Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
 

assets/images/help/codespaces/edit-timeout-constraint.png

@@ -48,7 +48,7 @@ Each action is a repository in the `actions` organization, and each action repos
 
 **Notes:** 
 - When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[Setting up the tool cache on self-hosted runners without internet access](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)."
-- Upgrades to {% data variables.product.product_name %} will not result in the bundled actions being updated.
+- Bundled actions are automatically updated when {% data variables.product.product_name %} is updated.
 
 {% endnote %}