Merge branch 'main' into fix-graphql-scopes

Author: cmwilson21

.github/actions-scripts/msft-create-translation-batch-pr.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-import fs from 'fs'
 import github from '@actions/github'
 
 const OPTIONS = Object.fromEntries(
@@ -33,7 +32,6 @@ const {
   BASE,
   HEAD,
   LANGUAGE,
-  BODY_FILE,
   GITHUB_TOKEN,
 } = OPTIONS
 const [OWNER, REPO] = GITHUB_REPOSITORY.split('/')
@@ -121,7 +119,7 @@ async function main() {
     title: TITLE,
     base: BASE,
     head: HEAD,
-    body: fs.readFileSync(BODY_FILE, 'utf8'),
+    body: `New translation batch for ${LANGUAGE}. You can see the log in [\`translations/log/${LANGUAGE}-resets.csv\`](https://github.com/${OWNER}/${REPO}/tree/${HEAD}/translations/log/${LANGUAGE}-resets.csv).`,
     labels: ['translation-batch', `translation-batch-${LANGUAGE}`],
     owner: OWNER,
     repo: REPO,

.github/actions-scripts/prune-for-preview-env.sh

@@ -19,5 +19,5 @@ mkdir translations
 # need these legacy redirects. Only the redirects from
 # front-matter will be at play.
 # These static redirects json files are notoriously large
-echo '[]' > lib/redirects/static/archived-frontmatter-fallbacks.json
+echo '[]' > lib/redirects/static/archived-frontmatter-valid-urls.json
 echo '{}' > lib/redirects/static/archived-redirects-from-213-to-217.json

.github/workflows/dry-run-elasticsearch-indexing.yml

@@ -0,0 +1,73 @@
+name: Dry run Elasticsearch indexing
+
+# **What it does**: Tests to index records into a local Elasticsearch
+# **Why we have it**: To make sure the indexing code works.
+# **Who does it impact**: Docs engineering.
+
+on:
+  push:
+    branches:
+      - gh-readonly-queue/main/**
+  pull_request:
+    paths:
+      - script/search/index-elasticsearch.mjs
+      - 'package*.json'
+      - .github/workflows/dry-run-elasticsearch-indexing.yml
+
+permissions:
+  contents: read
+
+jobs:
+  dry-run-elasticsearch-indexing:
+    # Avoid github/docs and forks of it
+    if: github.repository == 'github/docs-internal'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: getong/elasticsearch-action@95b501ab0c83dee0aac7c39b7cea3723bef14954
+        with:
+          elasticsearch version: '8.2.0'
+          host port: 9200
+          container port: 9200
+          host node port: 9300
+          node port: 9300
+          discovery type: 'single-node'
+
+      - name: Checkout
+        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        with:
+          lfs: 'true'
+
+      - name: Check out LFS objects
+        run: git lfs checkout
+
+      - name: Setup node
+        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561
+        with:
+          node-version: 16.15.x
+          cache: npm
+
+      - name: Install
+        run: npm ci
+
+      # Serves two purposes;
+      # 1. Be confident that the Elasticsearch server start-up worked at all
+      # 2. Sometimes Elasticsearch will bind to the port but still not
+      # technically be ready. By using `curl --retry` we can know it's
+      # also genuinely ready to use.
+      - name: Ping Elasticsearch
+        run: curl --retry-connrefused --retry 5 -I http://localhost:9200/
+
+      - name: Index some
+        env:
+          ELASTICSEARCH_URL: 'http://localhost:9200'
+        run: |
+          ./script/search/index-elasticsearch.mjs --verbose \
+          -l en -l ja \
+          -V dotcom -V ghes-3.5
+
+      - name: Show created indexes and aliases
+        run: |
+          curl http://localhost:9200/_cat/indices?v
+          curl http://localhost:9200/_cat/aliases?v

.github/workflows/msft-create-translation-batch-pr.yml

@@ -30,26 +30,47 @@ jobs:
       max-parallel: 1
       matrix:
         include:
-          # TODO: replace language_repos with actual repos once created
-          # - language: pt
-          #   crowdin_language: pt-BR
-          #   language_dir: translations/pt-BR
-          #   language_repo: github/docs-translations-pt-br
-
           - language: es
             crowdin_language: es-ES
             language_dir: translations/es-ES
-            language_repo: github/docs-localization-test-es-es
-
-          # - language: cn
-          #   crowdin_language: zh-CN
-          #   language_dir: translations/zh-CN
-          #   language_repo: github/docs-translations-zh-cn
-
-          # - language: ja
-          #   crowdin_language: ja
-          #   language_dir: translations/ja-JP
-          #   language_repo: github/docs-translations-ja-jp
+            language_repo: github/docs-internal.es-es
+
+          - language: ja
+            crowdin_language: ja-JP
+            language_dir: translations/ja-JP
+            language_repo: github/docs-internal.ja-jp
+
+          - language: pt
+            crowdin_language: pt-BR
+            language_dir: translations/pt-BR
+            language_repo: github/docs-internal.pt-br
+
+          - language: cn
+            crowdin_language: zh-CN
+            language_dir: translations/zh-CN
+            language_repo: github/docs-internal.zh-cn
+
+          # We'll be ready to add the following languages in a future effort.
+
+          # - language: ru
+          #   crowdin_language: ru-RU
+          #   language_dir: translations/ru-RU
+          #   language_repo: github/docs-internal.ru-ru
+
+          # - language: ko
+          #   crowdin_language: ko-KR
+          #   language_dir: translations/ko-KR
+          #   language_repo: github/docs-internal.ko-kr
+
+          # - language: fr
+          #   crowdin_language: fr-FR
+          #   language_dir: translations/fr-FR
+          #   language_repo: github/docs-internal.fr-fr
+
+          # - language: de
+          #   crowdin_language: de-DE
+          #   language_dir: translations/de-DE
+          #   language_repo: github/docs-internal.de-de
 
     # TODO: replace the branch name
     steps:

README.md

@@ -60,4 +60,4 @@ When using the GitHub logos, be sure to follow the [GitHub logo guidelines](http
 
 ## Thanks :purple_heart:
 
-Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles:!
+Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:!

assets/images/enterprise/site-admin-settings/user-dismissible-checkbox.png

@@ -2,8 +2,9 @@ import React, { useState, useEffect, useRef, ReactNode, RefObject } from 'react'
 import { useRouter } from 'next/router'
 import useSWR from 'swr'
 import cx from 'classnames'
-import { ActionList, DropdownMenu, Flash, Label } from '@primer/react'
-import { ItemInput } from '@primer/react/lib/ActionList/List'
+import { Flash, Label, ActionList, ActionMenu } from '@primer/react'
+import { ItemInput } from '@primer/react/lib/deprecated/ActionList/List'
+import { InfoIcon } from '@primer/octicons-react'
 
 import { useTranslation } from 'components/hooks/useTranslation'
 import { sendEvent, EventType } from 'components/lib/events'
@@ -323,12 +324,13 @@ function ShowSearchResults({
   debug: boolean
   query: string
 }) {
-  const { t } = useTranslation('search')
+  const { t } = useTranslation(['pages', 'search'])
   const router = useRouter()
   const { currentVersion } = useVersion()
   const { allVersions } = useMainContext()
   const searchVersion = allVersions[currentVersion].versionTitle
   const [selectedVersion, setSelectedVersion] = useState<ItemInput | undefined>()
+  const currentVersionPathSegment = currentVersion === DEFAULT_VERSION ? '' : `/${currentVersion}`
 
   const latestVersions = new Set(
     Object.keys(allVersions)
@@ -397,12 +399,32 @@ function ShowSearchResults({
             >
               Select version:
             </p>
-            <DropdownMenu
-              placeholder={searchVersion}
-              items={searchVersions}
-              selectedItem={selectedVersion}
-              onChange={setSelectedVersion}
-            />
+            <ActionMenu>
+              <ActionMenu.Button sx={{ display: 'inline-block' }}>
+                {selectedVersion ? selectedVersion.text : searchVersion}
+              </ActionMenu.Button>
+              <ActionMenu.Overlay>
+                <ActionList selectionVariant="single">
+                  {searchVersions.map((searchVersion) => {
+                    return (
+                      <ActionList.Item
+                        onSelect={() => setSelectedVersion(searchVersion)}
+                        key={searchVersion.key}
+                      >
+                        {searchVersion.text}
+                      </ActionList.Item>
+                    )
+                  })}
+
+                  <ActionList.LinkItem
+                    className="f6"
+                    href={`/${router.locale}${currentVersionPathSegment}/get-started/learning-about-github/about-versions-of-github-docs`}
+                  >
+                    {t('about_versions')} <InfoIcon />
+                  </ActionList.LinkItem>
+                </ActionList>
+              </ActionMenu.Overlay>
+            </ActionMenu>
           </div>
         </div>
         {/* We might have results AND isLoading. For example, the user typed
@@ -419,67 +441,63 @@ function ShowSearchResults({
           {t('matches_displayed')}: {results.length === 0 ? t('no_results') : results.length}
         </p>
 
-        <ActionList
-          items={results.map(({ url, breadcrumbs, title, content, score, popularity }) => {
-            return {
-              key: url,
-              text: title,
-              renderItem: () => (
-                <ActionList.Item as="div">
-                  <Link href={url} className="no-underline color-fg-default">
-                    <li
-                      data-testid="search-result"
-                      className={cx('list-style-none', styles.resultsContainer)}
-                    >
-                      <div className={cx('py-2 px-3')}>
-                        {/* Breadcrumbs in search records don't include the page title. These fields may contain <mark> elements that we need to render */}
-                        <Label variant="small" sx={{ bg: 'accent.emphasis' }}>
-                          {breadcrumbs.length === 0
-                            ? title.replace(/<\/?[^>]+(>|$)|(\/)/g, '')
-                            : breadcrumbs
-                                .split(' / ')
-                                .slice(0, 1)
-                                .join(' ')
-                                .replace(/<\/?[^>]+(>|$)|(\/)/g, '')}
-                        </Label>
-                        {debug && (
-                          <small className="float-right">
-                            score: {score.toFixed(4)} popularity: {popularity.toFixed(4)}
-                          </small>
-                        )}
-                        <h2
-                          className={cx('mt-2 text-normal f3 d-block')}
-                          dangerouslySetInnerHTML={{
-                            __html: title,
-                          }}
-                        />
-                        <div
-                          className={cx(styles.searchResultContent, 'mt-1 d-block overflow-hidden')}
-                          style={{ maxHeight: '2.5rem' }}
-                          dangerouslySetInnerHTML={{ __html: content }}
-                        />
-                        <div
-                          className={'d-block mt-2 opacity-70 text-small'}
-                          dangerouslySetInnerHTML={
-                            breadcrumbs.length === 0
-                              ? { __html: `${title}`.replace(/<\/?[^>]+(>|$)|(\/)/g, '') }
-                              : {
-                                  __html: breadcrumbs
-                                    .split(' / ')
-                                    .slice(0, breadcrumbs.length - 1)
-                                    .join(' / ')
-                                    .replace(/<\/?[^>]+(>|$)/g, ''),
-                                }
-                          }
-                        />
-                      </div>
-                    </li>
-                  </Link>
-                </ActionList.Item>
-              ),
-            }
+        <ActionList variant="full">
+          {results.map(({ url, breadcrumbs, title, content, score, popularity }) => {
+            return (
+              <ActionList.Item className="width-full" key={url}>
+                <Link href={url} className="no-underline color-fg-default">
+                  <div
+                    data-testid="search-result"
+                    className={cx('list-style-none', styles.resultsContainer)}
+                  >
+                    <div className={cx('py-2 px-3')}>
+                      {/* Breadcrumbs in search records don't include the page title. These fields may contain <mark> elements that we need to render */}
+                      <Label size="small" variant="accent">
+                        {breadcrumbs.length === 0
+                          ? title.replace(/<\/?[^>]+(>|$)|(\/)/g, '')
+                          : breadcrumbs
+                              .split(' / ')
+                              .slice(0, 1)
+                              .join(' ')
+                              .replace(/<\/?[^>]+(>|$)|(\/)/g, '')}
+                      </Label>
+                      {debug && (
+                        <small className="float-right">
+                          score: {score.toFixed(4)} popularity: {popularity.toFixed(4)}
+                        </small>
+                      )}
+                      <h2
+                        className={cx('mt-2 text-normal f3 d-block')}
+                        dangerouslySetInnerHTML={{
+                          __html: title,
+                        }}
+                      />
+                      <div
+                        className={cx(styles.searchResultContent, 'mt-1 d-block overflow-hidden')}
+                        style={{ maxHeight: '2.5rem' }}
+                        dangerouslySetInnerHTML={{ __html: content }}
+                      />
+                      <div
+                        className={'d-block mt-2 opacity-70 text-small'}
+                        dangerouslySetInnerHTML={
+                          breadcrumbs.length === 0
+                            ? { __html: `${title}`.replace(/<\/?[^>]+(>|$)|(\/)/g, '') }
+                            : {
+                                __html: breadcrumbs
+                                  .split(' / ')
+                                  .slice(0, breadcrumbs.length - 1)
+                                  .join(' / ')
+                                  .replace(/<\/?[^>]+(>|$)/g, ''),
+                              }
+                        }
+                      />
+                    </div>
+                  </div>
+                </Link>
+              </ActionList.Item>
+            )
           })}
-        />
+        </ActionList>
       </div>
     )
     return <div>{ActionListResults}</div>

assets/images/help/codespaces/automatically-install-dotfiles.png

@@ -135,18 +135,7 @@ export const PlatformPicker = ({ variant = 'subnav' }: Props) => {
             <UnderlineNav.Link
               key={option.id}
               data-platform={option.id}
-              as="button"
               selected={option.id === currentPlatform}
-              // Temporary fix: This should be removed when this merges: PR 24123
-              sx={{
-                color: 'var(--color-fg-default)',
-                '&.selected': { color: 'var(--color-fg-default)' },
-                ':hover': { color: 'var(--color-fg-default)' },
-                ':focus': {
-                  color: 'var(--color-fg-default)',
-                  outline: '-webkit-focus-ring-color auto 1px;',
-                },
-              }}
               onClick={() => {
                 onClickPlatform(option.id)
               }}