Skip to content

Commit cb7e9ae

Browse files
authored
Merge branch 'main' into patch-1
2 parents d0d1fa4 + 2b4ddf5 commit cb7e9ae

File tree

558 files changed

+8131
-5793
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

558 files changed

+8131
-5793
lines changed

.github/actions-scripts/purge-fastly-edge-cache-per-language.js

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,25 @@ import { languageKeys } from '../../lib/languages.js'
55
import { makeLanguageSurrogateKey } from '../../middleware/set-fastly-surrogate-key.js'
66
import purgeEdgeCache from '../../script/deployment/purge-edge-cache.js'
77

8+
/**
9+
* In simple terms, this script sends purge commands for...
10+
*
11+
* 1. no-language
12+
* 2. 'en'
13+
* 3. 'ja'
14+
* 4. 'pt'
15+
* ...
16+
*
17+
* ...and so on for all languages.
18+
* But to avoid a stampeding herd after each purge, and to avoid unnecessary
19+
* load on the backend, put a slight delay between each language.
20+
* This gives the backend a chance to finish processing all the now stale
21+
* URLs, for that language, before tackling the next.
22+
*/
23+
const DELAY_BETWEEN_LANGUAGES = 10 * 1000
24+
25+
const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
26+
827
// This covers things like `/api/webhooks` which isn't language specific.
928
await purgeEdgeCache(makeLanguageSurrogateKey())
1029

@@ -16,6 +35,10 @@ const languages = process.env.LANGUAGES
1635
languageKeys.sort((a) => (a === 'en' ? -1 : 1))
1736

1837
for (const language of languages) {
38+
console.log(
39+
`Sleeping ${DELAY_BETWEEN_LANGUAGES / 1000} seconds before purging for '${language}'...`
40+
)
41+
await sleep(DELAY_BETWEEN_LANGUAGES)
1942
await purgeEdgeCache(makeLanguageSurrogateKey(language))
2043
}
2144

.github/workflows/browser-test.yml

Lines changed: 0 additions & 79 deletions
This file was deleted.

.github/workflows/codeowners-docs-engineering.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ name: Codeowners - Docs Engineering
88

99
on:
1010
pull_request:
11+
types:
12+
- edited
13+
- opened
14+
- ready_for_review
15+
- reopened
16+
- synchronize
1117
paths:
1218
- '**.js'
1319
- '**.ts'
@@ -20,7 +26,7 @@ on:
2026

2127
jobs:
2228
codeowners-docs-engineering:
23-
if: ${{ github.repository == 'github/docs-internal' }}
29+
if: ${{ github.repository == 'github/docs-internal' && !github.event.pull_request.draft }}
2430
runs-on: ubuntu-latest
2531
env:
2632
GH_TOKEN: ${{ secrets.DOCS_BOT_FR }}
Binary file not shown.
Binary file not shown.
173 KB
Loading
193 KB
Loading
Loading
38.2 KB
Loading
Loading
Binary file not shown.
Binary file not shown.
Loading
Loading
Loading
Loading
9.82 KB
Loading
10.7 KB
Loading
14.1 KB
Loading
16.3 KB
Loading
20.6 KB
Loading
2.94 KB
Loading
9.59 KB
Loading
3.25 KB
Loading
3.54 KB
Loading
4.37 KB
Loading
4.98 KB
Loading

components/context/TocLandingContext.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
import pick from 'lodash/pick'
22
import { createContext, useContext } from 'react'
33
import { LearningTrack } from './ArticleContext'
4-
import { FeaturedLink, getFeaturedLinksFromReq } from './ProductLandingContext'
4+
import {
5+
FeaturedLink,
6+
getFeaturedLinksFromReq,
7+
} from 'src/landings/components/ProductLandingContext'
58

69
export type TocItem = {
710
fullPath: string

components/hooks/useTheme.ts

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,24 @@ export function useTheme() {
105105
})
106106

107107
useEffect(() => {
108-
const cookieValue = Cookies.get('color_mode')
109-
const css = getCssTheme(cookieValue)
110-
const component = getComponentTheme(cookieValue)
111-
setTheme({ css, component })
108+
// Using setTimeout with a default delay value of 0 interjects one
109+
// additional event cycle, which works around a bug that is the
110+
// result of a timing issue. Without the setTimeout function
111+
// the page loads, then the docs site switches the color mode to
112+
// match the user's GitHub color mode. Primer React has a useEffect
113+
// call that overrides this change, causing the site to ignore the
114+
// user's GitHub color mode and revert to auto.
115+
// As a temporary workaround, this code that fetches the user's GitHub
116+
// color mode will be called after Primer React's useEffect call.
117+
// The long term solution to this theming issue is to migrate to CSS variables
118+
// under the hood, which Primer is planning to do in the next couple quarters.
119+
// Reference: https://github.com/primer/react/issues/2229
120+
setTimeout(() => {
121+
const cookieValue = Cookies.get('color_mode')
122+
const css = getCssTheme(cookieValue)
123+
const component = getComponentTheme(cookieValue)
124+
setTheme({ css, component })
125+
})
112126
}, [])
113127

114128
return { theme }

components/release-notes/PatchNotes.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const SectionToLabelMap: Record<string, string> = {
1515
changes: 'Changes',
1616
deprecations: 'Deprecations',
1717
backups: 'Backups',
18+
errata: 'Errata',
1819
}
1920

2021
type Props = {

components/sidebar/SidebarNav.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import cx from 'classnames'
22

33
import { useMainContext } from 'components/context/MainContext'
4-
import { SidebarProduct } from './SidebarProduct'
5-
import { SidebarHomepage } from './SidebarHomepage'
4+
import { SidebarProduct } from 'src/landings/components/SidebarProduct'
5+
import { SidebarHomepage } from '../../src/landings/components/SidebarHomepage'
66
import { AllProductsLink } from './AllProductsLink'
77
import { ApiVersionPicker } from 'src/rest/components/ApiVersionPicker'
88
import { Link } from 'components/Link'

content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ When you unsubscribe from notifications in your inbox, they will automatically d
4747
1. From the notifications inbox, select the notifications you want to unsubscribe to.
4848
2. Click **Unsubscribe.**
4949

50-
![Screenshot of the "Notifications" page. A button, titled "Unsubscribe", is highlighted with an orange outline.](/assets/images/help/notifications-v2/unsubscribe-from-main-inbox.png)
50+
![Screenshot of the "Notifications" page. A button, titled "Unsubscribe", is highlighted with an orange outline.](/assets/images/help/notifications-v2/unsubscribe-from-main-inbox.png)
5151

5252
## Unsubscribing from notifications on the subscriptions page
5353

5454
{% data reusables.notifications.access_notifications %}
5555
1. In the left sidebar, under the list of repositories, select the "Manage notifications" dropdown menu and click **Subscriptions**.
5656

57-
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
57+
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
5858

5959
2. Select the notifications you want to unsubscribe from. In the top right, click **Unsubscribe**.
6060

@@ -65,7 +65,7 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
6565
{% data reusables.notifications.access_notifications %}
6666
1. In the left sidebar, under the list of repositories, select the "Manage notifications" dropdown menu and click **Watched repositories**.
6767

68-
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
68+
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
6969

7070
2. On the watched repositories page, after you've evaluated the repositories you're watching, choose whether to:
7171

content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ Many people forget about repositories that they've chosen to watch in the past.
4646

4747
{% data reusables.notifications.access_notifications %}
4848
1. In the left sidebar, under the list of repositories that you have notifications from, use the "Manage notifications" drop-down to click **Subscriptions**.
49-
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
49+
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
5050

5151
2. Use the filters and sort to narrow the list of subscriptions and begin unsubscribing to conversations you no longer want to receive notifications for.
5252

53-
![Screenshot of the "Subscriptions" tab. Three dropdown menus, titled "Reason", "Repository", and "Sort", are highlighted with an orange outline.](/assets/images/help/notifications-v2/all-subscriptions.png)
53+
![Screenshot of the "Subscriptions" tab. Three dropdown menus, titled "Reason", "Repository", and "Sort", are highlighted with an orange outline.](/assets/images/help/notifications-v2/all-subscriptions.png)
5454

5555
{% tip %}
5656

@@ -64,7 +64,7 @@ Many people forget about repositories that they've chosen to watch in the past.
6464
## Reviewing repositories that you're watching
6565

6666
1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**.
67-
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
67+
![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png)
6868
2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository.
6969

7070
{% tip %}

content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ You can add up to 15 of your own custom filters.
6969

7070
3. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see "[Supported queries for custom filters](#supported-queries-for-custom-filters)."
7171

72-
![Screenshot showing notification filters. Two input fields, with an example name and filter query filled in, are highlighted with an orange outline.](/assets/images/help/notifications-v2/custom-filter-example.png)
72+
![Screenshot showing notification filters. Two input fields, with an example name and filter query filled in, are highlighted with an orange outline.](/assets/images/help/notifications-v2/custom-filter-example.png)
7373

7474
4. Click **Create**.
7575

content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To save a single notification to review later, to the right of the notification,
1919

2020
Saved notifications are kept indefinitely and can be viewed by clicking **Saved** in the sidebar or with the `is:saved` query. If your saved notification is older than 5 months and becomes unsaved, the notification will disappear from your inbox within a day.
2121

22-
![Screenshot of a single notification from the "Notifications" page. The bookmark icon is highlighted with an orange outline.](/assets/images/help/notifications-v2/save-triaging-option.png)
22+
![Screenshot of a single notification from the "Notifications" page. The bookmark icon is highlighted with an orange outline.](/assets/images/help/notifications-v2/save-triaging-option.png)
2323

2424
## Investigating a notification
2525

@@ -38,7 +38,7 @@ You can choose how you want to receive future notifications for a specific issue
3838

3939
1. In the right column of the issue or pull request, next to "Notifications", click **Customize**.
4040

41-
![Screenshot of the "Notifications" element on an issue or pull request. A link, titled "Customize", is highlighted with an orange outline.](/assets/images/help/notifications-v2/customize-notifications-for-specific-thread.png)
41+
![Screenshot of the "Notifications" element on an issue or pull request. A link, titled "Customize", is highlighted with an orange outline.](/assets/images/help/notifications-v2/customize-notifications-for-specific-thread.png)
4242

4343
2. In the dialog box, select **Custom**, then choose when you'd like to receive a notification update for this thread. For example, you can choose to receive an update when the pull request has been merged, closed, or reopened. You will be subscribed again if you participate in the thread, your username is @mentioned, or a team you're a member of is @mentioned.
4444

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ People who visit your profile can also see the following information.
3333
- Repositories you've starred{% ifversion fpt or ghec %} and organized into lists{% endif %}. For more information, see "[AUTOTITLE](/get-started/exploring-projects-on-github/saving-repositories-with-stars)."
3434
- An overview of your activity in organizations, repositories, and teams you're most active in. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile)."{% ifversion fpt or ghec %}
3535
- Badges and Achievements that highlight your activity and show if you use {% data variables.product.prodname_pro %} or participate in programs like the {% data variables.product.prodname_arctic_vault %}, {% data variables.product.prodname_sponsors %}, or the {% data variables.product.company_short %} Developer Program. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#displaying-badges-on-your-profile)."{% endif %}
36-
- Your pronouns if you've set them. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#adding-pronouns-to-your-profile).
36+
- Your pronouns if you've set them. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#adding-pronouns-to-your-profile)." {% ifversion fpt or ghec %}
37+
- Mutual connections you share with someone who is viewing your profile. The person viewing your profile can see which of the people they follow are also followed by you.{% endif %}
3738

3839
You can also set a status on your profile to provide information about your availability. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status)."
3940

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ If you authored any commit(s) present in the commit history for the listed tag o
227227
| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.7 | [pyparsing_2.4.7](https://github.com/pyparsing/pyparsing/releases/tag/pyparsing_2.4.7) |
228228
| [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 | [v3.5](https://github.com/pyserial/pyserial/releases/tag/v3.5) |
229229
| [dateutil/dateutil](https://github.com/dateutil/dateutil) | 2.8.1 | [2.8.1](https://github.com/dateutil/dateutil/releases/tag/2.8.1) |
230-
| [yaml/pyyaml ](https://github.com/yaml/pyyaml) | 5.4.1 | [5.4.1](https://github.com/yaml/pyyaml/releases/tag/5.4.1) |
230+
| [yaml/pyyaml](https://github.com/yaml/pyyaml) | 5.4.1 | [5.4.1](https://github.com/yaml/pyyaml/releases/tag/5.4.1) |
231231
| [psf/requests](https://github.com/psf/requests) | 2.25.1 | [v2.25.1](https://github.com/psf/requests/releases/tag/v2.25.1) |
232232
| [boto/s3transfer](https://github.com/boto/s3transfer) | 0.3.4 | [0.3.4](https://github.com/boto/s3transfer/releases/tag/0.3.4) |
233233
| [enthought/scimath](https://github.com/enthought/scimath) | 4.2.0 | [4.2.0](https://github.com/enthought/scimath/releases/tag/4.2.0) |

content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ shortTitle: Show an overview
2727
{% data reusables.profile.access_profile %}
2828
2. Above your contributions graph, select the **Contribution settings** dropdown menu, then click **Activity overview**.
2929

30-
![Screenshot of the contributions graph on a user profile. A dropdown menu, labeled "Contribution settings", is highlighted with an orange outline.](/assets/images/help/profile/activity-overview.png)
30+
![Screenshot of the contributions graph on a user profile. A dropdown menu, labeled "Contribution settings", is highlighted with an orange outline.](/assets/images/help/profile/activity-overview.png)

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Since an email address can only be associated with a single {% data variables.pr
5353

5454
1. In the email, click **Unlink this email**.
5555

56-
![Screenshot of an email from {% data variables.product.prodname_dotcom %} to unlink an email address from a {% data variables.product.prodname_dotcom %} account. A link with the text "Unlink this email" is outlined in orange.](/assets/images/help/2fa/unlink-this-email.png)
56+
![Screenshot of an email from {% data variables.product.prodname_dotcom %} to unlink an email address from a {% data variables.product.prodname_dotcom %} account. A link with the text "Unlink this email" is outlined in orange.](/assets/images/help/2fa/unlink-this-email.png)
5757

5858
1. To finish unlinking your email, on {% data variables.product.prodname_dotcom_the_website %}, click **Unlink**.
5959
1. Optionally, to create a new account and link your newly unlinked email, click **Create a new account**.

0 commit comments

Comments
 (0)