Merge branch 'main' into codespaces-devcontainer-update

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,7 +14,7 @@ Thanks again!
 
 Closes [issue link]
 
-<!-- 
+<!--
 - If there's an existing issue for your change, please link to it.
 - 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. -->
 
@@ -24,8 +24,8 @@ Closes [issue link]
 
 ### Check off the following:
 
-- [ ] I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click **View deployment**).
-- [ ] For content changes, I have completed the [self-review checklist](https://github.com/github/docs/blob/main/contributing/self-review.md#self-review).
+- [ ] I have reviewed my changes in staging (look for "Automatically generated comment" and click **Modified** to view your latest changes).
+- [ ] For content changes, I have completed the [self-review checklist](https://github.com/github/docs/blob/main/CONTRIBUTING.md#self-review).
 
 ### Writer impact (This section is for GitHub staff members only):
 

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

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

.github/dependabot.yml

@@ -3,7 +3,7 @@ updates:
   - package-ecosystem: npm
     directory: '/'
     schedule:
-      interval: weekly
+      interval: monthly
     open-pull-requests-limit: 20 # default is 5
 
   - package-ecosystem: 'github-actions'

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

@@ -96,6 +96,14 @@ jobs:
       - name: Set npm script for Heroku build to noop
         run: npm set-script heroku-postbuild "echo 'Application was pre-built!'"
 
+      - name: Delete heavy things we won't need deployed
+        run: |
+          # Non-WIP translations we don't support yet.
+          rm -fr translations/de* translations/ru* translations/ko* translations/ru*
+
+          # Not needed to run after having been built.
+          rm -fr .next/cache
+
       - name: Create an archive
         run: |
           tar -c --file=app.tar \
@@ -116,11 +124,15 @@ jobs:
             app.json \
             Procfile
 
+          ls -lh app.tar
+          zstd -q app.tar -o app.tar.zst
+          ls -lh app.tar.zst
+
       # Upload only the files needed to run this application.
       # We are not willing to trust the rest (e.g. script/) for the remainder
       # of the deployment process.
       - name: Upload build artifact
         uses: actions/upload-artifact@27121b0bdffd731efa15d66772be8dc71245d074
         with:
           name: pr_build
-          path: app.tar
+          path: app.tar.zst

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

@@ -325,6 +325,7 @@ jobs:
 
       - name: Extract user-changes to temp directory
         run: |
+          zstd -d -q $RUNNER_TEMP/app.tar.zst -o $RUNNER_TEMP/app.tar
           mkdir $RUNNER_TEMP/app
           tar -x --file=$RUNNER_TEMP/app.tar -C "$RUNNER_TEMP/app/"
 

.gitignore

@@ -15,3 +15,4 @@ coverage/
 blc_output.log
 blc_output_internal.log
 broken_links.md
+lib/redirects/.redirects-cache_*.json

CONTRIBUTING.md

@@ -32,7 +32,7 @@ If you spot a problem with the docs, [search if an issue already exists](https:/
 
 #### Solve an issue
 
-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.
+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.
 
 ### Make Changes
 

components/context/MainContext.tsx

@@ -5,14 +5,21 @@ import type { BreadcrumbT } from 'components/Breadcrumbs'
 import type { FeatureFlags } from 'components/hooks/useFeatureFlags'
 import { ExcludesNull } from 'components/lib/ExcludesNull'
 
-type ProductT = {
+export type ProductT = {
   external: boolean
   href: string
   id: string
   name: string
   versions?: Array<string>
 }
 
+export type ProductGroupT = {
+  name: string
+  icon: string
+  octicon: string
+  children: Array<ProductT>
+}
+
 type VersionItem = {
   version: string
   versionTitle: string
@@ -62,6 +69,7 @@ export type MainContextT = {
     article?: BreadcrumbT
   }
   activeProducts: Array<ProductT>
+  productGroups: Array<ProductGroupT>
   communityRedirect: {
     name: string
     href: string
@@ -114,6 +122,7 @@ export const getMainContext = (req: any, res: any): MainContextT => {
   return {
     breadcrumbs: req.context.breadcrumbs || {},
     activeProducts: req.context.activeProducts,
+    productGroups: req.context.productGroups,
     communityRedirect: req.context.page?.communityRedirect || {},
     currentProduct: req.context.productMap[req.context.currentProduct] || null,
     currentLayoutName: req.context.currentLayoutName,

components/landing/CodeExampleCard.tsx

@@ -14,7 +14,10 @@ export const CodeExampleCard = ({ example }: Props) => {
     >
       <div className="p-4">
         <h4 dangerouslySetInnerHTML={{ __html: example.title }} />
-        <p className="mt-2 mb-4 color-text-tertiary">{example.description}</p>
+        <p
+          className="mt-2 mb-4 color-text-tertiary"
+          dangerouslySetInnerHTML={{ __html: example.description }}
+        />
         <div className="d-flex flex-wrap">
           {example.tags.map((tag) => {
             return (

components/sublanding/ArticleCard.tsx

@@ -16,7 +16,7 @@ export const ArticleCard = ({ card, typeLabel }: Props) => {
         <div className="h6 text-uppercase" data-testid="article-card-type">
           {typeLabel}
         </div>
-        <p className="color-text-secondary my-3">{card.intro}</p>
+        <p className="color-text-secondary my-3" dangerouslySetInnerHTML={{ __html: card.intro }} />
         {card.topics.length > 0 && (
           <div>
             {card.topics.map((topic) => {

content/README.md

@@ -16,6 +16,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
   - [`product`](#product)
   - [`layout`](#layout)
   - [`children`](#children)
+  - [`childGroups`](#childgroups)
   - [`featuredLinks`](#featuredlinks)
   - [`showMiniToc`](#showminitoc)
   - [`miniTocMaxHeadingLevel`](#minitocmaxheadinglevel)
@@ -159,6 +160,12 @@ For a layout named `components/landing`, the value would be `product-landing`.
 - Type: `Array`. Default is `false`.
 - Required on `index.md` pages.
 
+### `childGroups`
+
+- Purpose: Renders children into groups on the homepage. See [Homepage](#homepage) for more info.
+- Type: `Array`. Default is `false`.
+- Require on the homepage `index.md`.
+
 ### `featuredLinks`
 
 - 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
 
 **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.
 
+### Homepage
+
+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.
+
+`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.
+
 ### Creating new sublanding pages
 
 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

@@ -1,9 +1,9 @@
 ---
 title: Your account and profile on GitHub
 shortTitle: Account and profile
-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 %}."
+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 %}.'
 introLinks:
-  quickstart: /get-started/onboarding/getting-started-with-your-github-account 
+  quickstart: /get-started/onboarding/getting-started-with-your-github-account
 featuredLinks:
   guides:
     - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username
@@ -22,7 +22,7 @@ featuredLinks:
     - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address
     - '{% 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 %}'
 changelog:
-  label: profiles, github-themes, notifications
+  label: 'profiles, github-themes, notifications'
   versions:
     fpt: '*'
     ghec: '*'
@@ -40,4 +40,5 @@ children:
   - /setting-up-and-managing-your-github-user-account
   - /setting-up-and-managing-your-github-profile
   - /managing-subscriptions-and-notifications-on-github
----
+---
+

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

@@ -54,15 +54,15 @@ To unsubscribe from conversations you're automatically subscribed to, you can ch
 
 ## Customizing notifications and subscriptions
 
-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.
+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.
 
 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)."
 
 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)."
 
 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)."
 
-{% ifversion fpt or ghes > 2.22 or ghec %}
+{% ifversion fpt or ghes or ghec %}
 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)."
 {% endif %}
 
@@ -92,7 +92,7 @@ From your inbox you can also triage multiple notifications at once. For more inf
 
 ## Customizing your notifications inbox
 
-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)."
+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)."
 
 ## Notification retention policy
 

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

@@ -31,19 +31,19 @@ topics:
 
 You can receive notifications for activity on {% data variables.product.product_location %} in the following locations.
 
-  - The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes > 2.22 or ghec %}
+  - The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes or ghec %}
   - The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_location %}{% endif %}
-  - 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 %}
+  - 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 %}
 
-{% ifversion fpt or ghes > 2.22 or ghec %}
+{% ifversion fpt or ghes or ghec %}
 {% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)."
 {% endif %}
 
 {% data reusables.notifications.shared_state %}
 
 ### Benefits of the notifications inbox
 
-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:
+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:
   - Triage multiple notifications at once.
   - 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.
   - 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
   - Create custom filters to focus on different notifications when you want.
   - Group notifications in your inbox by repository or date to get a quick overview with less context switching
 
-{% ifversion fpt or ghes > 2.22 or ghec %}
+{% ifversion fpt or ghes or ghec %}
 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)."
 {% endif %}
 
@@ -85,15 +85,15 @@ You can customize notifications for a repository. For example, you can choose to
 ### Participating in conversations
 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.
 
-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 %}.
+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 %}.
 
 ![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png)
 
 For example:
   - If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications.
   - If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating".
 
-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.
+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.
 
 ## Customizing your email notifications
 
@@ -218,7 +218,7 @@ Choose how you want to receive workflow run updates for repositories that you ar
 
 {% endif %}
 
-{% ifversion fpt or ghes > 2.22 or ghec %}
+{% ifversion fpt or ghes or ghec %}
 ## Managing your notification settings with {% data variables.product.prodname_mobile %}
 
 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.