Skip to content

Commit e0a5893

Browse files
authored
Merge pull request #36043 from github/repo-sync
Repo sync
2 parents d9c9696 + 3e978c1 commit e0a5893

File tree

34 files changed

+127
-99
lines changed

34 files changed

+127
-99
lines changed

.github/workflows/code-changes-comment.yml .github/workflows/comment-code-changes.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ on:
1313
# this applies to any non-content files, this workflow will run for all changed files unless it's ONLY these content-related changes
1414
paths-ignore:
1515
- 'content/**'
16-
- 'data/reusables/**'
16+
- 'data/**'
1717
- 'assets/images/**'
1818

1919
permissions:

.github/workflows/content-changes-table-comment.yml .github/workflows/comment-content-changes-table.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ on:
2727
- synchronize
2828
paths:
2929
- 'content/**'
30-
- 'data/reusables/**'
30+
- 'data/**'
3131
- 'assets/images/**'
3232

3333
permissions:
@@ -102,5 +102,5 @@ jobs:
102102
103103
---
104104
Key: **fpt**: Free, Pro, Team; **ghec**: GitHub Enterprise Cloud; **ghes**: GitHub Enterprise Server
105-
_This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/content-changes-table-comment.yml) workflow._
105+
_This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/comment-content-changes-table.yml) workflow._
106106
edit-mode: replace

.github/workflows/headless-tests.yml

+3
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ jobs:
5151
- name: Index fixtures into the local Elasticsearch
5252
run: npm run index-test-fixtures
5353

54+
- name: Install headless browser
55+
run: npx playwright install --no-shell
56+
5457
- name: Run Playwright tests
5558
env:
5659
PLAYWRIGHT_WORKERS: ${{ fromJSON('[1, 4]')[github.repository == 'github/docs-internal'] }}

.github/workflows/local-dev.yml

+3
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ jobs:
3434
- name: Disable Next.js telemetry
3535
run: npx next telemetry disable
3636

37+
- name: Install headless browser
38+
run: npx playwright install --no-shell
39+
3740
# The Playwright test, with the env vars we set here, takes care of
3841
# starting a server and shutting it down when it's done.
3942
# That's why it's important this step comes before the `npm start &`

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md

+29-32
Original file line numberDiff line numberDiff line change
@@ -24,76 +24,73 @@ Navigate to your [profile settings](https://github.com/settings/profile) to upda
2424
2525
## Step 2: Create a profile README
2626

27-
Compared to your bio, your profile README is flexible and allows for more creativity. You can write more in your profile README to showcase your skills and interests.
27+
Compared to your bio, your profile README is more flexible, allowing for more creativity. You can write more in your profile README to showcase your skills and interests.
2828

2929
Things you may want to add to your profile README include:
3030

3131
* **An introduction**: Write a brief introduction of yourself and your professional background.
32-
* **Skills and experience**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in.
33-
* **Your professional experience**: Describe where you've worked before and what sort of professional skills you've built. These can even be non-technical skills, such as communication and empathy.
32+
* **Skills**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in.
33+
* **Professional experience**: Describe where you've worked before and what sort of professional skills you've built. These can even be non-technical skills, such as communication and empathy.
3434
* **Some of your best projects**: Describe some projects you're proud of. You'll also pin these repositories later, but your README gives you a chance to provide more commentary.
3535
* **Achievements or awards**: Show off any of your achievements, including certifications or awards you've received for your work.
3636

37-
For instructions for creating a profile README, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme).
37+
To create your profile README, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme).
3838

3939
> [!NOTE] Updating and customizing your profile README also helps demonstrate fluency using Markdown and HTML, which are useful skills for technical jobs. To show off your skills for potential employers, look for ways to use more advanced Markdown or HTML elements in your profile README.
4040
4141
## Step 3: Showcase your best projects
4242

43-
Pick your favorite 3-5 projects to highlight for your job application. For the best chances at an interview, pick projects that show your diverse skills and are relevant to your specific job search.
43+
Pick 3-5 projects to highlight by "pinning" them on your profile. Repositories you pin will be prominently displayed, allowing you to direct hiring managers' attention to the projects you're most proud of.
4444

45-
These can be projects you created or projects that you contributed to:
45+
For the best chances at an interview, pick projects that show your diverse skills and are relevant to your specific job search.
4646

47-
* Projects you own are fully under your control, so you can prepare the project using the rest of the steps below.
48-
* Open source projects highlight your ability to collaborate with others.
49-
50-
To take advantage of both, pin some of each to your profile.
47+
If possible, pin some projects you created and some that you contributed to:
5148

52-
Repositories you pin will be prominently displayed on your profile, allowing you to direct hiring managers' attention to the projects you're most proud of.
49+
* Projects you own are fully under your control, so you can improve them using of the steps below.
50+
* Open source projects highlight your ability to collaborate with others.
5351

54-
To get started, click **Customize your pins** in the "Popular repositories" section of your profile.
52+
To pin the repositories, click **Customize your pins** in the "Popular repositories" section of your profile.
5553

5654
## Step 4: Improve your showcased projects
5755

5856
Hiring managers usually consider many applicants for each role. Expect that they will only look at your projects for a couple minutes. To give the best impression during this brief time, you should make your projects easy to understand and explore.
5957

60-
Below, you'll find some practical suggestions for preparing your showcase projects, as well as some tips on using {% data variables.product.prodname_copilot_short %} to help.
58+
### Write a helpful README
6159

62-
> [!NOTE] Always verify the answers that {% data variables.product.prodname_copilot_short %} provides.
60+
The README for your project's repository is a perfect space to give a concise project overview. Use [{% data variables.product.prodname_copilot_chat_short %}](https://github.com/copilot) to help write your README, with a prompt like this:
6361

64-
### Update the repository details
62+
>Write a README for my lottery-number-generator repository.
6563
66-
On the main page of the repository, to the right of "About," click {% octicon "gear" aria-label="Edit repository metadata" %}. Here, you can provide information that helps hiring managers quickly understand the project:
67-
* A brief description of your project
68-
* A website where you can see the project in action
69-
* Topic tags that categorize your project
64+
Then, copy the response into a `README.md` file in the root of the repository, editing as needed. Helpful READMEs include:
7065

71-
### Write a helpful README
72-
73-
The README for your project's repository is a perfect space to give a concise project overview. Helpful project README details include:
7466
* A list of key features of the project
7567
* Details on how to set up and run the project
7668
* An example or demo of the project
7769
* Instructions on testing your code
7870

79-
You can use [Copilot Chat](https://github.com/copilot) to help write your README. Use a prompt like this:
80-
>Write a README for my `lottery-number-generator` repository.
71+
### Update the repository details
72+
73+
On the main page of the repository, to the right of "About," click {% octicon "gear" aria-label="Edit repository metadata" %}. Here, you can provide information that helps hiring managers quickly understand the project:
74+
* A brief description of your project
75+
* A website where you can see the project in action
76+
* Topic tags that categorize your project
8177

8278
### Make the code easy to understand
8379

84-
To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. In general, a few best practices can help give any readers an understanding of your project and how you work with code:
80+
To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. Follow these best practices:
8581

86-
* Maintain a consistent coding style with descriptive file and directory names throughout the project
87-
* Use helpful comments and documentation for any complex or important snippets
88-
* Refine your code according to popular style guides
89-
* Simplify complex functions, break down large classes, and remove redundant code
90-
* Provide tests to validate that your code is working as expected
82+
* Maintain a **consistent coding style** throughout the project
83+
* Use **descriptive** file and directory names
84+
* Use helpful **comments and documentation** for any complex or important snippets
85+
* Refine your code according to popular **style guides**
86+
* **Simplify** complex functions, break down large classes, and remove redundant code
87+
* Provide **tests** to validate that your code is working as expected
9188

92-
It might be easiest to make these changes locally in {% data variables.product.prodname_vscode_shortname %}, using the {% data variables.product.prodname_copilot_extension_vsc %}. For example, when you start typing a line comment, {% data variables.product.prodname_copilot_short %} can automatically suggest the rest of the comment.
89+
It's easiest to make these changes in {% data variables.product.prodname_vscode_shortname %} with {% data variables.product.prodname_copilot_short %}. For example, when you start typing a line comment, {% data variables.product.prodname_copilot_short %} can automatically suggest the rest of the comment. To get started, see [Set up Visual Studio Code with Copilot](https://code.visualstudio.com/docs/copilot/setup-simplified) in the Visual Studio Code documentation.
9390

9491
### Update your project's dependencies
9592

96-
To showcase your understanding of security best practices, ensure your project is using the latest versions of any dependencies. {% data variables.product.prodname_dependabot %} can alert you to security vulnerabilities in your dependencies and generate pull requests that will update your project to the latest version. See [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide).
93+
To showcase your understanding of security best practices, ensure your project is using the **latest versions** of any dependencies. You can automate this process with {% data variables.product.prodname_dependabot %}, which generates pull requests that update your project to the latest version. See [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide).
9794

9895
## Extra credit: Maintaining your projects
9996

content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Configuring self-hosted runners is only one step in the middle of the process fo
3131

3232
{% data reusables.dependabot.dependabot-runners-system-requirements %}
3333

34+
{% data reusables.dependabot.vnet-arc-note %}
35+
3436
### Network requirements for {% data variables.product.prodname_dependabot %} runners
3537

3638
{% data reusables.dependabot.dependabot-runners-network-requirements %}

content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md

+3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ If you are transitioning to using {% data variables.product.prodname_dependabot
3939

4040
{% data reusables.dependabot.dependabot-on-actions-enterprise-policy-condition %}
4141

42+
> [!NOTE]
43+
> {% data variables.product.prodname_dependabot %} on {% data variables.product.prodname_actions %} relies on the `ubuntu-latest` label to select the appropriate runner. To ensure {% data variables.product.prodname_dependabot %} runs on {% data variables.product.github %}-hosted runners, you should not use the label `ubuntu-latest` for self-hosted runners.
44+
4245
## Enabling or disabling {% data variables.product.prodname_dependabot %} on {% data variables.product.github %}-hosted runners
4346

4447
This section only applies to standard {% data variables.product.github %}-hosted runners, not larger runners.

content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ topics:
2222

2323
{% data variables.product.prodname_copilot_free_short %} includes the following features:
2424

25-
* Code completion in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDES, Vim/Neovim, Xcode, and Azure Data Studio
25+
* Code completion in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Vim/Neovim, Xcode, and Azure Data Studio
2626
* {% data variables.product.prodname_copilot_edits_vscode_short %} to make changes across multiple files (**only in {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_vs %}**)
27-
* {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDES, and {% data variables.product.prodname_dotcom_the_website %}
27+
* {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, and {% data variables.product.prodname_dotcom_the_website %}
2828
* Block suggestions matching public code
2929
* Access to {% data variables.copilot.copilot_claude_sonnet %} models
30+
* Access to {% data variables.product.prodname_copilot_extensions_short %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, {% data variables.product.prodname_dotcom_the_website %}, and {% data variables.product.prodname_mobile %}
3031

3132
## What are the limitations of {% data variables.product.prodname_copilot_free_short %}?
3233

content/github-cli/github-cli/using-github-cli-extensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ topics:
1212
## About {% data variables.product.prodname_cli %} extensions
1313

1414
> [!NOTE]
15-
> Extensions outside of {% data variables.product.product_name %} and {% data variables.product.prodname_cli %} are not certified by {% data variables.product.product_name %} and are governed by separate terms of service, privacy policy, and support documentation. To mitigate risk when using third-party extensions, audit the source code of the extension before installing or updating the extension.
15+
> Extensions outside of {% data variables.product.github %} and {% data variables.product.prodname_cli %} are not certified by {% data variables.product.github %} and are governed by separate terms of service, privacy policy, and support documentation. To mitigate risk when using third-party extensions, audit the source code of the extension before installing or updating the extension.
1616
1717
{% data reusables.cli.cli-extensions %} For more information about how to create {% data variables.product.prodname_cli %} extensions, see [AUTOTITLE](/github-cli/github-cli/creating-github-cli-extensions).
1818

content/graphql/guides/migrating-graphql-global-node-ids.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ shortTitle: Migrating global node IDs
1111

1212
## Background
1313

14-
The {% data variables.product.product_name %} GraphQL API currently supports two types of global node ID formats. The legacy format will be {% data variables.release-phases.closing_down %} and replaced with a new format. This guide shows you how to migrate to the new format, if necessary.
14+
The {% data variables.product.github %} GraphQL API currently supports two types of global node ID formats. The legacy format will be {% data variables.release-phases.closing_down %} and replaced with a new format. This guide shows you how to migrate to the new format, if necessary.
1515

1616
By migrating to the new format, you ensure that the response times of your requests remain consistent and small. You also ensure that your application continues to work once the legacy IDs are {% data variables.release-phases.closing_down %}.
1717

content/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ These two examples show how to calculate the total nodes in a call.
133133

134134
{% ifversion ghes %}
135135

136-
Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance.
136+
Rate limits are disabled by default for {% data variables.product.prodname_ghe_server %}. Contact your site administrator to confirm the rate limits for your instance.
137137

138138
If you are a site administrator, you can set rate limits for your instance. For more information, see [AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-rate-limits).
139139

content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'About {% data variables.product.prodname_projects_v1 %}'
3-
intro: '{% data variables.product.prodname_projects_v1_caps %} on {% data variables.product.product_name %} help you organize and prioritize your work. {% ifversion projects-v1-can-create %} You can create {% data variables.projects.projects_v1_boards %} for specific feature work, comprehensive roadmaps, or even release checklists. With {% data variables.product.prodname_projects_v1 %}, you have the flexibility to create customized workflows that suit your needs.{% endif %}'
3+
intro: '{% data variables.product.prodname_projects_v1_caps %} on {% data variables.product.github %} help you organize and prioritize your work. {% ifversion projects-v1-can-create %} You can create {% data variables.projects.projects_v1_boards %} for specific feature work, comprehensive roadmaps, or even release checklists. With {% data variables.product.prodname_projects_v1 %}, you have the flexibility to create customized workflows that suit your needs.{% endif %}'
44
redirect_from:
55
- /github/managing-your-work-on-github/managing-project-boards/about-project-boards
66
- /articles/about-projects

content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You can add issue or pull request cards to your {% data variables.projects.proje
2323
You can put a maximum of 2,500 cards into each project column. If a column has reached the maximum number of cards, no cards can be moved into that column.
2424

2525
> [!NOTE]
26-
> You can also add notes to your {% data variables.projects.projects_v1_board %} to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_name %}, or to add related information to your {% data variables.projects.projects_v1_board %}. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board).
26+
> You can also add notes to your {% data variables.projects.projects_v1_board %} to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.github %}, or to add related information to your {% data variables.projects.projects_v1_board %}. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board).
2727
2828
{% data reusables.project-management.edit-in-project %}
2929

content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The auto-add workflow supports a subset of filters. You can use the following fi
2828
| `is` | open, closed, merged, draft, issue, pr
2929
| `label` | "label name"
3030
| `reason` | completed, reopened, "not planned"
31-
| `assignee` | {% data variables.product.product_name %} username
31+
| `assignee` | {% data variables.product.github %} username
3232
| `no` | label, assignee, reason
3333

3434
All filters, other than `no`, support negation. For example, you could use `-label:bug` to add issues that do not have the "bug" label.

0 commit comments

Comments
 (0)