Skip to content

Commit

Permalink
Merge pull request #36485 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Feb 25, 2025
2 parents 1e096d7 + 4c1dd8c commit 3e0e976
Show file tree
Hide file tree
Showing 152 changed files with 562 additions and 250 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -94,18 +94,9 @@ You can automate this process with {% data variables.product.prodname_dependabot

## Step 5: Share your results

Share your updated profile and get inspiration from others in our [Community discussion](https://github.com/orgs/community/discussions/150827).

## Extra credit: Maintaining your projects

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.

If you want to improve your profile even more, incorporate these practices into your coding routines:

* **Maintain a clean commit history**. To make your project history understandable, use descriptive commit messages and work in smaller batches.
* **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.
* **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.
* **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).
Share your updated profile and get inspiration from others in our [Community discussion](https://github.com/orgs/community/discussions/150827).

## Further reading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Using the CodeQL model editor
shortTitle: CodeQL model editor
versions:
feature: 'codeql-model-packs'
fpt: '*'
ghec: '*'
ghes: '*'
topics:
- Advanced Security
- Code scanning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: About Dependabot auto-triage rules
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.'
product: '{% data reusables.gated-features.dependabot-auto-triage-rules %}'
versions:
feature: dependabot-auto-triage-rules
fpt: '*'
ghec: '*'
ghes: '*'
type: overview
topics:
- Dependabot
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Customizing auto-triage rules to prioritize Dependabot alerts
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.'
permissions: '{% data reusables.permissions.dependabot-auto-triage-rules %}'
versions:
feature: dependabot-auto-triage-rules
fpt: '*'
ghec: '*'
ghes: '*'
type: how_to
topics:
- Dependabot
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ intro: 'You can filter to see which alerts have been auto-dismissed by a rule, a
allowTitleToDifferFromFilename: true
permissions: '{% data reusables.permissions.dependabot-auto-triage-rules %}'
versions:
feature: dependabot-auto-triage-rules
fpt: '*'
ghec: '*'
ghes: '*'
type: how_to
topics:
- Dependabot
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Using GitHub preset rules to prioritize Dependabot alerts
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.'
permissions: '{% data reusables.permissions.dependabot-github-presets %}'
versions:
feature: dependabot-auto-triage-rules
fpt: '*'
ghec: '*'
ghes: '*'
type: how_to
topics:
- Dependabot
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ intro: 'Learn how to streamline and efficiently manage your {% data variables.pr
allowTitleToDifferFromFilename: true
permissions: '{% data reusables.permissions.dependabot-yml-configure %}'
versions:
feature: dependabot-version-updates-groups
fpt: '*'
ghec: '*'
ghes: '*'
type: how_to
topics:
- Dependabot
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ intro: 'To support debugging of {% data variables.product.prodname_dependabot %}
shortTitle: Viewing Dependabot logs
permissions: '{% data reusables.permissions.dependabot-various-tasks %}'
versions:
feature: dependabot-job-log
fpt: '*'
ghec: '*'
ghes: '*'
type: how_to
topics:
- Dependabot
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,9 @@ Package manager | YAML value | Supported versions |
| Dev containers | `devcontainers` | Not applicable |
| {% endif %} |
| Docker | `docker` | v1 |
| {% ifversion dependabot-docker-compose-support %} |
| Docker Compose | `docker-compose` | v2, v3 |
| {% endif %} |
| {% ifversion dependabot-dotnet-sdk %} |
| .NET SDK | `dotnet-sdk` | >=.NET Core 3.1 |
| {% endif %} |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ You'll find detailed guidance for the setup of the following package managers:
* [Bun](#bun){% endif %}
* [Bundler](#bundler){% ifversion dependabot-updates-cargo-private-registry-support %}
* [Cargo](#cargo){% endif %}
* [Docker](#docker)
* [Docker](#docker){% ifversion dependabot-docker-compose-support %}
* [Docker Compose](#docker-compose){% endif %}
* [Gradle](#gradle)
* [Maven](#maven)
* [npm](#npm)
Expand Down Expand Up @@ -162,6 +163,14 @@ registries:
* 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.
* {% 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.

{% ifversion dependabot-docker-compose-support %}

### Docker Compose

Docker Compose adheres to the same configuration guidelines as Docker. For more information, see [Docker](#docker).

{% endif %}

### Gradle

{% 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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ In {% data variables.product.prodname_dependabot %} pull requests for grouped ve
> [!TIP]
> 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.
{% elsif dependabot-version-updates-groups %}
{% else %}

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ intro: 'Dependency review lets you catch insecure dependencies before you introd
shortTitle: Enforce dependency review
permissions: '{% data reusables.permissions.security-org-enable %}'
versions:
feature: repo-rules
fpt: '*'
ghec: '*'
ghes: '*'
type: overview
topics:
- Advanced Security
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: About contributing to GitHub Docs
shortTitle: About contributing
intro: 'You can contribute to GitHub Docs content in several ways.'
intro: You can contribute to GitHub Docs content in several ways.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

{% 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 %}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Label reference
intro: "Labels can help you find an issue you'd like to help with."
intro: Labels can help you find an issue you'd like to help with.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Using Git on GitHub Docs
shortTitle: Using Git
intro: 'You can use Git on the command line to commit changes and then push them to the documentation repository.'
intro: You can use Git on the command line to commit changes and then push them to the documentation repository.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Using the content linter
intro: 'You can use content linter to check your contributions for errors.'
intro: You can use content linter to check your contributions for errors.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

## About the {% data variables.product.prodname_docs %} content linter
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Using the TODOCS placeholder to leave notes
shortTitle: Using the TODOCS placeholder
intro: 'You can use the `TODOCS` placeholder to indicate work that still needs to be completed.'
intro: You can use the `TODOCS` placeholder to indicate work that still needs to be completed.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

<!-- markdownlint-disable search-replace -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Creating a local environment
shortTitle: Create a local environment
intro: 'You can run the {% data variables.product.prodname_docs %} application locally on your computer.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

## About {% data variables.product.prodname_docs %} site structure
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Troubleshooting your environment
intro: "Learn about troubleshooting problems in your local environment and the {% data variables.product.prodname_docs %} staging platform."
intro: 'Learn about troubleshooting problems in your local environment and the {% data variables.product.prodname_docs %} staging platform.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

## Troubleshooting tests that fail locally but pass in CI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Working on GitHub Docs in a codespace
shortTitle: Working in a codespace
intro: 'You can use {% data variables.product.prodname_github_codespaces %} to work on documentation for {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

## About {% data variables.product.prodname_github_codespaces %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: About combining multiple content types
shortTitle: Combining multiple types
intro: 'You can combine multiple content types in a single article to help people complete complex tasks.'
intro: You can combine multiple content types in a single article to help people complete complex tasks.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: About the content model
shortTitle: About the content model
intro: 'The content model describes the structure and types of content that we publish.'
intro: The content model describes the structure and types of content that we publish.
redirect_from:
- /contributing/writing-for-github-docs/content-model
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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 %}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: About topics
shortTitle: About topics
intro: 'Use topics to make articles searchable.'
intro: Use topics to make articles searchable.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Conceptual content type
intro: 'People most often use conceptual content when they are learning about something new to them.'
intro: People most often use conceptual content when they are learning about something new to them.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: Contents of a GitHub Docs article
shortTitle: Contents of an article
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.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

## About the structure of an article
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Procedural content type
intro: 'Procedural content gives context on how a task fits into someone''s larger goal.'
intro: Procedural content gives context on how a task fits into someone's larger goal.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

Procedural content helps people complete a task from start to finish while they are using {% data variables.product.prodname_dotcom %}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Quickstart content type
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.'
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.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Referential content type
intro: 'Referential content provides detailed information that people need while they are actively using a feature.'
intro: Referential content provides detailed information that people need while they are actively using a feature.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

We create referential articles and referential sections within other articles.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Release note content type
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.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Style guide
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.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/writing-for-github-docs/style-guide
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Troubleshooting content type
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.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---

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.
Expand Down
Loading

0 comments on commit 3e0e976

Please sign in to comment.