8000 Merge branch 'main' into codespaces-devcontainer-update · my-lambda-projects/docs@bb92426 · GitHub
[go: up one dir, main page]
Skip to content

Commit bb92426

Browse files
saritaisaritai
authored
Merge branch 'main' into codespaces-devcontainer-update
2 parents 2e5ee29 + 99a4d42 commit bb92426

File tree

1,016 files changed

+69657
-2141008
lines changed

Some content is hidden

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

1,016 files changed

+69657
-2141008
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Thanks again!
1414

1515
Closes [issue link]
1616

17-
<!--
17+
<!--
1818
- If there's an existing issue for your change, please link to it.
1919
- If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/github/docs/issues/new/choose. -->
2020

@@ -24,8 +24,8 @@ Closes [issue link]
2424

2525
### Check off the following:
2626

27-
- [ ] I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click **View deployment**).
28-
- [ ] For content changes, I have completed the [self-review checklist](https://github.com/github/docs/blob/main/contributing/self-review.md#self-review).
27+
- [ ] I have reviewed my changes in staging (look for "Automatically generated comment" and click **Modified** to view your latest changes).
28+
- [ ] For content changes, I have completed the [self-review checklist](https://github.com/github/docs/blob/main/CONTRIBUTING.md#self-review).
2929

3030
### Writer impact (This section is for GitHub staff members only):
3131

‎.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,8 @@ You may need to include the changes in step 6 to get tests to pass.
7070
- [ ] Debug any test failures or unexpected results.
7171
- [ ] When the PR is approved, merge it in to complete the deprecation. This can be merged independently from step 5.
7272
73+
## Step 7: Deprecate the OpenAPI description in `github/github`
74+
75+
- [ ] In `github/github`, edit the release's config file in `app/api/description/config/releases/`, and change `deprecated: false` to `deprecated: true`.
76+
- [ ] Open a new PR, and get the required code owner approvals. A docs-content team member can approve it for the docs team.
77+
- [ ] When the PR is approved, merge the `github/github` PR.

‎.github/dependabot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ updates:
33
- package-ecosystem: npm
44
directory: '/'
55
schedule:
6-
interval: weekly
6+
interval: monthly
77
open-pull-requests-limit: 20 # default is 5
88

99
- package-ecosystem: 'github-actions'

‎.github/workflows/staging-build-pr.yml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,14 @@ jobs:
9696
- name: Set npm script for Heroku build to noop
9797
run: npm set-script heroku-postbuild "echo 'Application was pre-built!'"
9898

99+
- name: Delete heavy things we won't need deployed
100+
run: |
101+
# Non-WIP translations we don't support yet.
102+
rm -fr translations/de* translations/ru* translations/ko* translations/ru*
103+
104+
# Not needed to run after having been built.
105+
rm -fr .next/cache
106+
99107
- name: Create an archive
100108
run: |
101109
tar -c --file=app.tar \
@@ -116,11 +124,15 @@ jobs:
116124
app.json \
117125
Procfile
118126
127+
ls -lh app.tar
128+
zstd -q app.tar -o app.tar.zst
129+
ls -lh app.tar.zst
130+
119131
# Upload only the files needed to run this application.
120132
# We are not willing to trust the rest (e.g. script/) for the remainder
121133
# of the deployment process.
122134
- name: Upload build artifact
123135
uses: actions/upload-artifact@27121b0bdffd731efa15d66772be8dc71245d074
124136
with:
125137
name: pr_build
126-
path: app.tar
138+
path: app.tar.zst

‎.github/workflows/staging-deploy-pr.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,7 @@ jobs:
325325

326326
- name: Extract user-changes to temp directory
327327
run: |
328+
zstd -d -q $RUNNER_TEMP/app.tar.zst -o $RUNNER_TEMP/app.tar
328329
mkdir $RUNNER_TEMP/app
329330
tar -x --file=$RUNNER_TEMP/app.tar -C "$RUNNER_TEMP/app/"
330331

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ coverage/
1515
blc_output.log
1616
blc_output_internal.log
1717
broken_links.md
18+
lib/redirects/.redirects-cache_*.json

‎CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If you spot a problem with the docs, [search if an issue already exists](https:/
3232

3333
#### Solve an issue
3434

35-
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information.
35+
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
3636

3737
### Make Changes
3838

‎assets/images/enterprise/3.2/management-console/enable-security-checkboxes.png

136 KB
Loading

‎assets/images/help/codespaces/make-public-option.png

6.83 KB
Loading

‎assets/images/help/enterprises/audit-stream-add-s3.png

66.2 KB
Loading

‎assets/images/help/enterprises/audit-stream-check-azure.png renamed to ‎assets/images/help/enterprises/audit-stream-check.png

File renamed without changes.

‎assets/images/help/enterprises/audit-stream-choice-azure.png

-16.5 KB
Loading

‎assets/images/help/enterprises/audit-stream-choice-s3.png

90.6 KB
Loading

‎assets/images/help/enterprises/audit-stream-choice-splunk.png

-17.1 KB
Loading

‎assets/images/help/images/oidc-architecture.png

92.7 KB
Loading

‎components/context/MainContext.tsx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,21 @@ import type { BreadcrumbT } from 'components/Breadcrumbs'
55
import type { FeatureFlags } from 'components/hooks/useFeatureFlags'
66
import { ExcludesNull } from 'components/lib/ExcludesNull'
77

8-
type ProductT = {
8+
export type ProductT = {
99
external: boolean
1010
href: string
1111
id: string
1212
name: string
1313
versions?: Array<string>
1414
}
1515

16+
export type ProductGroupT = {
17+
name: string
18+
icon: string
19+
octicon: string
20+
children: Array<ProductT>
21+
}
22+
1623
type VersionItem = {
1724
version: string
1825
versionTitle: string
@@ -62,6 +69,7 @@ export type MainContextT = {
6269
article?: BreadcrumbT
6370
}
6471
activeProducts: Array<ProductT>
72+
productGroups: Array<ProductGroupT>
6573
communityRedirect: {
6674
name: string
6775
href: string
@@ -114,6 +122,7 @@ export const getMainContext = (req: any, res: any): MainContextT => {
114122
return {
115123
breadcrumbs: req.context.breadcrumbs || {},
116124
activeProducts: req.context.activeProducts,
125+
productGroups: req.context.productGroups,
117126
communityRedirect: req.context.page?.communityRedirect || {},
118127
currentProduct: req.context.productMap[req.context.currentProduct] || null,
119128
currentLayoutName: req.context.currentLayoutName,

‎components/landing/CodeExampleCard.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ export const CodeExampleCard = ({ example }: Props) => {
1414
>
1515
<div className="p-4">
1616
<h4 dangerouslySetInnerHTML={{ __html: example.title }} />
17-
<p className="mt-2 mb-4 color-text-tertiary">{example.description}</p>
17+
<p
18+
className="mt-2 mb-4 color-text-tertiary"
19+
dangerouslySetInnerHTML={{ __html: example.description }}
20+
/>
1821
<div className="d-flex flex-wrap">
1922
{example.tags.map((tag) => {
2023
return (

‎components/sublanding/ArticleCard.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export const ArticleCard = ({ card, typeLabel }: Props) => {
1616
<div className="h6 text-uppercase" data-testid="article-card-type">
1717
{typeLabel}
1818
</div>
19-
<p className="color-text-secondary my-3">{card.intro}</p>
19+
<p className="color-text-secondary my-3" dangerouslySetInnerHTML={{ __html: card.intro }} />
2020
{card.topics.length > 0 && (
2121
<div>
2222
{card.topics.map((topic) => {

‎content/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
1616
- [`product`](#product)
1717
- [`layout`](#layout)
1818
- [`children`](#children)
19+
- [`childGroups`](#childgroups)
1920
- [`featuredLinks`](#featuredlinks)
2021
- [`showMiniToc`](#showminitoc)
2122
- [`miniTocMaxHeadingLevel`](#minitocmaxheadinglevel)
@@ -159,6 +160,12 @@ For a layout named `components/landing`, the value would be `product-landing`.
159160
- Type: `Array`. Default is `false`.
160161
- Required on `index.md` pages.
161162

163+
### `childGroups`
164+
165+
- Purpose: Renders children into groups on the homepage. See [Homepage](#homepage) for more info.
166+
- Type: `Array`. Default is `false`.
167+
- Require on the homepage `index.md`.
168+
162169
### `featuredLinks`
163170

164171
- Purpose: Renders the linked articles' titles and intros on product landing pages and the homepage.
@@ -368,6 +375,12 @@ Index pages are the Table of Contents files for the docs site. Every product, ca
368375

369376
**Important note**: The site only knows about paths included in `children` frontmatter. If a directory or article exists but is **not** included in `children`, its path will 404.
370377

378+
### Homepage
379+
380+
The homepage is the main Table of Contents file for the docs site. The homepage must have a complete list of `children`, like every [Index page](#index-page) but must also specify the `childGroups` frontmatter property that will be highlighted in the main content area.
381+
382+
`childGroups` is an array of mappings containing a `name` for the group, an optional `icon` for the group, and an array of `children`. The `children` in the array must be present in the `children` frontmatter property.
383+
371384
### Creating new sublanding pages
372385

373386
To create a sublanding page (e.g. [Actions' Guide page](https://docs.github.com/en/actions/guides)), create or modify an existing markdown file with these specific frontmatter values:

‎content/account-and-profile/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Your account and profile on GitHub
33
shortTitle: Account and profile
4-
intro: "Make {% data variables.product.product_name %} work best for you by adjusting the settings for your user account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}."
4+
intro: 'Make {% data variables.product.product_name %} work best for you by adjusting the settings for your user account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}.'
55
introLinks:
6-
quickstart: /get-started/onboarding/getting-started-with-your-github-account
6+
quickstart: /get-started/onboarding/getting-started-with-your-github-account
77
featuredLinks:
88
guides:
99
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username
@@ -22,7 +22,7 @@ featuredLinks:
2222
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address
2323
- '{% ifversion ghes or ghae %}/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories{% endif %}'
2424
changelog:
25-
label: profiles, github-themes, notifications
25+
label: 'profiles, github-themes, notifications'
2626
versions:
2727
fpt: '*'
2828
ghec: '*'
@@ -40,4 +40,5 @@ children:
4040
- /setting-up-and-managing-your-github-user-account
4141
- /setting-up-and-managing-your-github-profile
4242
- /managing-subscriptions-and-notifications-on-github
43-
---
43+
---
44+

‎content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ To unsubscribe from conversations you're automatically subscribed to, you can ch
5454

5555
## Customizing notifications and subscriptions
5656

57-
You can choose to view your notifications through the notifications inbox at [https://github.com/notifications](https://github.com/notifications){% ifversion fpt or ghes > 2.22 or ghec %} and in the {% data variables.product.prodname_mobile %} app{% endif %}, through your email, or some combination of these options.
57+
You can choose to view your notifications through the notifications inbox at [https://github.com/notifications](https://github.com/notifications){% ifversion fpt or ghes or ghec %} and in the {% data variables.product.prodname_mobile %} app{% endif %}, through your email, or some combination of these options.
5858

5959
To customize the types of updates you'd like to receive and where to send those updates, configure your notification settings. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)."
6060

6161
To keep your subscriptions manageable, review your subscriptions and watched repositories and unsubscribe as needed. For more information, see "[Managing subscriptions for activity on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)."
6262

6363
To customize how you'd like to receive updates for specific pull requests or issues, you can configure your preferences within the issue or pull request. For more information, see "[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification#customizing-when-to-receive-future-updates-for-an-issue-or-pull-request)."
6464

65-
{% ifversion fpt or ghes > 2.22 or ghec %}
65+
{% ifversion fpt or ghes or ghec %}
6666
You can customize and schedule push notifications in the {% data variables.product.prodname_mobile %} app. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#managing-your-notification-settings-with-github-for-mobile)."
6767
{% endif %}
6868

@@ -92,7 +92,7 @@ From your inbox you can also triage multiple notifications at once. For more inf
9292

9393
## Customizing your notifications inbox
9494

95-
To focus on a group of notifications in your inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} or {% data variables.product.prodname_mobile %}{% endif %}, you can create custom filters. For example, you can create a custom filter for an open source project you contribute to and only see notifications for that repository in which you are mentioned. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox)." For more examples of how to customize your triaging workflow, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
95+
To focus on a group of notifications in your inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} or {% data variables.product.prodname_mobile %}{% endif %}, you can create custom filters. For example, you can create a custom filter for an open source project you contribute to and only see notifications for that repository in which you are mentioned. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox)." For more examples of how to customize your triaging workflow, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
9696

9797
## Notification retention policy
9898

‎content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ topics:
3131

3232
You can receive notifications for activity on {% data variables.product.product_location %} in the following locations.
3333

34-
- The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes > 2.22 or ghec %}
34+
- The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes or ghec %}
3535
- The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_location %}{% endif %}
36-
- An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}
36+
- An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}
3737

38-
{% ifversion fpt or ghes > 2.22 or ghec %}
38+
{% ifversion fpt or ghes or ghec %}
3939
{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)."
4040
{% endif %}
4141

4242
{% data reusables.notifications.shared_state %}
4343

4444
### Benefits of the notifications inbox
4545

46-
The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to:
46+
The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to:
4747
- Triage multiple notifications at once.
4848
- Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query.
4949
- Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query.
@@ -53,7 +53,7 @@ The notifications inbox on {% data variables.product.product_location %}{% ifver
5353
- Create custom filters to focus on different notifications when you want.
5454
- Group notifications in your inbox by repository or date to get a quick overview with less context switching
5555

56-
{% ifversion fpt or ghes > 2.22 or ghec %}
56+
{% ifversion fpt or ghes or ghec %}
5757
In addition, you can receive and triage notifications on your mobile device with {% data variables.product.prodname_mobile %}. For more information, see "[Managing your notification settings with GitHub for mobile](#managing-your-notification-settings-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)."
5858
{% endif %}
5959

@@ -85,15 +85,15 @@ You can customize notifications for a repository. For example, you can choose to
8585
### Participating in conversations
8686
Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox.
8787

88-
For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}.
88+
For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}.
8989

9090
![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png)
9191

9292
For example:
9393
- If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications.
9494
- If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating".
9595

96-
If you do not enable watching or participating notifications for web{% ifversion fpt or ghes > 2.22 or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates.
96+
If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates.
9797

9898
## Customizing your email notifications
9999

@@ -218,7 +218,7 @@ Choose how you want to receive workflow run updates for repositories that you ar
218218

219219
{% endif %}
220220

221-
{% ifversion fpt or ghes > 2.22 or ghec %}
221+
{% ifversion fpt or ghes or ghec %}
222222
## Managing your notification settings with {% data variables.product.prodname_mobile %}
223223

224224
When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events.

0 commit comments

Comments
 (0)
0