Merge branch 'main' into patch-2

Author: macedogm

.github/actions-scripts/enterprise-algolia-label.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const core = require('@actions/core')
+const eventPayload = JSON.parse(fs.readFileSync(process.env.GITHUB_EVENT_PATH, 'utf8'))
+
+// This workflow-run script does the following:
+// 1. Gets an array of labels on a PR.
+// 2. Finds one with the relevant Algolia text; if none found, exits early.
+// 3. Gets the version substring from the label string.
+
+const labelText = 'sync-english-index-for-'
+const labelsArray = eventPayload.pull_request.labels
+
+// Exit early if no labels are on this PR
+if (!(labelsArray && labelsArray.length)) {
+  process.exit(0)
+}
+
+// Find the relevant label
+const algoliaLabel = labelsArray
+  .map(label => label.name)
+  .find(label => label.startsWith(labelText))
+
+// Exit early if no relevant label is found
+if (!algoliaLabel) {
+  process.exit(0)
+}
+
+// Given: sync-english-index-for-enterprise-server@3.0
+// Returns: enterprise-server@3.0
+const versionToSync = algoliaLabel.split(labelText)[1]
+
+// Store the version so we can access it later in the workflow
+core.setOutput('versionToSync', versionToSync)
+process.exit(0)

.github/workflows/sync-single-english-algolia-index.yml

@@ -0,0 +1,46 @@
+name: Algolia Sync Single English Index
+
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+      - unlocked
+
+# This workflow requires a label in the format `sync-english-index-for-<PLAN@RELEASE>`
+jobs:
+  updateIndices:
+    name: Update English index for single version based on a label's version
+    if: github.repository == 'github/docs-internal'
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
+        with:
+          node-version: 14.x
+      - name: cache node modules
+        uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: npm ci
+        run: npm ci
+      - name: Get version from Algolia label if present; only continue if the label is found.
+        id: getVersion
+        run: $GITHUB_WORKSPACE/.github/actions-scripts/enterprise-algolia-label.js
+      - if: ${{ steps.getVersion.outputs.versionToSync }}
+        name: Sync English index for single version
+        env:
+          VERSION: ${{ steps.getVersion.outputs.versionToSync }}
+          LANGUAGE: 'en'
+          ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
+          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npm run sync-search

CODE_OF_CONDUCT.md

@@ -22,6 +22,7 @@ Examples of unacceptable behavior include:
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or email address, without their explicit permission
+* Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Enforcement Responsibilities

README.md

@@ -5,6 +5,7 @@ This repository contains the documentation website code and Markdown source file
 GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
 
 In this article:
+
 - [Contributing](#contributing)
 - [READMEs](#readmes)
 - [License](#license)
@@ -34,6 +35,7 @@ If you have a solution to one of the open issues, you will need to fork the repo
 We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in [discussions](https://github.com/github/docs/discussions).
 
 #### And that's it!
+
 That's how you can get started easily as a member of the GitHub Documentation community. :sparkles:
 
 If you want to know more, or you're making a more complex contribution, check out [Getting Started with Contributing](/CONTRIBUTING.md).