jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 21:07:12 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into repo-sync

Browse Source
This commit is contained in:
Octomerger Bot
2023-02-06 10:38:55 -08:00
committed by GitHub
parent 7a3abc70c4 9c57e8a298
commit 857265abcb
32 changed files with 129 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
components/context/ProductLandingContext.tsx
View File

@@ -45,7 +45,8 @@ export type ProductLandingContextT = {
productUserExamples: Array<{ username: string; description: string }>
productCommunityExamples: Array<{ repo: string; description: string }>
featuredArticles: Array<{
label: string // Guides
key: string // Featured article section key (startHere, popular, etc.)
label: string // Start here, Popular, etc.
viewAllHref?: string // If provided, adds a "View All ->" to the header
viewAllTitleText?: string // Adds 'title' attribute text for the "View All" href
articles: Array<FeaturedLink>
@@ -133,16 +134,17 @@ export const getProductLandingContextFromRequest = async (
featuredArticles: Object.entries(req.context.featuredLinks || [])
.filter(([key]) => {
return key === 'guides' || key === 'popular' || key === 'videos'
return key === 'startHere' || key === 'popular' || key === 'videos'
})
.map(([key, links]: any) => {
return {
key,
label:
key === 'popular' || key === 'videos'
? req.context.page.featuredLinks[key + 'Heading'] || req.context.site.data.ui.toc[key]
: req.context.site.data.ui.toc[key],
viewAllHref:
key === 'guides' && !req.context.currentCategory && hasGuidesPage
key === 'startHere' && !req.context.currentCategory && hasGuidesPage
? `${req.context.currentPath}/guides`
: '',
articles: links.map((link: any) => {

4
components/landing/FeaturedArticles.tsx
View File

@@ -12,6 +12,8 @@ export const FeaturedArticles = () => {
return (
<div className="d-lg-flex gutter my-6 py-6">
{featuredArticles.map((section, i) => {
const viewAllTitleText =
section.key === 'startHere' ? `All '${section.label}' content` : `All ${section.label}`
return (
<div
key={section.label + i}
@@ -20,7 +22,7 @@ export const FeaturedArticles = () => {
<ArticleList
title={section.label}
viewAllHref={section.viewAllHref}
{...(section.viewAllHref ? { viewAllTitleText: `All ${section.label}` } : {})}
{...(section.viewAllHref ? { viewAllTitleText } : {})}
articles={section.articles}
/>
</div>

2
content/README.md
View File

@@ -180,7 +180,7 @@ Example:
featuredLinks:
gettingStarted:
- /path/to/page
guides:
startHere:
- /guides/example
popular:
- /path/to/popular/article1

2
content/account-and-profile/index.md
View File

@@ -5,7 +5,7 @@ intro: 'Make {% data variables.product.product_name %} work best for you by adju
introLinks:
quickstart: /get-started/onboarding/getting-started-with-your-github-account
featuredLinks:
guides:
startHere:
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username
- '{% ifversion ghae %}/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard{% endif %}'
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme

2
content/actions/index.md
View File

@@ -6,7 +6,7 @@ introLinks:
overview: /actions/learn-github-actions/understanding-github-actions
quickstart: /actions/quickstart
featuredLinks:
guides:
startHere:
- /actions/learn-github-actions
- /actions/examples
- /actions/automating-builds-and-tests/about-continuous-integration

2
content/admin/index.md
View File

@@ -69,7 +69,7 @@ introLinks:
changelog:
label: enterprise
featuredLinks:
guides:
startHere:
- '{% ifversion ghae %}/admin/user-management/managing-users-in-your-enterprise/auditing-users-across-your-enterprise{% endif %}'
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise
- /admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies

2
content/authentication/index.md
View File

@@ -21,7 +21,7 @@ versions:
introLinks:
overview: /authentication/keeping-your-account-and-data-secure/about-authentication-to-github
featuredLinks:
guides:
startHere:
- /authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
- /authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
- /authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication

2
content/billing/index.md
View File

@@ -8,7 +8,7 @@ redirect_from:
introLinks:
overview: '{% ifversion fpt or ghec %}/billing/managing-your-github-billing-settings/about-billing-on-github{% elsif ghes%}/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise{% endif %}'
featuredLinks:
guides:
startHere:
- '{% ifversion fpt or ghec %}/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method{% endif %}'
- '{% ifversion fpt %}/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription{% endif %}'
- '{% ifversion ghec %}/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise{% endif %}'

2
content/code-security/index.md
View File

@@ -5,7 +5,7 @@ intro: 'Build security into your {% data variables.product.prodname_dotcom %} wo
introLinks:
overview: /code-security/getting-started/github-security-features
featuredLinks:
guides:
startHere:
- /code-security/getting-started/securing-your-repository
- /code-security/getting-started/securing-your-organization
- '{% ifversion fpt or ghec %}/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory{% endif %}'

2
content/codespaces/index.md
View File

@@ -6,7 +6,7 @@ introLinks:
overview: /codespaces/overview
quickstart: /codespaces/getting-started/quickstart
featuredLinks:
guides:
startHere:
- /codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization
- /codespaces/getting-started/the-codespace-lifecycle
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers

2
content/communities/index.md
View File

@@ -8,7 +8,7 @@ redirect_from:
changelog:
label: wikis
featuredLinks:
guides:
startHere:
- /communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
- /communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project
- /communities/moderating-comments-and-conversations/managing-disruptive-comments

2
content/copilot/index.md
View File

@@ -10,7 +10,7 @@ introLinks:
overview: /copilot/overview-of-github-copilot/about-github-copilot
quickstart: /copilot/quickstart
featuredLinks:
guides:
startHere:
- /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code
- /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide
- /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio

2
content/desktop/index.md
View File

@@ -5,7 +5,7 @@ intro: 'With GitHub Desktop, you can interact with GitHub using a GUI instead of
introLinks:
overview: /desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop
featuredLinks:
guides:
startHere:
- /desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github

2
content/developers/index.md
View File

@@ -5,7 +5,7 @@ introLinks:
About apps: /developers/apps/getting-started-with-apps/about-apps
layout: product-landing
featuredLinks:
guides:
startHere:
- /developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps
- /developers/apps/building-github-apps/creating-a-github-app
- /developers/apps/building-github-apps/authenticating-with-github-apps

184
content/developers/webhooks-and-events/events/issue-event-types.md
View File

@@ -18,7 +18,7 @@ GitHub's REST API considers every pull request to be an issue, but not every iss
## Issue event object common properties
Issue events all have the same object structure, except events that are only available in the Timeline Events API. Some events also include additional properties that provide more context about the event resources. Refer to the specific event to for details about any properties that differ from this object format.
Issue events all have the same object structure, except events that are only available in the Timeline Events API. Some events also include additional properties that provide more context about the event resources. Refer to the specific event for details about any properties that differ from this object format.
{% data reusables.issue-events.issue-event-common-properties %}
@@ -26,13 +26,13 @@ Issue events all have the same object structure, except events that are only ava
The issue or pull request was added to a project board. {% data reusables.projects.disabled-projects %}
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull request</li></ul> | **X** | **X** |
### Event object properties
### Properties for added_to_project
{% data reusables.pre-release-program.starfox-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
@@ -44,13 +44,13 @@ The issue or pull request was added to a project board. {% data reusables.projec
The issue or pull request was assigned to a user.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for assigned
{% data reusables.issue-events.issue-event-common-properties %}
{% data reusables.issue-events.assignee-properties %}
@@ -59,13 +59,13 @@ The issue or pull request was assigned to a user.
GitHub unsuccessfully attempted to automatically change the base branch of the pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | |
### Event object properties
### Properties for automatic_base_change_failed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -73,13 +73,13 @@ GitHub unsuccessfully attempted to automatically change the base branch of the p
GitHub successfully attempted to automatically change the base branch of the pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | |
### Event object properties
### Properties for automatic_base_change_succeeded
{% data reusables.issue-events.issue-event-common-properties %}
@@ -87,13 +87,13 @@ GitHub successfully attempted to automatically change the base branch of the pul
The base reference branch of the pull request changed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | |
### Event object properties
### Properties for base_ref_changed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -101,13 +101,13 @@ The base reference branch of the pull request changed.
The issue or pull request was closed. When the `commit_id` is present, it identifies the commit that closed the issue using "closes / fixes" syntax. For more information about the syntax, see "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)".
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for closed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -115,13 +115,13 @@ The issue or pull request was closed. When the `commit_id` is present, it identi
A comment was added to the issue or pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | | **X** |
### Event object properties
### Properties for commented
{% data reusables.issue-events.timeline_events_object_properties %}
@@ -144,13 +144,13 @@ Name | Type | Description
A commit was added to the pull request's `HEAD` branch.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | | **X** |
### Event object properties
### Properties for committed
{% data reusables.issue-events.timeline_events_object_properties %}
@@ -172,13 +172,13 @@ Name | Type | Description
The issue or pull request was linked to another issue or pull request. For more information, see "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)".
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for connected
{% data reusables.issue-events.issue-event-common-properties %}
@@ -186,13 +186,13 @@ The issue or pull request was linked to another issue or pull request. For more
The pull request was converted to draft mode.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for convert_to_draft
{% data reusables.issue-events.issue-event-common-properties %}
@@ -200,13 +200,13 @@ The pull request was converted to draft mode.
The issue was created by converting a note in a project board to an issue. {% data reusables.projects.disabled-projects %}
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li></ul> | **X** | **X** |
### Event object properties
### Properties for converted_note_to_issue
{% data reusables.pre-release-program.starfox-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
@@ -218,13 +218,13 @@ The issue was created by converting a note in a project board to an issue. {% da
The issue was closed and converted to a discussion.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|-----|-----|-----|
| <ul><li>Issues</li></ul> | **X** | |
### Event Object Properties
### Properties for converted_to_discussion
{% data reusables.issue-events.issue-event-common-properties %}
@@ -232,13 +232,13 @@ The issue was closed and converted to a discussion.
The issue or pull request was referenced from another issue or pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | | **X** |
### Event object properties
### Properties for cross-referenced
{% data reusables.issue-events.timeline_events_object_properties %}
@@ -256,13 +256,13 @@ Name | Type | Description
The issue or pull request was removed from a milestone.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for demilestoned
{% data reusables.issue-events.issue-event-common-properties %}
`milestone` | `object` | The milestone object.
@@ -272,13 +272,13 @@ The issue or pull request was removed from a milestone.
The pull request was deployed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for deployed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -286,13 +286,13 @@ The pull request was deployed.
The pull request deployment environment was changed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | |
### Event object properties
### Properties for deployment_environment_changed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -300,13 +300,13 @@ The pull request deployment environment was changed.
The issue or pull request was unlinked from another issue or pull request. For more information, see "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)".
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for disconnected
{% data reusables.issue-events.issue-event-common-properties %}
@@ -314,13 +314,13 @@ The issue or pull request was unlinked from another issue or pull request. For m
The pull request's `HEAD` branch was deleted.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for head_ref_deleted
{% data reusables.issue-events.issue-event-common-properties %}
@@ -328,7 +328,7 @@ The pull request's `HEAD` branch was deleted.
The pull request's `HEAD` branch was restored to the last known commit.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
@@ -338,13 +338,13 @@ The pull request's `HEAD` branch was restored to the last known commit.
The pull request's HEAD branch was force pushed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for head_ref_force_pushed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -352,13 +352,13 @@ The pull request's HEAD branch was force pushed.
A label was added to the issue or pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for labeled
{% data reusables.issue-events.issue-event-common-properties %}
{% data reusables.issue-events.label-properties %}
@@ -367,13 +367,13 @@ A label was added to the issue or pull request.
The issue or pull request was locked.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for locked
{% data reusables.issue-events.issue-event-common-properties %}
`lock_reason` | `string` | The reason an issue or pull request conversation was locked, if one was provided.
@@ -382,13 +382,13 @@ The issue or pull request was locked.
The `actor` was `@mentioned` in an issue or pull request body.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for mentioned
{% data reusables.issue-events.issue-event-common-properties %}
@@ -396,13 +396,13 @@ The `actor` was `@mentioned` in an issue or pull request body.
A user with write permissions marked an issue as a duplicate of another issue, or a pull request as a duplicate of another pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for marked_as_duplicate
{% data reusables.issue-events.issue-event-common-properties %}
@@ -410,13 +410,13 @@ A user with write permissions marked an issue as a duplicate of another issue, o
The pull request was merged. The `commit_id` attribute is the SHA1 of the `HEAD` commit that was merged. The `commit_repository` is always the same as the main repository.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for merged
{% data reusables.issue-events.issue-event-common-properties %}
@@ -424,13 +424,13 @@ The pull request was merged. The `commit_id` attribute is the SHA1 of the `HEAD`
The issue or pull request was added to a milestone.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for milestoned
{% data reusables.issue-events.issue-event-common-properties %}
`milestone` | `object` | The milestone object.
@@ -440,13 +440,13 @@ The issue or pull request was added to a milestone.
The issue or pull request was moved between columns in a project board. {% data reusables.projects.disabled-projects %}
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for moved_columns_in_project
{% data reusables.pre-release-program.starfox-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
@@ -459,13 +459,13 @@ The issue or pull request was moved between columns in a project board. {% data
The issue was pinned.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li></ul> | **X** | **X** |
### Event object properties
### Properties for pinned
{% data reusables.issue-events.issue-event-common-properties %}
@@ -473,13 +473,13 @@ The issue was pinned.
A draft pull request was marked as ready for review.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for ready_for_review
{% data reusables.issue-events.issue-event-common-properties %}
@@ -487,13 +487,13 @@ A draft pull request was marked as ready for review.
The issue was referenced from a commit message. The `commit_id` attribute is the commit SHA1 of where that happened and the commit_repository is where that commit was pushed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for referenced
{% data reusables.issue-events.issue-event-common-properties %}
@@ -501,13 +501,13 @@ The issue was referenced from a commit message. The `commit_id` attribute is the
The issue or pull request was removed from a project board. {% data reusables.projects.disabled-projects %}
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for removed_from_project
{% data reusables.pre-release-program.starfox-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
@@ -519,13 +519,13 @@ The issue or pull request was removed from a project board. {% data reusables.pr
The issue or pull request title was changed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for renamed
{% data reusables.issue-events.issue-event-common-properties %}
`rename` | `object` | The name details.
@@ -536,13 +536,13 @@ The issue or pull request title was changed.
The issue or pull request was reopened.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for reopened
{% data reusables.issue-events.issue-event-common-properties %}
@@ -550,13 +550,13 @@ The issue or pull request was reopened.
The pull request review was dismissed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for review_dismissed
{% data reusables.issue-events.issue-event-common-properties %}
{% data reusables.issue-events.review-dismissed-properties %}
@@ -565,13 +565,13 @@ The pull request review was dismissed.
A pull request review was requested.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for review_requested
{% data reusables.issue-events.issue-event-common-properties %}
{% data reusables.issue-events.review-request-properties %}
@@ -580,13 +580,13 @@ A pull request review was requested.
A pull request review request was removed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for review_request_removed
{% data reusables.issue-events.issue-event-common-properties %}
{% data reusables.issue-events.review-request-properties %}
@@ -595,13 +595,13 @@ A pull request review request was removed.
The pull request was reviewed.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Pull requests</li></ul> | | **X** |
### Event object properties
### Properties for reviewed
{% data reusables.issue-events.timeline_events_object_properties %}
@@ -624,13 +624,13 @@ Name | Type | Description
Someone subscribed to receive notifications for an issue or pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for subscribed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -638,13 +638,13 @@ Someone subscribed to receive notifications for an issue or pull request.
The issue was transferred to another repository.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li></ul> | **X** | **X** |
### Event object properties
### Properties for transferred
{% data reusables.issue-events.issue-event-common-properties %}
@@ -652,13 +652,13 @@ The issue was transferred to another repository.
A user was unassigned from the issue.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for unassigned
{% data reusables.issue-events.issue-event-common-properties %}
{% data reusables.issue-events.assignee-properties %}
@@ -667,13 +667,13 @@ A user was unassigned from the issue.
A label was removed from the issue.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for unlabeled
{% data reusables.issue-events.issue-event-common-properties %}
{% data reusables.issue-events.label-properties %}
@@ -682,13 +682,13 @@ A label was removed from the issue.
The issue was unlocked.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for unlocked
{% data reusables.issue-events.issue-event-common-properties %}
`lock_reason` | `string` | The reason an issue or pull request conversation was locked, if one was provided.
@@ -697,13 +697,13 @@ The issue was unlocked.
An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for unmarked_as_duplicate
{% data reusables.issue-events.issue-event-common-properties %}
@@ -711,13 +711,13 @@ An issue that a user had previously marked as a duplicate of another issue is no
The issue was unpinned.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li></ul> | **X** | **X** |
### Event object properties
### Properties for unpinned
{% data reusables.issue-events.issue-event-common-properties %}
@@ -725,13 +725,13 @@ The issue was unpinned.
Someone unsubscribed from receiving notifications for an issue or pull request.
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | | **X** |
### Event object properties
### Properties for unsubscribed
{% data reusables.issue-events.issue-event-common-properties %}
@@ -740,13 +740,13 @@ Someone unsubscribed from receiving notifications for an issue or pull request.
An organization owner blocked a user from the organization. This was done [through one of the blocked user's comments on the issue](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization#blocking-a-user-in-a-comment).
### Availability
This event is available for the following issue types:
|Issue type | Issue events API | Timeline events API|
|:----------|:----------------:|:-----------------:|
| <ul><li>Issues</li><li>Pull requests</li></ul> | **X** | **X** |
### Event object properties
### Properties for user_blocked
{% data reusables.issue-events.issue-event-common-properties %}

2
content/discussions/index.md
View File

@@ -5,7 +5,7 @@ intro: '{% data variables.product.prodname_discussions %} is a collaborative com
introLinks:
quickstart: /discussions/quickstart
featuredLinks:
guides:
startHere:
- /discussions/collaborating-with-your-community-using-discussions/about-discussions
- /discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion
- /discussions/managing-discussions-for-your-community/moderating-discussions

2
content/education/index.md
View File

@@ -5,7 +5,7 @@ intro: '{% data variables.product.prodname_education %} helps you teach or learn
introLinks:
quickstart: /education/quickstart
featuredLinks:
guides:
startHere:
- education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student
- /education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher
- /education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution

2
content/get-started/index.md
View File

@@ -25,7 +25,7 @@ layout: product-landing
introLinks:
quickstart: /get-started/quickstart
featuredLinks:
guides:
startHere:
- /get-started/learning-about-github/githubs-products
- /get-started/onboarding/getting-started-with-your-github-account
- /get-started/onboarding/getting-started-with-github-team

2
content/github-cli/index.md
View File

@@ -14,7 +14,7 @@ introLinks:
quickstart: /github-cli/github-cli/quickstart
reference: /github-cli/github-cli/github-cli-reference
featuredLinks:
guides:
startHere:
- /github-cli/github-cli/creating-github-cli-extensions
- /github-cli/github-cli/using-github-cli-extensions
- /actions/using-workflows/using-github-cli-in-workflows

2
content/graphql/index.md
View File

@@ -5,7 +5,7 @@ shortTitle: GraphQL API
introLinks:
overview: /graphql/overview/about-the-graphql-api
featuredLinks:
guides:
startHere:
- /graphql/guides/forming-calls-with-graphql
- /graphql/guides/introduction-to-graphql
- /graphql/guides/using-the-explorer

2
content/issues/index.md
View File

@@ -6,7 +6,7 @@ introLinks:
overview: /issues/tracking-your-work-with-issues/about-issues
quickstart: /issues/tracking-your-work-with-issues/quickstart
featuredLinks:
guides:
startHere:
- /issues/tracking-your-work-with-issues/creating-an-issue
- /issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects
- /issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects

2
content/organizations/index.md
View File

@@ -9,7 +9,7 @@ redirect_from:
introLinks:
overview: /organizations/collaborating-with-groups-in-organizations/about-organizations
featuredLinks:
guides:
startHere:
- /get-started/learning-about-github/types-of-github-accounts
- /organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization
- /organizations/organizing-members-into-teams/about-teams

2
content/packages/index.md
View File

@@ -6,7 +6,7 @@ introLinks:
quickstart: /packages/quickstart
reference: /packages/manage-packages
featuredLinks:
guides:
startHere:
- /packages/learn-github-packages
- /packages/managing-github-packages-using-github-actions-workflows
- /packages/learn-github-packages/installing-a-package

2
content/pages/index.md
View File

@@ -6,7 +6,7 @@ introLinks:
quickstart: /pages/quickstart
overview: /pages/getting-started-with-github-pages/about-github-pages
featuredLinks:
guides:
startHere:
- /pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
- /pages/getting-started-with-github-pages/creating-a-github-pages-site
- '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site{% endif %}'

2
content/pull-requests/index.md
View File

@@ -4,7 +4,7 @@ intro: 'Learn how to use pull requests to suggest changes to a project, receive
introLinks:
overview: /pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
featuredLinks:
guides:
startHere:
- /pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message
- /pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line
- /pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository

2
content/repositories/index.md
View File

@@ -5,7 +5,7 @@ introLinks:
quickstart: /get-started/quickstart/create-a-repo
overview: /repositories/creating-and-managing-repositories/about-repositories
featuredLinks:
guides:
startHere:
- /repositories/creating-and-managing-repositories/cloning-a-repository
- /repositories/creating-and-managing-repositories/restoring-a-deleted-repository
- /repositories/working-with-files/managing-files/adding-a-file-to-a-repository

2
content/rest/index.md
View File

@@ -6,7 +6,7 @@ introLinks:
quickstart: /rest/quickstart
overview: /rest/guides/getting-started-with-the-rest-api
featuredLinks:
guides:
startHere:
- /rest/guides/getting-started-with-the-rest-api
- /rest/guides/basics-of-authentication
- /rest/guides/best-practices-for-integrators

2
content/search-github/index.md
View File

@@ -4,7 +4,7 @@ intro: 'Learn how to use the search functions available on GitHub to find differ
introLinks:
overview: /search-github/getting-started-with-searching-on-github/about-searching-on-github
featuredLinks:
guides:
startHere:
- /search-github/searching-on-github/searching-issues-and-pull-requests
- /search-github/searching-on-github/searching-code
- /search-github/searching-on-github/searching-for-repositories

2
content/sponsors/index.md
View File

@@ -11,7 +11,7 @@ changelog:
label: sponsors
examples_source: data/product-examples/sponsors/user-examples.yml
featuredLinks:
guides:
startHere:
- /sponsors/sponsoring-open-source-contributors/managing-your-sponsorship
- /sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization
- /sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors

2
content/support/index.md
View File

@@ -22,7 +22,7 @@ topics:
introLinks:
overview: /support/learning-about-github-support/about-github-support
featuredLinks:
guides:
startHere:
- /support/contacting-github-support/creating-a-support-ticket
- /support/contacting-github-support/viewing-and-updating-support-tickets
- '{% ifversion ghes or ghec %}/support/learning-about-github-support/about-ticket-priority{% endif %}'

2
data/ui.yml
View File

@@ -46,7 +46,7 @@ homepage:
toc:
getting_started: Getting started
popular: Popular
guides: Guides
startHere: Start here
whats_new: What's new
videos: Videos
all_changelogs: All changelog posts

2
lib/frontmatter.js
View File

@@ -97,7 +97,7 @@ export const schema = {
type: 'array',
items: { type: 'string' },
},
guides: {
startHere: {
type: 'array',
items: { type: 'string' },
},