Merge branch 'main' into mntlty/merge_queue_action

.github/workflows/check-all-english-links.yml

@@ -62,7 +62,7 @@ jobs:
           # Don't care about CDN caching image URLs
           DISABLE_REWRITE_ASSET_URLS: true
         run: |
-          node server.mjs > /tmp/stdout.log 2> /tmp/stderr.log &
+          node server.js > /tmp/stdout.log 2> /tmp/stderr.log &
           sleep 6
           curl --retry-connrefused --retry 5 -I http://localhost:4000/
 

.github/workflows/check-broken-links-github-github.yml

@@ -64,7 +64,7 @@ jobs:
           DISABLE_RENDERING_CACHE: true
         run: |
 
-          node server.mjs &
+          node server.js &
           sleep 5
           curl --retry-connrefused --retry 3 -I http://localhost:4000/
 

.github/workflows/code-lint.yml

@@ -15,7 +15,7 @@ on:
       - '**.yaml'
       - '**.yml'
       - '**.scss'
-      - .eslintrc.js
+      - .eslintrc.cjs
       # In case something like eslint or tsc or prettier upgrades
       - 'package-lock.json'
       # Ultimately, for debugging this workflow itself

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

@@ -8,7 +8,7 @@ on:
   merge_group:
   pull_request:
     paths:
-      - script/search/index-elasticsearch.mjs
+      - script/search/index-elasticsearch.js
       - 'package*.json'
       - .github/workflows/dry-run-elasticsearch-indexing.yml
 
@@ -61,7 +61,7 @@ jobs:
         env:
           ELASTICSEARCH_URL: 'http://localhost:9200'
         run: |
-          ./script/search/index-elasticsearch.mjs --verbose \
+          ./script/search/index-elasticsearch.js --verbose \
           -l en -l ja \
           -V dotcom -V ghes-3.5
 

.github/workflows/link-check-all.yml

@@ -53,7 +53,7 @@ jobs:
           # Don't care about CDN caching image URLs
           DISABLE_REWRITE_ASSET_URLS: true
         run: |
-          ./script/rendered-content-link-checker.mjs \
+          ./script/rendered-content-link-checker.js \
             --language en \
             --max 100 \
             --check-anchors \
@@ -66,7 +66,7 @@ jobs:
           # Don't care about CDN caching image URLs
           DISABLE_REWRITE_ASSET_URLS: true
         run: |
-          ./script/rendered-content-link-checker.mjs \
+          ./script/rendered-content-link-checker.js \
             --language en \
             --exit \
             --verbose \

.github/workflows/orphaned-assets-check.yml

@@ -40,7 +40,7 @@ jobs:
         run: |
           set -e
 
-          ./script/find-orphaned-assets.mjs | xargs git rm
+          ./script/find-orphaned-assets.js | xargs git rm
 
           # If nothing to commit, exit now. It's fine. No orphans.
           git status | grep 'nothing to commit' && exit 0
@@ -58,6 +58,6 @@ jobs:
 
           gh pr create \
             --title "Delete orphaned assets ($date)" \
-            --body "Found with the find-orphaned-assets.mjs script" \
+            --body "Found with the find-orphaned-assets.js script" \
             --repo github/docs-internal \
             --label docs-content-fr

.github/workflows/site-policy-sync.yml

@@ -13,7 +13,7 @@ on:
     types:
       - closed
     paths:
-      - 'content/github/site-policy/**'
+      - 'content/site-policy/**'
   workflow_dispatch:
 
 permissions:
@@ -44,7 +44,7 @@ jobs:
           git config --local user.name 'site-policy-bot'
           git config --local user.email 'site-policy-bot@github.com'
           rm -rf Policies
-          cp -r ../content/github/site-policy Policies
+          cp -r ../content/site-policy Policies
           git status
           git checkout -b automated-sync-$GITHUB_RUN_ID
           git add .

.github/workflows/60-days-stale-check.yml → .github/workflows/stale.yml

@@ -1,6 +1,6 @@
-name: 60 Days Stale Check
+name: Stale
 
-# **What it does**: Pull requests older than 60 days will be flagged as stale.
+# **What it does**: Close issues and pull requests after no updates for 365 days.
 # **Why we have it**: We want to manage our queue of issues and pull requests.
 # **Who does it impact**: Everyone that works on docs or docs-internal.
 
@@ -20,12 +20,12 @@ jobs:
       - uses: actions/stale@3cc123766321e9f15a6676375c154ccffb12a358
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'
-          stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
-          days-before-stale: 60
-          days-before-close: -1
-          only-labels: 'engineering,Triaged,Improve existing docs,Core,Ecosystem'
+          stale-issue-message: 'This issue is stale because there have been no updates in 365 days.'
+          stale-pr-message: 'This PR is stale because there have been no updates in 365 days.'
+          days-before-stale: 365
+          days-before-close: 0
           stale-issue-label: 'stale'
           stale-pr-label: 'stale'
           exempt-pr-labels: 'never-stale,waiting for review'
           exempt-issue-labels: 'never-stale,help wanted,waiting for review'
+          operations-per-run: 1000

.github/workflows/sync-search-elasticsearch.yml

@@ -0,0 +1,119 @@
+name: Sync search Elasticsearch
+
+# **What it does**: It scrapes the whole site and dumps the records in a
+#                   temp directory. Then it indexes that into Elasticsearch.
+# **Why we have it**: We want our search indexes kept up to date.
+# **Who does it impact**: Anyone using search on docs.
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '23 */4 * * *' # Run every 4 hours at 23 minutes past the hour
+
+permissions:
+  contents: read
+
+env:
+  FREEZE: ${{ secrets.FREEZE }}
+  ELASTICSEARCH_URL: ${{ secrets.ELASTICSEARCH_URL }}
+
+jobs:
+  updateElasticsearchIndexes:
+    name: Update indexes
+    if: ${{ github.repository == 'github/docs-internal' }}
+    runs-on: ubuntu-20.04-xl
+    strategy:
+      fail-fast: false
+      matrix:
+        # This needs to match the languages we support
+        language: [en, ja, es, pt, cn]
+    steps:
+      - if: ${{ env.FREEZE == 'true' }}
+        run: |
+          echo 'The repo is currently frozen! Exiting this workflow.'
+          exit 1 # prevents further steps from running
+
+      - name: Check out repo
+        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+
+      # TEMPORARY UNTIL WE HAVE A PRODUCTION ELASTICSEARCH
+      - uses: getong/elasticsearch-action@95b501ab0c83dee0aac7c39b7cea3723bef14954
+        with:
+          elasticsearch version: '7.17.5'
+          host port: 9200
+          container port: 9200
+          host node port: 9300
+          node port: 9300
+          discovery type: 'single-node'
+      # END TEMPORARY
+
+      - name: Setup Node
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
+        with:
+          node-version: '16.15.0'
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Cache nextjs build
+        uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09
+        with:
+          path: .next/cache
+          key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}
+
+      - name: Run build scripts
+        run: npm run build
+
+      - name: Start the server in the background
+        env:
+          ENABLE_DEV_LOGGING: false
+        run: |
+          npm run sync-search-server > /tmp/stdout.log 2> /tmp/stderr.log &
+
+          # first sleep to give it a chance to start
+          sleep 6
+          curl --retry-connrefused --retry 4 -I http://localhost:4002/
+
+      - if: ${{ failure() }}
+        name: Debug server outputs on errors
+        run: |
+          echo "____STDOUT____"
+          cat /tmp/stdout.log
+          echo "____STDERR____"
+          cat /tmp/stderr.log
+
+      - name: Scrape records into a temp directory
+        env:
+          # If a reusable, or anything in the `data/*` directory is deleted
+          # you might get a
+          #
+          #   RenderError: Can't find the key 'site.data.reusables...' in the scope
+          #
+          # But that'll get fixed in the next translation pipeline. For now,
+          # let's just accept an empty string instead.
+          THROW_ON_EMPTY: false
+
+        run: |
+          mkdir /tmp/records
+          npm run sync-search-indices -- \
+            -l ${{ matrix.language }} \
+            -o /tmp/records \
+            --no-compression --no-lunr-index
+
+          ls -lh /tmp/records
+
+      - name: Check that Elasticsearch is accessible
+        run: |
+          curl --fail --retry-connrefused --retry 5 -I ${{ env.ELASTICSEARCH_URL }}
+
+      - name: Index into Elasticsearch
+        run: |
+          ./script/search/index-elasticsearch.js \
+            --language ${{ matrix.language }} \
+            --source-directory /tmp/records
+
+      - name: Check created indexes and aliases
+        run: |
+          curl --fail --retry-connrefused --retry 5 ${{ env.ELASTICSEARCH_URL }}/_cat/indices?v
+          curl --fail --retry-connrefused --retry 5 ${{ env.ELASTICSEARCH_URL }}/_cat/indices?v

Dockerfile

@@ -74,7 +74,7 @@ ENV NODE_ENV production
 # Whether to hide iframes, add warnings to external links
 ENV AIRGAP false
 
-# Preferred port for server.mjs
+# Preferred port for server.js
 ENV PORT 4000
 
 ENV ENABLED_LANGUAGES "en"
@@ -94,12 +94,12 @@ COPY --chown=node:node middleware ./middleware
 COPY --chown=node:node feature-flags.json ./
 COPY --chown=node:node data ./data
 COPY --chown=node:node next.config.js ./
-COPY --chown=node:node server.mjs ./server.mjs
-COPY --chown=node:node start-server.mjs ./start-server.mjs
+COPY --chown=node:node server.js ./server.js
+COPY --chown=node:node start-server.js ./start-server.js
 
 EXPOSE $PORT
 
-CMD ["node", "server.mjs"]
+CMD ["node", "server.js"]
 
 # --------------------------------------------------------------------------------
 # PRODUCTION IMAGE - includes all translations

README.md

@@ -12,7 +12,7 @@ See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how t
 
 We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code.
 
-On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes.
+On the GitHub Docs site, you can click the make a contribution button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes.
 
 <img src="./assets/images/contribution_cta.png" width="400">
 

components/Search.tsx

@@ -12,7 +12,7 @@ import { useMainContext } from './context/MainContext'
 import { DEFAULT_VERSION, useVersion } from 'components/hooks/useVersion'
 import { useQuery } from 'components/hooks/useQuery'
 import { Link } from 'components/Link'
-import { useLanguages } from './context/LanguagesContext'
+import { useSession } from 'components/lib/get-session'
 
 import styles from './Search.module.scss'
 
@@ -46,13 +46,16 @@ export function Search({
   const inputRef = useRef<HTMLInputElement>(null)
   const { t } = useTranslation('search')
   const { currentVersion } = useVersion()
-  const { languages } = useLanguages()
+  const session = useSession()
+  const languages = session?.languages
 
   // Figure out language and version for index
   const { searchVersions, nonEnterpriseDefaultVersion } = useMainContext()
   // fall back to the non-enterprise default version (FPT currently) on the homepage, 404 page, etc.
   const version = searchVersions[currentVersion] || searchVersions[nonEnterpriseDefaultVersion]
-  const language = (Object.keys(languages).includes(router.locale || '') && router.locale) || 'en'
+  const language = languages
+    ? (Object.keys(languages).includes(router.locale || '') && router.locale) || 'en'
+    : 'en'
 
   const fetchURL = query
     ? `/search?${new URLSearchParams({

components/article/ArticlePage.tsx

@@ -39,11 +39,8 @@ const interactiveAlternatives: Record<string, { href: string }> = {
       href: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces?langId=py',
     },
 }
-type Props = {
-  children?: React.ReactNode
-}
 
-export const ArticlePage = ({ children }: Props) => {
+export const ArticlePage = () => {
   const { asPath } = useRouter()
   const {
     title,
@@ -145,7 +142,7 @@ export const ArticlePage = ({ children }: Props) => {
           }
         >
           <div id="article-contents">
-            <MarkdownContent>{children || renderedPage}</MarkdownContent>
+            <MarkdownContent>{renderedPage}</MarkdownContent>
             {effectiveDate && (
               <div className="mt-4" id="effectiveDate">
                 Effective as of:{' '}