Skip to content

Commit

Permalink
Merge pull request #36043 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jan 24, 2025
2 parents d9c9696 + 3e978c1 commit e0a5893
Show file tree
Hide file tree
Showing 34 changed files with 127 additions and 99 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
# this applies to any non-content files, this workflow will run for all changed files unless it's ONLY these content-related changes
paths-ignore:
- 'content/**'
- 'data/reusables/**'
- 'data/**'
- 'assets/images/**'

permissions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ on:
- synchronize
paths:
- 'content/**'
- 'data/reusables/**'
- 'data/**'
- 'assets/images/**'

permissions:
Expand Down Expand Up @@ -102,5 +102,5 @@ jobs:
---
Key: **fpt**: Free, Pro, Team; **ghec**: GitHub Enterprise Cloud; **ghes**: GitHub Enterprise Server
_This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/content-changes-table-comment.yml) workflow._
_This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/comment-content-changes-table.yml) workflow._
edit-mode: replace
3 changes: 3 additions & 0 deletions .github/workflows/headless-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ jobs:
- name: Index fixtures into the local Elasticsearch
run: npm run index-test-fixtures

- name: Install headless browser
run: npx playwright install --no-shell

- name: Run Playwright tests
env:
PLAYWRIGHT_WORKERS: ${{ fromJSON('[1, 4]')[github.repository == 'github/docs-internal'] }}
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/local-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ jobs:
- name: Disable Next.js telemetry
run: npx next telemetry disable

- name: Install headless browser
run: npx playwright install --no-shell

# The Playwright test, with the env vars we set here, takes care of
# starting a server and shutting it down when it's done.
# That's why it's important this step comes before the `npm start &`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,76 +24,73 @@ Navigate to your [profile settings](https://github.com/settings/profile) to upda
## Step 2: Create a profile README

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.
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.

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

* **An introduction**: Write a brief introduction of yourself and your professional background.
* **Skills and experience**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in.
* **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.
* **Skills**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in.
* **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.
* **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.
* **Achievements or awards**: Show off any of your achievements, including certifications or awards you've received for your work.

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).
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).

> [!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.
## Step 3: Showcase your best projects

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.
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.

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

* Projects you own are fully under your control, so you can prepare the project using the rest of the steps below.
* Open source projects highlight your ability to collaborate with others.

To take advantage of both, pin some of each to your profile.
If possible, pin some projects you created and some that you contributed to:

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.
* Projects you own are fully under your control, so you can improve them using of the steps below.
* Open source projects highlight your ability to collaborate with others.

To get started, click **Customize your pins** in the "Popular repositories" section of your profile.
To pin the repositories, click **Customize your pins** in the "Popular repositories" section of your profile.

## Step 4: Improve your showcased projects

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.

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.
### Write a helpful README

> [!NOTE] Always verify the answers that {% data variables.product.prodname_copilot_short %} provides.
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:

### Update the repository details
>Write a README for my lottery-number-generator repository.
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:
* A brief description of your project
* A website where you can see the project in action
* Topic tags that categorize your project
Then, copy the response into a `README.md` file in the root of the repository, editing as needed. Helpful READMEs include:

### Write a helpful README

The README for your project's repository is a perfect space to give a concise project overview. Helpful project README details include:
* A list of key features of the project
* Details on how to set up and run the project
* An example or demo of the project
* Instructions on testing your code

You can use [Copilot Chat](https://github.com/copilot) to help write your README. Use a prompt like this:
>Write a README for my `lottery-number-generator` repository.
### Update the repository details

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:
* A brief description of your project
* A website where you can see the project in action
* Topic tags that categorize your project

### Make the code easy to understand

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:
To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. Follow these best practices:

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

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.
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.

### Update your project's dependencies

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).
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).

## Extra credit: Maintaining your projects

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Configuring self-hosted runners is only one step in the middle of the process fo

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

{% data reusables.dependabot.vnet-arc-note %}

### Network requirements for {% data variables.product.prodname_dependabot %} runners

{% data reusables.dependabot.dependabot-runners-network-requirements %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ If you are transitioning to using {% data variables.product.prodname_dependabot

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

> [!NOTE]
> {% 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.
## Enabling or disabling {% data variables.product.prodname_dependabot %} on {% data variables.product.github %}-hosted runners

This section only applies to standard {% data variables.product.github %}-hosted runners, not larger runners.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ topics:

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

* Code completion in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDES, Vim/Neovim, Xcode, and Azure Data Studio
* Code completion in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Vim/Neovim, Xcode, and Azure Data Studio
* {% 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 %}**)
* {% 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 %}
* {% 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 %}
* Block suggestions matching public code
* Access to {% data variables.copilot.copilot_claude_sonnet %} models
* 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 %}

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ topics:
## About {% data variables.product.prodname_cli %} extensions

> [!NOTE]
> 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.
> 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.
{% 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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ shortTitle: Migrating global node IDs

## Background

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.
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.

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 %}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ These two examples show how to calculate the total nodes in a call.

{% ifversion ghes %}

Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance.
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.

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).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'About {% data variables.product.prodname_projects_v1 %}'
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 %}'
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 %}'
redirect_from:
- /github/managing-your-work-on-github/managing-project-boards/about-project-boards
- /articles/about-projects
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can add issue or pull request cards to your {% data variables.projects.proje
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.

> [!NOTE]
> 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).
> 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).
{% data reusables.project-management.edit-in-project %}

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

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

0 comments on commit e0a5893

Please sign in to comment.