Skip to content

Commit 3e0e976

Browse files
authored
Merge pull request github#36485 from github/repo-sync
Repo sync
2 parents 1e096d7 + 4c1dd8c commit 3e0e976

File tree

152 files changed

+562
-250
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+562
-250
lines changed
Loading
Loading
Loading
Loading

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

+1-10
Original file line numberDiff line numberDiff line change
@@ -94,18 +94,9 @@ You can automate this process with {% data variables.product.prodname_dependabot
9494

9595
## Step 5: Share your results
9696

97-
Share your updated profile and get inspiration from others in our [Community discussion](https://github.com/orgs/community/discussions/150827).
98-
99-
## Extra credit: Maintaining your projects
100-
10197
Your profile is now ready to be included on your resume! The changes you made today will have a big impact on your job search and will make your {% data variables.product.github %} profile stand out to hiring managers.
10298

103-
If you want to improve your profile even more, incorporate these practices into your coding routines:
104-
105-
* **Maintain a clean commit history**. To make your project history understandable, use descriptive commit messages and work in smaller batches.
106-
* **Use issues, pull requests, and {% data variables.product.prodname_projects_v2 %}**. Showcase your task management and project planning skills by tracking bugs and feature requests with issues and using {% data variables.product.prodname_projects_v2 %} to organize them.
107-
* **Keep dependencies updated**. Use {% data variables.product.prodname_dependabot_version_updates %} to automatically update your project's dependencies with the latest security features and bug fixes.
108-
* **Contribute to open source**. Open source contributions showcase your collaboration skills and prove that you can work in complex code bases. For more information, see [AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github).
99+
Share your updated profile and get inspiration from others in our [Community discussion](https://github.com/orgs/community/discussions/150827).
109100

110101
## Further reading
111102

content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
title: Using the CodeQL model editor
33
shortTitle: CodeQL model editor
44
versions:
5-
feature: 'codeql-model-packs'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
topics:
79
- Advanced Security
810
- Code scanning

content/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: About Dependabot auto-triage rules
33
intro: '{% data variables.dependabot.auto_triage_rules %} are a powerful tool to help you better manage your security alerts at scale. {% data variables.dependabot.github_presets %} are rules curated by {% data variables.product.company_short %} that you can use to filter out a substantial amount of false positives. {% data variables.dependabot.custom_rules_caps %} provide control over which alerts are ignored, snoozed, or trigger a {% data variables.product.prodname_dependabot %} security update to resolve the alert.'
44
product: '{% data reusables.gated-features.dependabot-auto-triage-rules %}'
55
versions:
6-
feature: dependabot-auto-triage-rules
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
type: overview
810
topics:
911
- Dependabot

content/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Customizing auto-triage rules to prioritize Dependabot alerts
33
intro: 'You can create your own {% data variables.dependabot.auto_triage_rules_short %} to control which alerts are dismissed or snoozed, and which alerts you want {% data variables.product.prodname_dependabot %} to open pull requests for.'
44
permissions: '{% data reusables.permissions.dependabot-auto-triage-rules %}'
55
versions:
6-
feature: dependabot-auto-triage-rules
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
type: how_to
810
topics:
911
- Dependabot

content/code-security/dependabot/dependabot-auto-triage-rules/managing-automatically-dismissed-alerts.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ intro: 'You can filter to see which alerts have been auto-dismissed by a rule, a
44
allowTitleToDifferFromFilename: true
55
permissions: '{% data reusables.permissions.dependabot-auto-triage-rules %}'
66
versions:
7-
feature: dependabot-auto-triage-rules
7+
fpt: '*'
8+
ghec: '*'
9+
ghes: '*'
810
type: how_to
911
topics:
1012
- Dependabot

content/code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Using GitHub preset rules to prioritize Dependabot alerts
33
intro: 'You can use {% data variables.dependabot.github_presets %}, which are rules curated by {% data variables.product.company_short %}, to auto-dismiss low impact development alerts for npm dependencies.'
44
permissions: '{% data reusables.permissions.dependabot-github-presets %}'
55
versions:
6-
feature: dependabot-auto-triage-rules
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
type: how_to
810
topics:
911
- Dependabot

content/code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ intro: 'Learn how to streamline and efficiently manage your {% data variables.pr
44
allowTitleToDifferFromFilename: true
55
permissions: '{% data reusables.permissions.dependabot-yml-configure %}'
66
versions:
7-
feature: dependabot-version-updates-groups
7+
fpt: '*'
8+
ghec: '*'
9+
ghes: '*'
810
type: how_to
911
topics:
1012
- Dependabot

content/code-security/dependabot/troubleshooting-dependabot/viewing-dependabot-job-logs.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ intro: 'To support debugging of {% data variables.product.prodname_dependabot %}
44
shortTitle: Viewing Dependabot logs
55
permissions: '{% data reusables.permissions.dependabot-various-tasks %}'
66
versions:
7-
feature: dependabot-job-log
7+
fpt: '*'
8+
ghec: '*'
9+
ghes: '*'
810
type: how_to
911
topics:
1012
- Dependabot

content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md

+3
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,9 @@ Package manager | YAML value | Supported versions |
374374
| Dev containers | `devcontainers` | Not applicable |
375375
| {% endif %} |
376376
| Docker | `docker` | v1 |
377+
| {% ifversion dependabot-docker-compose-support %} |
378+
| Docker Compose | `docker-compose` | v2, v3 |
379+
| {% endif %} |
377380
| {% ifversion dependabot-dotnet-sdk %} |
378381
| .NET SDK | `dotnet-sdk` | >=.NET Core 3.1 |
379382
| {% endif %} |

content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ You'll find detailed guidance for the setup of the following package managers:
3232
* [Bun](#bun){% endif %}
3333
* [Bundler](#bundler){% ifversion dependabot-updates-cargo-private-registry-support %}
3434
* [Cargo](#cargo){% endif %}
35-
* [Docker](#docker)
35+
* [Docker](#docker){% ifversion dependabot-docker-compose-support %}
36+
* [Docker Compose](#docker-compose){% endif %}
3637
* [Gradle](#gradle)
3738
* [Maven](#maven)
3839
* [npm](#npm)
@@ -162,6 +163,14 @@ registries:
162163
* Dockerfiles do not receive updates to images specified with the `ARG` directive. There is a workaround available for the `COPY` directive. For more information, see [{% data variables.product.prodname_dependabot %} ignores image references in COPY Dockerfile statement](https://github.com/dependabot/dependabot-core/issues/5103#issuecomment-1692420920) in the `dependabot/dependabot-core` repository.
163164
* {% data variables.product.prodname_dependabot %} doesn't support multi-stage Docker builds. For more information, see [Support for Docker multi-stage builds](https://github.com/dependabot/dependabot-core/issues/7640) in the `dependabot/dependabot-core` repository.
164165

166+
{% ifversion dependabot-docker-compose-support %}
167+
168+
### Docker Compose
169+
170+
Docker Compose adheres to the same configuration guidelines as Docker. For more information, see [Docker](#docker).
171+
172+
{% endif %}
173+
165174
### Gradle
166175

167176
{% data variables.product.prodname_dependabot %} doesn't run Gradle but supports updates to certain Gradle files. For more information, see "Gradle" in [AUTOTITLE](/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories#gradle).

content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ In {% data variables.product.prodname_dependabot %} pull requests for grouped ve
9393
> [!TIP]
9494
> When you want to un-ignore a specific ignore condition, use the `@dependabot show DEPENDENCY_NAME ignore conditions` command to quickly check what ignore conditions a dependency currently has.
9595
96-
{% elsif dependabot-version-updates-groups %}
96+
{% else %}
9797

9898
### Managing {% data variables.product.prodname_dependabot %} pull requests for grouped version updates with comment commands
9999

content/code-security/supply-chain-security/understanding-your-software-supply-chain/enforcing-dependency-review-across-an-organization.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ intro: 'Dependency review lets you catch insecure dependencies before you introd
44
shortTitle: Enforce dependency review
55
permissions: '{% data reusables.permissions.security-org-enable %}'
66
versions:
7-
feature: repo-rules
7+
fpt: '*'
8+
ghec: '*'
9+
ghes: '*'
810
type: overview
911
topics:
1012
- Advanced Security

content/contributing/collaborating-on-github-docs/about-contributing-to-github-docs.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: About contributing to GitHub Docs
33
shortTitle: About contributing
4-
intro: 'You can contribute to GitHub Docs content in several ways.'
4+
intro: You can contribute to GitHub Docs content in several ways.
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
{% data variables.product.prodname_dotcom %} documentation is open source. Anyone can contribute to the docs in the public `docs` repository: https://github.com/github/docs. {% data variables.product.prodname_dotcom %} employees work on the documentation in a copy of this repository called `docs-internal`. The two repositories are automatically synced to keep them both up to date with changes merged into the `main` branch of either repository. For simplicity, we'll refer to "the documentation repository" in the articles about contributing to {% data variables.product.prodname_docs %}.

content/contributing/collaborating-on-github-docs/label-reference.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: Label reference
3-
intro: "Labels can help you find an issue you'd like to help with."
3+
intro: Labels can help you find an issue you'd like to help with.
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
You can use labels to locate a particular type of issue. For example, click the labels in the table to see a filtered list of open issues in the github/docs repository.

content/contributing/collaborating-on-github-docs/using-git-on-github-docs.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: Using Git on GitHub Docs
33
shortTitle: Using Git
4-
intro: 'You can use Git on the command line to commit changes and then push them to the documentation repository.'
4+
intro: You can use Git on the command line to commit changes and then push them to the documentation repository.
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
This article describes the process of creating a topic branch for the documentation repository, committing changes, and pushing your changes back up to the remote repository.

content/contributing/collaborating-on-github-docs/using-the-content-linter.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: Using the content linter
3-
intro: 'You can use content linter to check your contributions for errors.'
3+
intro: You can use content linter to check your contributions for errors.
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
## About the {% data variables.product.prodname_docs %} content linter

content/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: Using the TODOCS placeholder to leave notes
33
shortTitle: Using the TODOCS placeholder
4-
intro: 'You can use the `TODOCS` placeholder to indicate work that still needs to be completed.'
4+
intro: You can use the `TODOCS` placeholder to indicate work that still needs to be completed.
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
<!-- markdownlint-disable search-replace -->

content/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Creating a local environment
33
shortTitle: Create a local environment
44
intro: 'You can run the {% data variables.product.prodname_docs %} application locally on your computer.'
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
## About {% data variables.product.prodname_docs %} site structure

content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: Troubleshooting your environment
3-
intro: "Learn about troubleshooting problems in your local environment and the {% data variables.product.prodname_docs %} staging platform."
3+
intro: 'Learn about troubleshooting problems in your local environment and the {% data variables.product.prodname_docs %} staging platform.'
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
## Troubleshooting tests that fail locally but pass in CI

content/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Working on GitHub Docs in a codespace
33
shortTitle: Working in a codespace
44
intro: 'You can use {% data variables.product.prodname_github_codespaces %} to work on documentation for {% data variables.product.prodname_docs %}.'
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
## About {% data variables.product.prodname_github_codespaces %}

content/contributing/style-guide-and-content-model/about-combining-multiple-content-types.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: About combining multiple content types
33
shortTitle: Combining multiple types
4-
intro: 'You can combine multiple content types in a single article to help people complete complex tasks.'
4+
intro: You can combine multiple content types in a single article to help people complete complex tasks.
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
Often, it's helpful to group information in context to help people complete a complex task, understand a set of related tasks, or illustrate an entire workflow. Use longer articles combining content types to ensure people find contextual content in the right place. Longer articles also help eliminate duplication of content and prepare content to scale as more options are added to the product. People most often need longer articles while actively using the product, and they may need to consult the article at different points on their journey.

content/contributing/style-guide-and-content-model/about-the-content-model.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
title: About the content model
33
shortTitle: About the content model
4-
intro: 'The content model describes the structure and types of content that we publish.'
4+
intro: The content model describes the structure and types of content that we publish.
55
redirect_from:
66
- /contributing/writing-for-github-docs/content-model
77
versions:
8-
feature: 'contributing'
8+
fpt: '*'
9+
ghec: '*'
10+
ghes: '*'
911
---
1012

1113
Our content model explains the purpose of each type of content we create within {% data variables.product.prodname_docs %}, and what to include when you write or update an article. We use a content model to ensure that our content consistently, clearly, and comprehensively communicates the information that people need to achieve their goals with {% data variables.product.prodname_dotcom %}.

content/contributing/style-guide-and-content-model/about-topics.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: About topics
33
shortTitle: About topics
4-
intro: 'Use topics to make articles searchable.'
4+
intro: Use topics to make articles searchable.
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
An article can be defined as being relevant to one or more topics by having those topics listed in the article's frontmatter. For example:

content/contributing/style-guide-and-content-model/conceptual-content-type.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: Conceptual content type
3-
intro: 'People most often use conceptual content when they are learning about something new to them.'
3+
intro: People most often use conceptual content when they are learning about something new to them.
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
Conceptual content helps people understand a feature or topic by providing a clear, high-level overview, explanation of how the feature or topic can help them on their journey, and context like use cases or examples.

content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Contents of a GitHub Docs article
33
shortTitle: Contents of an article
44
intro: 'Every article includes a few standard elements, and may include conditional or optional elements. We also use a standard order for content within an article.'
55
versions:
6-
feature: 'contributing'
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
79
---
810

911
## About the structure of an article

content/contributing/style-guide-and-content-model/procedural-content-type.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: Procedural content type
3-
intro: 'Procedural content gives context on how a task fits into someone''s larger goal.'
3+
intro: Procedural content gives context on how a task fits into someone's larger goal.
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
Procedural content helps people complete a task from start to finish while they are using {% data variables.product.prodname_dotcom %}.

content/contributing/style-guide-and-content-model/quickstart-content-type.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: Quickstart content type
3-
intro: 'Quickstarts are best for people who want instructions quickly without lengthy explanations of how something works or why they would want to use it.'
3+
intro: Quickstarts are best for people who want instructions quickly without lengthy explanations of how something works or why they would want to use it.
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
Quickstarts enable people to quickly complete a discrete, focused task by illustrating a workflow with only essential steps, in about five minutes or 600 words. Quickstarts can be used for quickly getting set up with a new tool, or for quickly completing another task. For more complex tasks, use a tutorial.

content/contributing/style-guide-and-content-model/referential-content-type.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
title: Referential content type
3-
intro: 'Referential content provides detailed information that people need while they are actively using a feature.'
3+
intro: Referential content provides detailed information that people need while they are actively using a feature.
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
We create referential articles and referential sections within other articles.

content/contributing/style-guide-and-content-model/release-note-content-type.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
title: Release note content type
33
intro: 'Release notes enable readers to understand and prepare for the user-facing changes in each release of {% data variables.product.prodname_dotcom %}''s versioned enterprise products.'
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
Good release notes provide administrators the necessary information to plan system upgrades in environments that require change control, and support end users who want to understand and prepare to use new {% data variables.product.prodname_dotcom %} features and functionality.

content/contributing/style-guide-and-content-model/style-guide.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
title: Style guide
33
intro: 'Follow this guide to make sure {% data variables.product.company_short %}''s documentation stays consistent and follows clear patterns that our readers can understand.'
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
redirect_from:
79
- /contributing/writing-for-github-docs/style-guide
810
---

content/contributing/style-guide-and-content-model/troubleshooting-content-type.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
title: Troubleshooting content type
33
intro: 'Troubleshooting content includes built-in errors we expect people to encounter, common problems reported to support, and situations people might encounter while completing tasks.'
44
versions:
5-
feature: 'contributing'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
68
---
79

810
Use troubleshooting sections in guides or procedural articles to keep solutions close to procedures. Work with support and product managers to surface common errors and include them in the documentation.

0 commit comments

Comments
 (0)