Skip to content

Commit 9c57e8a

Browse files
authored
rename Guides featured links to Start here (github#34425)
1 parent 5496fe6 commit 9c57e8a

File tree

31 files changed

+37
-33
lines changed

31 files changed

+37
-33
lines changed

components/context/ProductLandingContext.tsx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ export type ProductLandingContextT = {
4545
productUserExamples: Array<{ username: string; description: string }>
4646
productCommunityExamples: Array<{ repo: string; description: string }>
4747
featuredArticles: Array<{
48-
label: string // Guides
48+
key: string // Featured article section key (startHere, popular, etc.)
49+
label: string // Start here, Popular, etc.
4950
viewAllHref?: string // If provided, adds a "View All ->" to the header
5051
viewAllTitleText?: string // Adds 'title' attribute text for the "View All" href
5152
articles: Array<FeaturedLink>
@@ -133,16 +134,17 @@ export const getProductLandingContextFromRequest = async (
133134

134135
featuredArticles: Object.entries(req.context.featuredLinks || [])
135136
.filter(([key]) => {
136-
return key === 'guides' || key === 'popular' || key === 'videos'
137+
return key === 'startHere' || key === 'popular' || key === 'videos'
137138
})
138139
.map(([key, links]: any) => {
139140
return {
141+
key,
140142
label:
141143
key === 'popular' || key === 'videos'
142144
? req.context.page.featuredLinks[key + 'Heading'] || req.context.site.data.ui.toc[key]
143145
: req.context.site.data.ui.toc[key],
144146
viewAllHref:
145-
key === 'guides' && !req.context.currentCategory && hasGuidesPage
147+
key === 'startHere' && !req.context.currentCategory && hasGuidesPage
146148
? `${req.context.currentPath}/guides`
147149
: '',
148150
articles: links.map((link: any) => {

components/landing/FeaturedArticles.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ export const FeaturedArticles = () => {
1212
return (
1313
<div className="d-lg-flex gutter my-6 py-6">
1414
{featuredArticles.map((section, i) => {
15+
const viewAllTitleText =
16+
section.key === 'startHere' ? `All '${section.label}' content` : `All ${section.label}`
1517
return (
1618
<div
1719
key={section.label + i}
@@ -20,7 +22,7 @@ export const FeaturedArticles = () => {
2022
<ArticleList
2123
title={section.label}
2224
viewAllHref={section.viewAllHref}
23-
{...(section.viewAllHref ? { viewAllTitleText: `All ${section.label}` } : {})}
25+
{...(section.viewAllHref ? { viewAllTitleText } : {})}
2426
articles={section.articles}
2527
/>
2628
</div>

content/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Example:
180180
featuredLinks:
181181
gettingStarted:
182182
- /path/to/page
183-
guides:
183+
startHere:
184184
- /guides/example
185185
popular:
186186
- /path/to/popular/article1

content/account-and-profile/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ intro: 'Make {% data variables.product.product_name %} work best for you by adju
55
introLinks:
66
quickstart: /get-started/onboarding/getting-started-with-your-github-account
77
featuredLinks:
8-
guides:
8+
startHere:
99
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username
1010
- '{% ifversion ghae %}/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard{% endif %}'
1111
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme

content/actions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ introLinks:
66
overview: /actions/learn-github-actions/understanding-github-actions
77
quickstart: /actions/quickstart
88
featuredLinks:
9-
guides:
9+
startHere:
1010
- /actions/learn-github-actions
1111
- /actions/examples
1212
- /actions/automating-builds-and-tests/about-continuous-integration

content/admin/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ introLinks:
6969
changelog:
7070
label: enterprise
7171
featuredLinks:
72-
guides:
72+
startHere:
7373
- '{% ifversion ghae %}/admin/user-management/managing-users-in-your-enterprise/auditing-users-across-your-enterprise{% endif %}'
7474
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise
7575
- /admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies

content/authentication/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ versions:
2121
introLinks:
2222
overview: /authentication/keeping-your-account-and-data-secure/about-authentication-to-github
2323
featuredLinks:
24-
guides:
24+
startHere:
2525
- /authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
2626
- /authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
2727
- /authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication

content/billing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ redirect_from:
88
introLinks:
99
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 %}'
1010
featuredLinks:
11-
guides:
11+
startHere:
1212
- '{% ifversion fpt or ghec %}/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method{% endif %}'
1313
- '{% ifversion fpt %}/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription{% endif %}'
1414
- '{% ifversion ghec %}/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise{% endif %}'

content/code-security/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ intro: 'Build security into your {% data variables.product.prodname_dotcom %} wo
55
introLinks:
66
overview: /code-security/getting-started/github-security-features
77
featuredLinks:
8-
guides:
8+
startHere:
99
- /code-security/getting-started/securing-your-repository
1010
- /code-security/getting-started/securing-your-organization
1111
- '{% ifversion fpt or ghec %}/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory{% endif %}'

content/codespaces/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ introLinks:
66
overview: /codespaces/overview
77
quickstart: /codespaces/getting-started/quickstart
88
featuredLinks:
9-
guides:
9+
startHere:
1010
- /codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization
1111
- /codespaces/getting-started/the-codespace-lifecycle
1212
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers

0 commit comments

Comments
 (0)