jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-05 21:04:17 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #31488 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2024-02-06 15:27:31 -06:00
committed by GitHub
parent 3618780190 92af780afa
commit dd21a9c278
62 changed files with 172 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/local-dev.yml vendored
View File

@@ -69,7 +69,7 @@ jobs:
set -e
# This test assumes this one file always exists
ls content/get-started/quickstart/hello-world.md
ls content/get-started/start-your-journey/hello-world.md
# Not sure if it matters but we're in a detached HEAD state
# after the actions/checkout action.
@@ -82,7 +82,7 @@ jobs:
# To know what will fail the markdown lint, see src/content-linter/style/github-docs.js
# Add some NOT valid Markdown to it
# In this case an internal link with a hardcode /en/ prefix.
echo "This *is** not valid [Markdown](/en/foo)" >> content/get-started/quickstart/hello-world.md
echo "This *is** not valid [Markdown](/en/foo)" >> content/get-started/start-your-journey/hello-world.md
git commit -a -m "this should fail"
exit_code=$?
if [ $exit_code != 0 ]; then

2
content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md
View File

@@ -42,7 +42,7 @@ You can send an invitation to collaborate in your repository directly to someone
{% endif %}
1. Ask for the username of the person you're inviting as a collaborator.{% ifversion fpt or ghec %} If they don't have a username yet, they can sign up for {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}
1. Ask for the username of the person you're inviting as a collaborator.{% ifversion fpt or ghec %} If they don't have a username yet, they can sign up for {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
1. In the "Access" section of the sidebar, click **{% octicon "people" aria-hidden="true" %} Collaborators**.

2
content/admin/overview/setting-up-a-trial-of-github-enterprise-cloud.md
View File

@@ -53,7 +53,7 @@ If you invite an existing organization into your trial enterprise, all of these
## Setting up your trial of {% data variables.product.prodname_ghe_cloud %}
Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be signed into a personal account. If you don't already have a personal account on {% data variables.product.prodname_dotcom_the_website %}, you must create one. For more information, see "[AUTOTITLE](/free-pro-team@latest/get-started/quickstart/creating-an-account-on-github)."
Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be signed into a personal account. If you don't already have a personal account on {% data variables.product.prodname_dotcom_the_website %}, you must create one. For more information, see "[AUTOTITLE](/free-pro-team@latest/get-started/start-your-journey/creating-an-account-on-github)."
{% note %}

2
content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md
View File

@@ -40,7 +40,7 @@ You will need to create a new personal account and then use this account to crea
{% warning %}
**Warning**: Although you can generate the {% data variables.product.pat_v1 %} using your existing personal account, we strongly recommend creating a new account with access only to the target repositories required for your scenario. This is because the access token's `repository` permission grants access to all of the repositories that the account has access to. For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)" and "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#considering-cross-repository-access)."
**Warning**: Although you can generate the {% data variables.product.pat_v1 %} using your existing personal account, we strongly recommend creating a new account with access only to the target repositories required for your scenario. This is because the access token's `repository` permission grants access to all of the repositories that the account has access to. For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)" and "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#considering-cross-repository-access)."
{% endwarning %}
1. Give the new account read access to the required repositories. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository)."

2
content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md
View File

@@ -14,7 +14,7 @@ versions:
## About {% data variables.product.prodname_desktop %} installation
You can install {% data variables.product.prodname_desktop %} on supported operating systems, which currently include {% data variables.desktop.mac-osx-versions %} and {% data variables.desktop.windows-versions %}. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}.{% ifversion fpt or ghec %} For more information about creating an account, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
You can install {% data variables.product.prodname_desktop %} on supported operating systems, which currently include {% data variables.desktop.mac-osx-versions %} and {% data variables.desktop.windows-versions %}. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}.{% ifversion fpt or ghec %} For more information about creating an account, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
{% windows %}

2
content/desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md
View File

@@ -21,7 +21,7 @@ If you have an account on {% data variables.product.prodname_dotcom %} or {% dat
### Creating an account
If you do not already have an account on {% data variables.location.product_location %}, create one now.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}
If you do not already have an account on {% data variables.location.product_location %}, create one now.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}
{% ifversion ghec %}If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %}If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}

4
content/desktop/overview/getting-started-with-github-desktop.md
View File

@@ -33,7 +33,7 @@ After you have installed {% data variables.product.prodname_desktop %}, you can
{% mac %}
1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
{% data reusables.desktop.mac-select-desktop-menu %}
1. In the "Preferences" window, on the **Accounts** pane, click one of the **Sign In** buttons to sign in to your account on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_enterprise %}.
@@ -44,7 +44,7 @@ After you have installed {% data variables.product.prodname_desktop %}, you can
{% windows %}
1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
1. In the File drop-down menu, click **Options**. In the options window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[AUTOTITLE](/desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop)."
![Screenshot of the "Accounts" pane in the "Options" window. Next to "GitHub.com", a button, labeled "Sign In", is outlined in orange.](/assets/images/help/desktop/windows-sign-in-github.png)

4
content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md
View File

@@ -18,7 +18,7 @@ shortTitle: Apply to Global Campus
To be eligible for {% data variables.product.prodname_global_campus %}, including {% data variables.product.prodname_student_pack %} and other benefits, you must:
- Be currently enrolled in a degree or diploma granting course of study such as a high school, secondary school, college, university, homeschool, or similar educational institution
- Have a verifiable school-issued email address or upload documents that prove your current student status
- Have a [{% data variables.product.prodname_dotcom %} personal account](/get-started/quickstart/creating-an-account-on-github)
- Have a [{% data variables.product.prodname_dotcom %} personal account](/get-started/start-your-journey/creating-an-account-on-github)
- Be at least 13 years old
Documents that prove your current student status include a picture of your school ID with current enrollment date, class schedule, transcript, and affiliation or enrollment verification letter.
@@ -57,6 +57,6 @@ To see when your free access to the {% data variables.product.prodname_student_p
## Further reading
- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/why-wasnt-my-application-to-global-campus-for-students-approved)"
- "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)"
- "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)"
- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom)"
- [{% data variables.product.prodname_education %}](https://education.github.com)

2
content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher.md
View File

@@ -21,7 +21,7 @@ shortTitle: Apply to Global Campus
{% data reusables.education.educator-requirements %}
For more information about personal accounts on {% data variables.product.product_name %}, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."
For more information about personal accounts on {% data variables.product.product_name %}, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."
## Applying to {% data variables.product.prodname_global_campus %}

6
content/education/guides.md
View File

@@ -11,8 +11,8 @@ shortTitle: Guides
Teachers, students, and researchers can use tools from {% data variables.product.product_name %} to enrich a software development curriculum and develop real-world collaboration skills.
- [Sign up for a new {% data variables.product.prodname_dotcom %} account](/get-started/quickstart/creating-an-account-on-github)
- [Git and {% data variables.product.prodname_dotcom %} quickstart](/get-started/quickstart)
- [Sign up for a new {% data variables.product.prodname_dotcom %} account](/get-started/start-your-journey/creating-an-account-on-github)
- [Git and {% data variables.product.prodname_dotcom %} quickstart](/get-started/start-your-journey)
- [About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)
- [Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)
- [Apply to {% data variables.product.prodname_global_campus %} as a student](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)
@@ -36,7 +36,7 @@ Administer a classroom, assign and review work from your students, and teach the
Incorporate {% data variables.product.prodname_dotcom %} into your education, and use the same tools as the professionals.
- [Git and {% data variables.product.prodname_dotcom %} learning resources](/get-started/quickstart/git-and-github-learning-resources)
- [Git and {% data variables.product.prodname_dotcom %} learning resources](/get-started/start-your-journey/git-and-github-learning-resources)
- [{% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students)
- [Try {% data variables.product.prodname_desktop %}](/desktop)
- [Try {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)

4
content/education/index.md
View File

@@ -14,8 +14,8 @@ featuredLinks:
- /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
guideCards:
- /get-started/quickstart/creating-an-account-on-github
- /get-started/quickstart/git-and-github-learning-resources
- /get-started/start-your-journey/creating-an-account-on-github
- /get-started/start-your-journey/git-and-github-learning-resources
popular:
- /education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom
- /education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students

2
content/get-started/getting-started-with-git/git-cheatsheet.md
View File

@@ -14,4 +14,4 @@ intro: This Git cheat sheet is a time saver when you forget a command or don't w
---
Learning all available Git commands at once can be a daunting task. You can use "[Git Cheat Sheets](https://training.github.com/)" for a quick reference to frequently used commands. The "Using Git" cheat sheet is available in several languages.
In addition, take a look at our [Git and GitHub learning resources](/get-started/quickstart/git-and-github-learning-resources) page that links to guides, videos and more.
In addition, take a look at our [Git and GitHub learning resources](/get-started/start-your-journey/git-and-github-learning-resources) page that links to guides, videos and more.

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

@@ -23,9 +23,10 @@ versions:
ghec: '*'
layout: product-landing
introLinks:
quickstart: /get-started/quickstart
quickstart: /get-started/start-your-journey
featuredLinks:
startHere:
- /get-started/start-your-journey/about-github-and-git
- /get-started/learning-about-github/githubs-plans
- /get-started/onboarding/getting-started-with-your-github-account
- /get-started/onboarding/getting-started-with-github-team
@@ -33,8 +34,8 @@ featuredLinks:
- /get-started/onboarding/getting-started-with-github-enterprise-server
- /get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github
popular:
- /get-started/quickstart/creating-an-account-on-github
- /get-started/quickstart/hello-world
- /get-started/start-your-journey/creating-an-account-on-github
- /get-started/start-your-journey/hello-world
- /get-started/getting-started-with-git/set-up-git
- /get-started/using-github-docs/about-versions-of-github-docs
- /get-started/learning-about-github/github-glossary
@@ -49,7 +50,7 @@ topics:
- Notifications
- Accounts
children:
- /quickstart
- /start-your-journey
- /onboarding
- /using-github
- /learning-about-github

2
content/get-started/learning-about-github/types-of-github-accounts.md
View File

@@ -81,6 +81,6 @@ Your enterprise account is a collection of all the organizations {% ifversion gh
## Further reading
{% ifversion fpt or ghec %}
- "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)"{% endif %}
- "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)"{% endif %}
- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)"
- [Organizing people for successful collaboration](https://vimeo.com/333786093) video in {% data variables.product.company_short %} Resources

2
content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md
View File

@@ -160,7 +160,7 @@ You and your enterprise members can use GitHub's learning and support resources
Enterprise members can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://skills.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by a friendly bot.
For more information, see "[AUTOTITLE](/get-started/quickstart/git-and-github-learning-resources)."
For more information, see "[AUTOTITLE](/get-started/start-your-journey/git-and-github-learning-resources)."
### 3. Supporting the open source community

2
content/get-started/onboarding/getting-started-with-github-team.md
View File

@@ -17,7 +17,7 @@ Organizations are shared accounts where businesses and open-source projects can
### 2. Creating an organization and signing up for {% data variables.product.prodname_team %}
Before creating an organization, you will need to create a personal account or log in to your existing account on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."
Before creating an organization, you will need to create a personal account or log in to your existing account on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."
Once your personal account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)."

6
content/get-started/quickstart/about-github-and-git.md → content/get-started/start-your-journey/about-github-and-git.md
View File

@@ -13,6 +13,8 @@ topics:
- GitHub
- Collaboration
- Community
redirect_from:
- /get-started/quickstart/about-github-and-git
---
## About {% data variables.product.prodname_dotcom %}
@@ -63,13 +65,13 @@ If you're new to {% data variables.product.prodname_dotcom %}, and unfamiliar wi
- **Personalise your profile** to share your interests and skills.
- **Explore {% data variables.product.prodname_dotcom %}** to find inspiration for your own projects and connect with others.
- Learn how to **download** interesting code for your own use.
- Learn how to **upload** something you're working to a {% data variables.product.prodname_dotcom %} repository.
- Learn how to **upload** something you're working on to a {% data variables.product.prodname_dotcom %} repository.
{% ifversion fpt or ghec %}
## Next steps
- "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)"
- "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)"
{% endif %}

5
content/get-started/quickstart/creating-an-account-on-github.md → content/get-started/start-your-journey/creating-an-account-on-github.md
View File

@@ -10,6 +10,7 @@ redirect_from:
- /articles/signing-up-for-github
- /github/getting-started-with-github/signing-up-for-github
- /get-started/signing-up-for-github
- /get-started/quickstart/creating-an-account-on-github
versions:
fpt: '*'
ghec: '*'
@@ -25,7 +26,7 @@ To get started with {% data variables.product.prodname_dotcom %}, you'll need to
Later, you can explore the different types of accounts that {% data variables.product.prodname_dotcom %} offers, and decide if you need a billing plan. For more information, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)" and "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)."
Note that the steps in this article don't apply to {% data variables.product.prodname_emus %}. If your {% data variables.product.prodname_dotcom %} account has been created for you by your company, you can skip this article and continue to "[AUTOTITLE](/get-started/quickstart/hello-world)."
Note that the steps in this article don't apply to {% data variables.product.prodname_emus %}. If your {% data variables.product.prodname_dotcom %} account has been created for you by your company, you can skip this article and continue to "[AUTOTITLE](/get-started/start-your-journey/hello-world)."
## Signing up for a new personal account
@@ -39,7 +40,7 @@ If you're having problems verifying your email address, there are some troublesh
## Next steps
- Now that you've created your personal account, we'll start to explore the basics of {% data variables.product.prodname_dotcom %}. In the next tutorial, "[AUTOTITLE](/get-started/quickstart/hello-world)," you'll learn about repositories and how to create one, and you'll be introduced to concepts such as branching, commits, and pull requests.
- Now that you've created your personal account, we'll start to explore the basics of {% data variables.product.prodname_dotcom %}. In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/hello-world)," you'll learn about repositories and how to create one, and you'll be introduced to concepts such as branching, commits, and pull requests.
- We strongly recommend that you configure 2FA for your account. 2FA is an extra layer of security that can help keep your account secure. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)."
## Further reading

4
content/get-started/quickstart/downloading-files-from-github.md → content/get-started/start-your-journey/downloading-files-from-github.md
View File

@@ -9,6 +9,8 @@ versions:
topics:
- Repositories
type: tutorial
redirect_from:
- /get-started/quickstart/downloading-files-from-github
---
## Introduction
@@ -54,7 +56,7 @@ You now have a copy of the repository's files saved as a zip file on your local
## Next steps
- In the next tutorial, "[AUTOTITLE](/get-started/quickstart/uploading-a-project-to-github)," you'll learn how to upload your own files to a remote repository on {% data variables.product.product_name %}.
- In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/uploading-a-project-to-github)," you'll learn how to upload your own files to a remote repository on {% data variables.product.product_name %}.
## Further reading

3
content/get-started/quickstart/finding-inspiration-on-github.md → content/get-started/start-your-journey/finding-inspiration-on-github.md
View File

@@ -7,6 +7,7 @@ redirect_from:
- /github/getting-started-with-github/be-social
- /github/getting-started-with-github/quickstart/be-social
- /get-started/quickstart/be-social
- /get-started/quickstart/finding-inspiration-on-github
intro: 'You can find inspiration for your own projects and learning on {% data variables.product.prodname_dotcom %} and connect with a community.'
permissions: '{% data reusables.enterprise-accounts.emu-permission-interact %}'
versions:
@@ -68,7 +69,7 @@ Following people and organizations on {% data variables.product.product_name %}
## Next steps
- {% data reusables.support.connect-in-the-forum-bootcamp %}
- In the next tutorial, "[AUTOTITLE](/get-started/quickstart/downloading-files-from-github)," you'll learn how to download files from {% data variables.product.product_name %} for your own use, and learn the differences between downloading, cloning, and forking repositories.
- In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/downloading-files-from-github)," you'll learn how to download files from {% data variables.product.product_name %} for your own use, and learn the differences between downloading, cloning, and forking repositories.
## Further reading

1
content/get-started/quickstart/git-and-github-learning-resources.md → content/get-started/start-your-journey/git-and-github-learning-resources.md
View File

@@ -6,6 +6,7 @@ redirect_from:
- /articles/git-and-github-learning-resources
- /github/getting-started-with-github/git-and-github-learning-resources
- /github/getting-started-with-github/quickstart/git-and-github-learning-resources
- /get-started/quickstart/git-and-github-learning-resources
intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources available.'
versions:
fpt: '*'

8
content/get-started/quickstart/hello-world.md → content/get-started/start-your-journey/hello-world.md
View File

@@ -9,6 +9,8 @@ type: quick_start
topics:
- Pull requests
- Fundamentals
redirect_from:
- /get-started/quickstart/hello-world
---
## Introduction
@@ -24,7 +26,7 @@ In this quickstart guide, you will:
### Prerequisites
- You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}
- You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}
- You don't need to know how to code, use the command line, or install Git (the version control software that {% data variables.product.product_name %} is built on).
@@ -32,7 +34,7 @@ In this quickstart guide, you will:
The first thing we'll do is create a repository. You can think of a repository as a folder that contains related items, such as files, images, videos, or even other folders. A repository usually groups together items that belong to the same "project" or thing you're working on.
Often, repositories include a README file, a file with information about your project. README files are written in Markdown, which is an easy-to-read, easy-to-write language for formatting plain text. We'll learn more about Markdown in the next tutorial, "[AUTOTITLE](/get-started/quickstart/setting-up-your-profile)."
Often, repositories include a README file, a file with information about your project. README files are written in Markdown, which is an easy-to-read, easy-to-write language for formatting plain text. We'll learn more about Markdown in the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/setting-up-your-profile)."
{% data variables.product.product_name %} lets you add a README file at the same time you create your new repository. {% data variables.product.product_name %} also offers other common options such as a license file, but you do not have to select any of them now.
@@ -155,7 +157,7 @@ As part of that, we've learned how to:
- Take a look at your {% data variables.product.product_name %} profile and you'll see your work reflected on your contribution graph.
- If you want to practice the skills you've learned in this tutorial again, try the [{% data variables.product.prodname_learning %}](https://skills.github.com/) "Introduction to {% data variables.product.prodname_dotcom %}" course.
- In the next tutorial, "[AUTOTITLE](/get-started/quickstart/setting-up-your-profile)," you'll learn how to personalize your profile and you'll also learn some basic Markdown syntax for writing on {% data variables.product.product_name %}.
- In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/setting-up-your-profile)," you'll learn how to personalize your profile and you'll also learn some basic Markdown syntax for writing on {% data variables.product.product_name %}.
## Further reading

6
content/get-started/quickstart/index.md → content/get-started/start-your-journey/index.md
View File

@@ -1,6 +1,6 @@
---
title: Quickstart
intro: 'Get started using {% data variables.product.product_name %} to manage Git repositories and collaborate with others.'
title: Start your journey
intro: 'Learn the basics of {% data variables.product.product_name %}.'
versions:
fpt: '*'
ghes: '*'
@@ -22,5 +22,5 @@ children:
- /git-and-github-learning-resources
redirect_from:
- /github/getting-started-with-github/quickstart
- /get-started/quickstart
---

10
content/get-started/quickstart/setting-up-your-profile.md → content/get-started/start-your-journey/setting-up-your-profile.md
View File

@@ -10,6 +10,8 @@ topics:
- Profile
- Accounts
type: how_to
redirect_from:
- /get-started/quickstart/setting-up-your-profile
---
## About your profile
@@ -44,11 +46,11 @@ Next, we'll add some basic information about yourself to share with other {% dat
1. On your profile page, under your profile picture, click **Edit profile**.
1. Under "Bio", write one or two sentences about yourself, such as who you are and what you do.
{% tip %}
{% note %}
**Tip:** Keep the bio short; we'll add a longer description of your interests in your profile README in the section below.
**Note:** Keep the bio short; we'll add a longer description of your interests in your profile README in the section below.
{% endtip %}
{% endnote %}
1. To add an emoji to your bio, visit "[Emoji cheat sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)" and copy and paste an emoji into the "Bio" dialog box.
1. Optionally, add your {% ifversion profile-pronouns %}preferred pronouns,{% endif %} workplace, location and timezone{% ifversion profile-social-links %}, and any links to your personal website and social accounts{% endif %}. {% ifversion profile-pronouns %}{% data reusables.profile.pronouns-visibility %}{% endif %}
1. Click **Save**.
@@ -93,7 +95,7 @@ In the following steps, we'll create and edit your profile README.
- If you want to learn more Markdown syntax and add more sophisticated formatting to your profile README, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)."
- Alternatively, try the [{% data variables.product.prodname_learning %}](https://skills.github.com/) "Communicate using Markdown" course.
- In the next tutorial, "[AUTOTITLE](/get-started/quickstart/finding-inspiration-on-github)," we'll look at ways you can explore {% data variables.product.product_name %} to find projects and people that interest you.
- In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/finding-inspiration-on-github)," we'll look at ways you can explore {% data variables.product.product_name %} to find projects and people that interest you.
## Further reading

4
content/get-started/quickstart/uploading-a-project-to-github.md → content/get-started/start-your-journey/uploading-a-project-to-github.md
View File

@@ -9,6 +9,8 @@ versions:
topics:
- Repositories
type: tutorial
redirect_from:
- /get-started/quickstart/uploading-a-project-to-github
---
## Introduction
@@ -25,7 +27,7 @@ If you're already familiar with Git, and you're looking for information on how t
## Prerequisites
- You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}
- You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}
- You should have a group of files you'd like to upload.
## Step 1: Create a new repository for your project

2
content/get-started/using-git/about-git.md
View File

@@ -103,7 +103,7 @@ git push --set-upstream origin my-branch
### Example: Start a new repository and publish it to {% data variables.product.product_name %}
First, you will need to create a new repository on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/quickstart/hello-world)." **Do not** initialize the repository with a README, .gitignore or License file. This empty repository will await your code.
First, you will need to create a new repository on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/start-your-journey/hello-world)." **Do not** initialize the repository with a README, .gitignore or License file. This empty repository will await your code.
```bash
# create a new directory, and initialize it with git-specific functions

4
content/get-started/using-github/connecting-to-github.md
View File

@@ -32,7 +32,7 @@ Working directly on {% data variables.location.product_location %} is often the
- If you're already signed in to {% data variables.product.prodname_dotcom %}, you have access to any repository where you have the necessary permissions, so you don't need to set up any additional authentication on your computer.
- You can commit changes in the user interface, so you don't need to use the command line or memorize any Git commands.
For a tutorial to help you get started with making changes in the browser, see "[AUTOTITLE](/get-started/quickstart/hello-world)."
For a tutorial to help you get started with making changes in the browser, see "[AUTOTITLE](/get-started/start-your-journey/hello-world)."
{% ifversion fpt or ghec %}
@@ -71,7 +71,7 @@ For more information about how to authenticate to {% data variables.product.prod
| Tool | Use case | Browser or desktop |
| ---- | -------- | ------------------ |
| **On {% data variables.location.product_location %}** | You want a visual interface and need to make quick, simple changes, typically involving a single commit. For an introduction, see "[AUTOTITLE](/get-started/quickstart/hello-world)." | Browser |
| **On {% data variables.location.product_location %}** | You want a visual interface and need to make quick, simple changes, typically involving a single commit. For an introduction, see "[AUTOTITLE](/get-started/start-your-journey/hello-world)." | Browser |
{%- ifversion fpt or ghec %}
| **github.dev** | You want to make more complex changes to a repository than is possible on {% data variables.product.prodname_dotcom_the_website %}, but don't need to work with a terminal or tools you have installed on your computer. For more information, see "[AUTOTITLE](/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor)." | Browser |
| **{% data variables.product.prodname_github_codespaces %}** | You need the resources of a computer to do things like run scripts, create a test build of your project, or install dependencies, and you want to get started quickly by working in a cloud-based environment. For more information, see "[AUTOTITLE](/codespaces/overview)." | Browser or desktop |

2
content/get-started/using-github/github-flow.md
View File

@@ -23,7 +23,7 @@ topics:
## Prerequisites
To follow {% data variables.product.prodname_dotcom %} flow, you will need a {% data variables.product.prodname_dotcom %} account and a repository. {% ifversion fpt or ghec %}For information on how to create an account, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% elsif ghes %}For more information, contact your site administrator.{% endif %} For information on how to create a repository, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/quickstart-for-repositories)."{% ifversion fpt or ghec %} For information on how to find an existing repository to contribute to, see "[AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %}
To follow {% data variables.product.prodname_dotcom %} flow, you will need a {% data variables.product.prodname_dotcom %} account and a repository. {% ifversion fpt or ghec %}For information on how to create an account, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% elsif ghes %}For more information, contact your site administrator.{% endif %} For information on how to create a repository, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/quickstart-for-repositories)."{% ifversion fpt or ghec %} For information on how to find an existing repository to contribute to, see "[AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %}
## Following {% data variables.product.prodname_dotcom %} flow

2
content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md
View File

@@ -26,6 +26,6 @@ You can also consider {% data variables.product.prodname_emus %}. {% data reusab
## Adding users to your organization
1. Provide each person instructions to [create a personal account](/get-started/quickstart/creating-an-account-on-github).
1. Provide each person instructions to [create a personal account](/get-started/start-your-journey/creating-an-account-on-github).
1. Ask for the username of each person you want to give organization membership to.
1. [Invite the new personal accounts to join](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization) your organization. Use [organization roles](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization) and [repository permissions](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization) to limit the access of each account.

2
content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md
View File

@@ -22,7 +22,7 @@ shortTitle: Convert organization to user
{% endnote %}
1. [Sign up](/get-started/quickstart/creating-an-account-on-github) for a new account on GitHub.
1. [Sign up](/get-started/start-your-journey/creating-an-account-on-github) for a new account on GitHub.
1. [Have the user's role changed to an owner](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization).
1. {% data variables.product.signin_link %} to the new personal account.
1. [Transfer each organization repository](/repositories/creating-and-managing-repositories/transferring-a-repository) to the new personal account.

2
data/reusables/desktop/get-an-account.md
View File

@@ -1 +1 @@
you must already have an account on {% data variables.location.product_location %}.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
you must already have an account on {% data variables.location.product_location %}.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}

2
data/reusables/getting-started/being-social.md
View File

@@ -1 +1 @@
Each repository on {% data variables.product.prodname_dotcom %} is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/quickstart/finding-inspiration-on-github)."
Each repository on {% data variables.product.prodname_dotcom %} is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/start-your-journey/finding-inspiration-on-github)."

2
data/reusables/getting-started/learning-enterprise.md
View File

@@ -1,3 +1,3 @@
Your enterprise members can learn new skills by completing fun, realistic projects in their very own GitHub repository with [{% data variables.product.prodname_learning %}](https://skills.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by a friendly bot.
For more information, see "[AUTOTITLE](/get-started/quickstart/git-and-github-learning-resources)."
For more information, see "[AUTOTITLE](/get-started/start-your-journey/git-and-github-learning-resources)."

2
data/reusables/getting-started/learning.md
View File

@@ -1,3 +1,3 @@
You can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://skills.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by a friendly bot.
For more information, see "[AUTOTITLE](/get-started/quickstart/git-and-github-learning-resources)."
For more information, see "[AUTOTITLE](/get-started/start-your-journey/git-and-github-learning-resources)."

2
src/content-render/tests/render-changed-and-deleted-files.js
View File

@@ -8,7 +8,7 @@
* They both need to a whitespace-separated list of paths to content files.
* For example:
*
* export CHANGED_FILES="content/get-started/index.md content/get-started/quickstart/hello-world.md"
* export CHANGED_FILES="content/get-started/index.md content/get-started/start-your-journey/hello-world.md"
*
* If any of the paths in there, split by ' ', don't match real files, the
* test will fail before it even starts. Meaning, it will throw an error

8
src/fixtures/fixtures/content/get-started/foo/autotitling.md
View File

@@ -14,13 +14,13 @@ type: how_to
Links that use the word `AUTOTITLE` in the Markdown become the
title of the document it links to.
For example "[AUTOTITLE](/get-started/quickstart/hello-world)."
For example "[AUTOTITLE](/get-started/start-your-journey/hello-world)."
It should also work if the URL as a query string, like this:
[AUTOTITLE](/get-started/quickstart/hello-world?tool=linux)
[AUTOTITLE](/get-started/start-your-journey/hello-world?tool=linux)
Equally, if the link has a hash on it:
[AUTOTITLE](/get-started/quickstart/hello-world#this-hash)
[AUTOTITLE](/get-started/start-your-journey/hello-world#this-hash)
Or, a combination of query string and hash:
[AUTOTITLE](/get-started/quickstart/hello-world?tool=linux#this-hash)
[AUTOTITLE](/get-started/start-your-journey/hello-world?tool=linux#this-hash)

4
src/fixtures/fixtures/content/get-started/foo/cross-version-linking.md
View File

@@ -11,6 +11,6 @@ type: how_to
## Get right into it
[Hello world always in free-pro-team](/free-pro-team@latest/get-started/quickstart/hello-world)
[Hello world always in free-pro-team](/free-pro-team@latest/get-started/start-your-journey/hello-world)
[Autotitling page always in enterprise-server latest](/enterprise-server@latest/get-started/quickstart/hello-world)
[Autotitling page always in enterprise-server latest](/enterprise-server@latest/get-started/start-your-journey/hello-world)

4
src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md
View File

@@ -12,10 +12,10 @@ type: how_to
{% ifversion ghes %}
"[Autotitle](/get-started/quickstart/hello-world)."
"[Autotitle](/get-started/start-your-journey/hello-world)."
{% else %}
"[AUTOTITLES](/get-started/quickstart/hello-world)."
"[AUTOTITLES](/get-started/start-your-journey/hello-world)."
{% endif %}

6
src/fixtures/fixtures/content/get-started/index.md
View File

@@ -9,16 +9,16 @@ versions:
ghec: '*'
layout: product-landing
introLinks:
quickstart: /get-started/quickstart
quickstart: /get-started/start-your-journey
featuredLinks:
guides:
- /get-started/quickstart/hello-world
- /get-started/start-your-journey/hello-world
popular:
- /get-started/foo/bar
guideCards:
- /get-started/foo/autotitling
children:
- /quickstart
- /start-your-journey
- /foo
- /video-transcripts
- /minitocs

0
src/fixtures/fixtures/content/get-started/quickstart/dynamic-title.md → src/fixtures/fixtures/content/get-started/start-your-journey/dynamic-title.md
View File

2
src/fixtures/fixtures/content/get-started/quickstart/hello-world.md → src/fixtures/fixtures/content/get-started/start-your-journey/hello-world.md
View File

@@ -27,7 +27,7 @@ like "Enterprise Server X.Y". It should change the above sentence.
## Link to a page with variable title
"[AUTOTITLE](/get-started/quickstart/dynamic-title)"
"[AUTOTITLE](/get-started/start-your-journey/dynamic-title)"
"[AUTOTITLE](/get-started/foo/cross-version-linking)"

4
src/fixtures/fixtures/content/get-started/quickstart/index.md → src/fixtures/fixtures/content/get-started/start-your-journey/index.md
View File

@@ -1,5 +1,5 @@
---
title: Quickstart
title: Start your journey
intro: 'Get started using {% data variables.product.product_name %} to manage Git repositories and collaborate with others.'
versions:
fpt: '*'
@@ -10,4 +10,6 @@ children:
- /hello-world
- /link-rewriting
- /dynamic-title
redirect_from:
- /get-started/quickstart
---

0
src/fixtures/fixtures/content/get-started/quickstart/link-rewriting.md → src/fixtures/fixtures/content/get-started/start-your-journey/link-rewriting.md
View File

2
src/fixtures/fixtures/content/index.md
View File

@@ -2,7 +2,7 @@
title: '{% data variables.product.product_name %}{% ifversion fpt or ghec%}.com{% endif %} Fixture Documentation'
featuredLinks:
gettingStarted:
- /get-started/quickstart/hello-world
- /get-started/start-your-journey/hello-world
- /rest
popular:
- /get-started

4
src/fixtures/fixtures/content/pages/quickstart.md
View File

@@ -8,7 +8,7 @@ versions:
ghae: '*'
ghec: '*'
type: quick_start
permissions: These are permissions details, for more pages info start at the beginning with this "[article intro link](#introduction)". Also here's [another link](/get-started/quickstart/hello-world).
permissions: These are permissions details, for more pages info start at the beginning with this "[article intro link](#introduction)". Also here's [another link](/get-started/start-your-journey/hello-world).
topics:
- Pages
shortTitle: Quickstart
@@ -21,7 +21,7 @@ This page has 6 links that should show preview popovers on hover.
## Regular internal link
But learn more on "[AUTOTITLE](/get-started/quickstart)."
But learn more on "[AUTOTITLE](/get-started/start-your-journey)."
## Internal links with formatted link text

2
src/fixtures/fixtures/data/reusables/gated-features/more-info.md
View File

@@ -1 +1 @@
{% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/quickstart/hello-world)."{% endif %}
{% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/hello-world)."{% endif %}

0
src/fixtures/fixtures/translations/ja-jp/content/get-started/quickstart/dynamic-title.md → src/fixtures/fixtures/translations/ja-jp/content/get-started/start-your-journey/dynamic-title.md
View File

2
src/fixtures/fixtures/translations/ja-jp/content/get-started/quickstart/hello-world.md → src/fixtures/fixtures/translations/ja-jp/content/get-started/start-your-journey/hello-world.md
View File

@@ -16,7 +16,7 @@ is used, is wrong. The quotation is inside the square bracket! Naughty.
But this is a common occurrence in translations and we need to smartly
recover from it.
["AUTOTITLE](/get-started/quickstart/dynamic-title)"
["AUTOTITLE](/get-started/start-your-journey/dynamic-title)"
"[AUTOTITLE](/get-started/foo/cross-version-linking)"

2
src/fixtures/fixtures/translations/ja-jp/data/reusables/gated-features/more-info.md
View File

@@ -1 +1 @@
{% ifversion fpt or ghec %}詳細については, see ["AUTOTITLE](/get-started/quickstart/hello-world)."{% endif %}
{% ifversion fpt or ghec %}詳細については, see ["AUTOTITLE](/get-started/start-your-journey/hello-world)."{% endif %}

42
src/fixtures/playwright.config.ts
View File

@@ -1,4 +1,4 @@
import { defineConfig, devices } from '@playwright/test'
import { defineConfig } from '@playwright/test'
/**
* Read environment variables from file.
@@ -72,28 +72,28 @@ export default defineConfig({
/* Configure projects for major browsers */
projects: [
{
name: 'chromium',
use: {
...devices['Desktop Chrome'],
// need this wider width because of our slightly wider than normal xl
// breakpoint that helps prevent overlapping main content with the minitoc
viewport: {
width: 1400,
height: 720,
},
},
},
// {
// name: 'chromium',
// use: {
// ...devices['Desktop Chrome'],
// // need this wider width because of our slightly wider than normal xl
// // breakpoint that helps prevent overlapping main content with the minitoc
// viewport: {
// width: 1400,
// height: 720,
// },
// },
// },
{
name: 'firefox',
use: { ...devices['Desktop Firefox'] },
},
// {
// name: 'firefox',
// use: { ...devices['Desktop Firefox'] },
// },
{
name: 'webkit',
use: { ...devices['Desktop Safari'] },
},
// {
// name: 'webkit',
// use: { ...devices['Desktop Safari'] },
// },
/* Test against mobile viewports. */
// {

16
src/fixtures/tests/breadcrumbs.js
View File

@@ -2,7 +2,7 @@ import { getDOM } from '#src/tests/helpers/e2etest.js'
describe('breadcrumbs', () => {
test('links always prefixed with language', async () => {
const $ = await getDOM('/get-started/quickstart/hello-world')
const $ = await getDOM('/get-started/start-your-journey/hello-world')
const links = $('[data-testid=breadcrumbs-in-article] a')
links.each((i, element) => {
expect($(element).attr('href').startsWith('/en/')).toBe(true)
@@ -25,32 +25,34 @@ describe('breadcrumbs', () => {
})
test('article pages have breadcrumbs in article with product, category, maptopic, and article and last breadcrumb is not viewable', async () => {
const $ = await getDOM('/get-started/quickstart/hello-world')
const $ = await getDOM('/get-started/start-your-journey/hello-world')
const links = $('[data-testid=breadcrumbs-in-article] a')
expect(links.length).toBe(3)
expect($(links[0]).text()).toBe('Get started')
expect($(links[0]).attr('class').includes('d-none')).toBe(false)
expect($(links[1]).text()).toBe('Quickstart')
expect($(links[1]).text()).toBe('Start your journey')
expect($(links[1]).attr('class').includes('d-none')).toBe(false)
expect($(links[2]).text()).toBe('Hello World')
expect($(links[2]).attr('class').includes('d-none')).toBe(true)
})
test('works for enterprise-server articles too', async () => {
const $ = await getDOM('/enterprise-server@latest/get-started/quickstart/hello-world')
const $ = await getDOM('/enterprise-server@latest/get-started/start-your-journey/hello-world')
const links = $('[data-testid=breadcrumbs-in-article] a')
expect(links.length).toBe(3)
expect($(links[0]).text()).toBe('Get started')
expect($(links[1]).text()).toBe('Quickstart')
expect($(links[1]).text()).toBe('Start your journey')
expect($(links[2]).text()).toBe('Hello World')
})
test('works for titles that depend on Liquid', async () => {
const $fpt = await getDOM('/get-started/quickstart/dynamic-title')
const $fpt = await getDOM('/get-started/start-your-journey/dynamic-title')
const fptLinks = $fpt('[data-testid=breadcrumbs-in-article] a')
expect($fpt(fptLinks[2]).text()).toBe('Hello HubGit')
const $ghec = await getDOM('/enterprise-cloud@latest/get-started/quickstart/dynamic-title')
const $ghec = await getDOM(
'/enterprise-cloud@latest/get-started/start-your-journey/dynamic-title',
)
const ghecLinks = $ghec('[data-testid=breadcrumbs-in-article] a')
expect($ghec(ghecLinks[2]).text()).toBe('Greetings HubGit Enterprise Cloud')
})

8
src/fixtures/tests/categories-and-map-topic.js
View File

@@ -1,8 +1,8 @@
import { getDOM, head } from '#src/tests/helpers/e2etest.js'
describe('map topics', () => {
test('get-started/quickstart map-topic', async () => {
const $ = await getDOM('/get-started/quickstart')
test('get-started/start-your-journey map-topic', async () => {
const $ = await getDOM('/get-started/start-your-journey')
const lead = $('[data-search=lead]').text()
expect(lead).toMatch('Get started using HubGit to manage Git repositories')
@@ -10,7 +10,9 @@ describe('map topics', () => {
expect(links.length).toBeGreaterThan(0)
// They all have the same prefix
const hrefs = links.map((i, el) => $(el).attr('href')).get()
expect(hrefs.every((href) => href.startsWith('/en/get-started/quickstart/'))).toBeTruthy()
expect(
hrefs.every((href) => href.startsWith('/en/get-started/start-your-journey/')),
).toBeTruthy()
// The all resolve to a 200 OK without redirects
const responses = await Promise.all(hrefs.map((href) => head(href)))
expect(responses.every((r) => r.statusCode === 200)).toBeTruthy()

4
src/fixtures/tests/footer.js
View File

@@ -5,7 +5,7 @@ describe('footer', () => {
describe('"contact us" link', () => {
test('leads to support from articles', async () => {
const $ = await getDOM(
`/en/${nonEnterpriseDefaultVersion}/get-started/quickstart/hello-world`,
`/en/${nonEnterpriseDefaultVersion}/get-started/start-your-journey/hello-world`,
)
expect($('a#support').attr('href')).toBe('https://support.github.com')
})
@@ -36,7 +36,7 @@ describe('footer', () => {
describe('test redirects for non-product landing community links pages', () => {
test('leads to https://github.community/ when clicking on the community link', async () => {
const $ = await getDOM(`/en/get-started/quickstart/hello-world`)
const $ = await getDOM(`/en/get-started/start-your-journey/hello-world`)
expect($('a#ask-community').attr('href')).toBe(
'https://github.com/orgs/community/discussions',
)

14
src/fixtures/tests/internal-links.js
View File

@@ -7,7 +7,7 @@ describe('autotitle', () => {
const $ = await getDOM('/get-started/foo/autotitling')
const links = $('#article-contents a[href]')
links.each((i, element) => {
if ($(element).attr('href').includes('/get-started/quickstart/hello-world')) {
if ($(element).attr('href').includes('/get-started/start-your-journey/hello-world')) {
expect($(element).text()).toBe('Hello World')
}
})
@@ -48,14 +48,14 @@ describe('cross-version-links', () => {
const firstLink = links.filter(
(i, element) => $(element).text() === 'Hello world always in free-pro-team',
)
expect(firstLink.attr('href')).toBe('/en/get-started/quickstart/hello-world')
expect(firstLink.attr('href')).toBe('/en/get-started/start-your-journey/hello-world')
// Tests that the second link always goes to enterprise-server@X.Y
const secondLink = links.filter(
(i, element) => $(element).text() === 'Autotitling page always in enterprise-server latest',
)
expect(secondLink.attr('href')).toBe(
`/en/enterprise-server@${enterpriseServerReleases.latest}/get-started/quickstart/hello-world`,
`/en/enterprise-server@${enterpriseServerReleases.latest}/get-started/start-your-journey/hello-world`,
)
},
)
@@ -63,7 +63,7 @@ describe('cross-version-links', () => {
describe('link-rewriting', () => {
test('/en is injected', async () => {
const $ = await getDOM('/get-started/quickstart/link-rewriting')
const $ = await getDOM('/get-started/start-your-journey/link-rewriting')
const links = $('#article-contents a[href]')
{
@@ -92,7 +92,7 @@ describe('link-rewriting', () => {
})
test('/en and current version (latest) is injected', async () => {
const $ = await getDOM('/enterprise-cloud@latest/get-started/quickstart/link-rewriting')
const $ = await getDOM('/enterprise-cloud@latest/get-started/start-your-journey/link-rewriting')
const links = $('#article-contents a[href]')
const link = links.filter((i, element) => $(element).text() === 'Cross Version Linking')
@@ -101,7 +101,9 @@ describe('link-rewriting', () => {
test('/en and current version number is injected', async () => {
// enterprise-server, unlike enterprise-cloud, use numbers
const $ = await getDOM('/enterprise-server@latest/get-started/quickstart/link-rewriting')
const $ = await getDOM(
'/enterprise-server@latest/get-started/start-your-journey/link-rewriting',
)
const links = $('#article-contents a[href]')
const link = links.filter((i, element) => $(element).text() === 'Cross Version Linking')

8
src/fixtures/tests/page-titles.js
View File

@@ -8,20 +8,20 @@ describe('page titles', () => {
})
test('fpt article', async () => {
const $ = await getDOM('/get-started/quickstart/hello-world')
const $ = await getDOM('/get-started/start-your-journey/hello-world')
expect($('title').text()).toBe('Hello World - GitHub Docs')
})
test('ghes article', async () => {
const $ = await getDOM(`/enterprise-server@latest/get-started/quickstart/hello-world`)
const $ = await getDOM(`/enterprise-server@latest/get-started/start-your-journey/hello-world`)
expect($('title').text()).toBe(
`Hello World - GitHub Enterprise Server ${enterpriseServerReleases.latestStable} Docs`,
)
})
test('fpt map topic page', async () => {
const $ = await getDOM('/en/get-started/quickstart')
expect($('title').text()).toBe('Quickstart - GitHub Docs')
const $ = await getDOM('/en/get-started/start-your-journey')
expect($('title').text()).toBe('Start your journey - GitHub Docs')
})
test('fpt category page', async () => {

28
src/fixtures/tests/playwright-rendering.spec.ts
View File

@@ -43,9 +43,9 @@ test('use sidebar to go to Hello World page', async ({ page }) => {
await expect(page).toHaveTitle(/Getting started with HubGit/)
await page.getByTestId('product-sidebar').getByText('Quickstart').click()
await page.getByTestId('product-sidebar').getByText('Start your journey').click()
await page.getByTestId('product-sidebar').getByText('Hello World').click()
await expect(page).toHaveURL(/\/en\/get-started\/quickstart\/hello-world/)
await expect(page).toHaveURL(/\/en\/get-started\/start-your-journey\/hello-world/)
await expect(page).toHaveTitle(/Hello World - GitHub Docs/)
})
@@ -183,7 +183,10 @@ test.describe('hover cards', () => {
await page.goto('/pages/quickstart')
// hover over a link and check for intro content from hovercard
await page.locator('#article-contents').getByRole('link', { name: 'Quickstart' }).hover()
await page
.locator('#article-contents')
.getByRole('link', { name: 'Start your journey' })
.hover()
await expect(
page.getByText(
'Get started using HubGit to manage Git repositories and collaborate with others.',
@@ -241,7 +244,10 @@ test.describe('hover cards', () => {
await page.goto('/pages/quickstart')
// Simply putting focus on the link should not open the hovercard
await page.locator('#article-contents').getByRole('link', { name: 'Quickstart' }).focus()
await page
.locator('#article-contents')
.getByRole('link', { name: 'Start your journey' })
.focus()
await expect(
page.getByText(
'Get started using GitHub to manage Git repositories and collaborate with others.',
@@ -267,7 +273,7 @@ test.describe('hover cards', () => {
test('internal links get a aria-roledescription and aria-describedby', async ({ page }) => {
await page.goto('/pages/quickstart')
const link = page.locator('#article-contents').getByRole('link', { name: 'Quickstart' })
const link = page.locator('#article-contents').getByRole('link', { name: 'Start your journey' })
await expect(link).toHaveAttribute('aria-roledescription', 'hover card')
// The link gets a `aria-describedby="...ID..."` attribute that points to
@@ -560,10 +566,10 @@ test.describe('translations', () => {
})
test('switch to Japanese from English using widget on article', async ({ page }) => {
await page.goto('/get-started/quickstart/hello-world')
await page.goto('/get-started/start-your-journey/hello-world')
await page.getByRole('button', { name: 'Select language: current language is English' }).click()
await page.getByRole('menuitemradio', { name: '日本語' }).click()
await expect(page).toHaveURL('/ja/get-started/quickstart/hello-world')
await expect(page).toHaveURL('/ja/get-started/start-your-journey/hello-world')
await expect(page.getByRole('heading', { name: 'こんにちは World' })).toBeVisible()
// Having done this once, should now use a cookie to redirect
@@ -571,13 +577,13 @@ test.describe('translations', () => {
// Playwright will cache this redirect, so we need to add something
// to "cache bust" the URL
const cb = `?cb=${Math.random()}`
await page.goto('/get-started/quickstart/hello-world' + cb)
await expect(page).toHaveURL('/ja/get-started/quickstart/hello-world' + cb)
await page.goto('/get-started/start-your-journey/hello-world' + cb)
await expect(page).toHaveURL('/ja/get-started/start-your-journey/hello-world' + cb)
// If you go, with the Japanese cookie, to the English page directly,
// it will offer a link to the Japanese URL in a banner.
await page.goto('/en/get-started/quickstart/hello-world')
await page.goto('/en/get-started/start-your-journey/hello-world')
await page.getByRole('link', { name: 'Japanese' }).click()
await expect(page).toHaveURL('/ja/get-started/quickstart/hello-world')
await expect(page).toHaveURL('/ja/get-started/start-your-journey/hello-world')
})
})

2
src/fixtures/tests/sidebar.js
View File

@@ -14,7 +14,7 @@ describe('sidebar', () => {
})
test('leaf-node article marked as aria-current=page', async () => {
const $ = await getDOM('/get-started/quickstart/hello-world')
const $ = await getDOM('/get-started/start-your-journey/hello-world')
expect(
$(
'[data-testid=sidebar] [data-testid=product-sidebar] a[aria-current="page"] div span',

12
src/fixtures/tests/translations.js
View File

@@ -26,13 +26,13 @@ describe('translations', () => {
})
test('hello world', async () => {
const $ = await getDOM('/ja/get-started/quickstart/hello-world')
const $ = await getDOM('/ja/get-started/start-your-journey/hello-world')
const h1 = $('h1').text()
expect(h1).toBe('こんにちは World')
})
test('internal links get prefixed with /ja', async () => {
const $ = await getDOM('/ja/get-started/quickstart/link-rewriting')
const $ = await getDOM('/ja/get-started/start-your-journey/link-rewriting')
const links = $('#article-contents a[href]')
const jaLinks = links.filter((i, element) => $(element).attr('href').startsWith('/ja'))
const enLinks = links.filter((i, element) => $(element).attr('href').startsWith('/en'))
@@ -44,7 +44,7 @@ describe('translations', () => {
const $ = await getDOM('/ja/get-started/foo/autotitling')
const links = $('#article-contents a[href]')
links.each((i, element) => {
if ($(element).attr('href').includes('/ja/get-started/quickstart/hello-world')) {
if ($(element).attr('href').includes('/ja/get-started/start-your-journey/hello-world')) {
expect($(element).text()).toBe('こんにちは World')
}
})
@@ -82,17 +82,17 @@ describe('translations', () => {
})
test('automatic correction of bad AUTOTITLE in reusables', async () => {
const $ = await getDOM('/ja/get-started/quickstart/hello-world')
const $ = await getDOM('/ja/get-started/start-your-journey/hello-world')
const links = $('#article-contents a[href]')
const texts = links.map((i, element) => $(element).text()).get()
// That Japanese page uses AUTOTITLE links. Both in the main `.md` file
// but also inside a reusable.
// E.g. `["AUTOTITLE](/get-started/quickstart/hello-world)."`
// E.g. `["AUTOTITLE](/get-started/start-your-journey/hello-world)."`
// If we didn't do the necessary string corrections on translations'
// content and reusables what *would* remain is a HTML link that
// would look like this:
//
// <a href="/ja/get-started/quickstart/hello-world">&quot;AUTOTITLE</a>
// <a href="/ja/get-started/start-your-journey/hello-world">&quot;AUTOTITLE</a>
//
// This test makes sure no such string is left in any of the article
// content links.

2
src/frame/tests/site-tree.js
View File

@@ -26,7 +26,7 @@ describe('siteTree', () => {
test('object order and structure', () => {
expect(siteTree.en[nonEnterpriseDefaultVersion].childPages[1].href).toBe('/en/get-started')
expect(siteTree.en[nonEnterpriseDefaultVersion].childPages[1].childPages[0].href).toBe(
'/en/get-started/quickstart',
'/en/get-started/start-your-journey',
)
})

4
src/landings/tests/featured-links.js
View File

@@ -7,7 +7,7 @@ describe('featuredLinks', () => {
jest.setTimeout(60 * 1000)
test('non-TOC pages do not have intro links', async () => {
const $ = await getDOM('/en/get-started/quickstart')
const $ = await getDOM('/en/get-started/start-your-journey')
expect($('[data-testid=article-list]')).toHaveLength(0)
})
@@ -15,7 +15,7 @@ describe('featuredLinks', () => {
const $ = await getDOM('/en')
const $featuredLinks = $('[data-testid=article-list] a')
expect($featuredLinks).toHaveLength(6)
expect($featuredLinks.eq(0).attr('href')).toBe('/en/get-started/quickstart/hello-world')
expect($featuredLinks.eq(0).attr('href')).toBe('/en/get-started/start-your-journey/hello-world')
expect($featuredLinks.eq(0).children('h3').text()).toMatch('Hello World')
expect($featuredLinks.eq(0).children('p').text()).toMatch('Follow this Hello World exercise')
})

10
src/pageinfo/tests/pageinfo.js
View File

@@ -31,11 +31,11 @@ describe('pageinfo api', () => {
})
test('happy path', async () => {
const res = await get(makeURL('/en/get-started/quickstart'))
const res = await get(makeURL('/en/get-started/start-your-journey'))
expect(res.statusCode).toBe(200)
const { info } = JSON.parse(res.body)
expect(info.product).toBe('Get started')
expect(info.title).toBe('Quickstart')
expect(info.title).toBe('Start your journey')
expect(info.intro).toBe(
'Get started using HubGit to manage Git repositories and collaborate with others.',
)
@@ -204,7 +204,7 @@ describe('pageinfo api', () => {
describe('translations', () => {
test('Japanese page', async () => {
const res = await get(makeURL('/ja/get-started/quickstart/hello-world'))
const res = await get(makeURL('/ja/get-started/start-your-journey/hello-world'))
expect(res.statusCode).toBe(200)
const { info } = JSON.parse(res.body)
expect(info.product).toBe('はじめに')
@@ -213,11 +213,11 @@ describe('pageinfo api', () => {
})
test('falls back to English if translation is not present', async () => {
const enRes = await get(makeURL('/en/get-started/quickstart'))
const enRes = await get(makeURL('/en/get-started/start-your-journey'))
expect(enRes.statusCode).toBe(200)
// This page doesn't have a Japanese translation. I.e. it doesn't
// even exist on disk. So it'll fall back to English.
const translationRes = await get(makeURL('/ja/get-started/quickstart'))
const translationRes = await get(makeURL('/ja/get-started/start-your-journey'))
expect(translationRes.statusCode).toBe(200)
const en = JSON.parse(enRes.body)
const translation = JSON.parse(translationRes.body)

6
src/workflows/test-local-dev.js
View File

@@ -56,12 +56,12 @@ async function main() {
async function testEditingPage() {
const string = `Today's date is ${new Date().toString()}`
const filePath = 'content/get-started/quickstart/hello-world.md'
const filePath = 'content/get-started/start-your-journey/hello-world.md'
const content = fs.readFileSync(filePath, 'utf-8')
try {
fs.appendFileSync(filePath, string, 'utf-8')
const res = await get('/get-started/quickstart/hello-world')
const res = await get('/get-started/start-your-journey/hello-world')
if (!res.body.includes(string)) {
throw new Error(`Couldn't find the string '${string}' in the response body`)
}
@@ -73,7 +73,7 @@ async function testEditingPage() {
async function testJSONParameters() {
// currentVersion should be free-pro-team@latest
{
const res = await get('/get-started/quickstart/hello-world?json=currentVersion')
const res = await get('/get-started/start-your-journey/hello-world?json=currentVersion')
const info = JSON.parse(res.body)
assert(info === 'free-pro-team@latest')
}