1
0
mirror of synced 2025-12-19 09:57:42 -05:00

Update frontmatter versions (#54542)

This commit is contained in:
Rachael Sewell
2025-02-25 09:27:55 -08:00
committed by GitHub
parent 02c3b476ea
commit 93420a2ffa
130 changed files with 427 additions and 168 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -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:

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,8 +1,10 @@
---
title: Tutorial content type
intro: 'Tutorials are useful when someone has a basic understanding of the product and is interested in extending their understanding to solve a specific problem'
intro: Tutorials are useful when someone has a basic understanding of the product and is interested in extending their understanding to solve a specific problem
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
Tutorials help people learn about products and solve real world problems by guiding them through the entire workflow to complete a task. Tutorials are more conversational in tone than other content. A tutorial feels like a developer-to-developer conversation while remaining accessible to readers with varied technical knowledge. Products with tutorials must already have a quickstart. For bite-sized workflows, use the quickstart model instead.

View File

@@ -3,7 +3,9 @@ title: About GitHub's documentation fundamentals
shortTitle: Documentation fundamentals
intro: 'All content published on {% data variables.product.prodname_docs %} must meet these fundamental requirements.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About {% data variables.product.github %}'s documentation fundamentals

View File

@@ -1,9 +1,11 @@
---
title: About GitHub's documentation philosophy
shortTitle: Documentation philosophy
intro: 'Our documentation philosophy guides what content we create and how we create it.'
intro: Our documentation philosophy guides what content we create and how we create it.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About the {% data variables.product.prodname_dotcom %} documentation philosophy

View File

@@ -1,10 +1,12 @@
---
title: Annotating code examples
shortTitle: Annotate code examples
intro: "You can annotate longer code examples to explain how they work and how people can customize them for other uses."
intro: You can annotate longer code examples to explain how they work and how people can customize them for other uses.
layout: inline
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/syntax-and-versioning-for-github-docs/annotating-code-examples
---

View File

@@ -1,9 +1,11 @@
---
title: Best practices for GitHub Docs
shortTitle: Best practices for GitHub Docs
intro: "Follow these best practices to create documentation that's user-friendly and easy to understand."
intro: Follow these best practices to create documentation that's user-friendly and easy to understand.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About {% data variables.product.prodname_dotcom %} documentation

View File

@@ -1,9 +1,11 @@
---
title: Changing an article's title
shortTitle: Change an article's title
intro: "When it's necessary to change the title of an article, the name may need to be updated in several places."
intro: 'When it''s necessary to change the title of an article, the name may need to be updated in several places.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title
---

View File

@@ -1,9 +1,11 @@
---
title: Configuring redirects
shortTitle: Configure redirects
intro: "If an article's title, version, or location changes, you can create a redirect to the current content."
intro: 'If an article''s title, version, or location changes, you can create a redirect to the current content.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/syntax-and-versioning-for-github-docs/configuring-redirects
---

View File

@@ -3,7 +3,9 @@ title: Content design principles
shortTitle: Content design principles
intro: 'We share these principles to design and create the best content for people who use {% data variables.product.prodname_dotcom %}.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About {% data variables.product.prodname_dotcom %}'s content design principles

View File

@@ -1,9 +1,11 @@
---
title: Creating diagrams for {% data variables.product.prodname_docs %}
title: 'Creating diagrams for {% data variables.product.prodname_docs %}'
shortTitle: Create diagrams
intro: 'This guide explains when and how to create diagrams for {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
allowTitleToDifferFromFilename: true
---

View File

@@ -1,9 +1,11 @@
---
title: Creating reusable content
shortTitle: Create reusable content
intro: 'You can create reusable content that can be referenced in multiple content files.'
intro: You can create reusable content that can be referenced in multiple content files.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About reusables

View File

@@ -1,9 +1,11 @@
---
title: Creating screenshots
shortTitle: Create screenshots
intro: "You can help users locate elements of the user interface that are difficult to find by adding screenshots to {% data variables.product.prodname_docs %}."
intro: 'You can help users locate elements of the user interface that are difficult to find by adding screenshots to {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About screenshots in {% data variables.product.prodname_docs %}

View File

@@ -1,9 +1,11 @@
---
title: Creating tool switchers in articles
shortTitle: Create tool switchers
intro: 'You can use a tool switcher to show how to complete tasks using specific tools.'
intro: You can use a tool switcher to show how to complete tasks using specific tools.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles
---

View File

@@ -3,7 +3,9 @@ title: Making content findable in search
shortTitle: Make content findable
intro: 'Follow these SEO best practices to help users find {% data variables.product.company_short %} documentation using search engines.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About search engine optimization (SEO)

View File

@@ -2,7 +2,9 @@
title: Templates
intro: 'This article contains starter templates for the different content types used in {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## Conceptual article template

View File

@@ -1,9 +1,11 @@
---
title: Using Markdown and Liquid in GitHub Docs
shortTitle: Markdown and Liquid # Max 31 characters
shortTitle: Markdown and Liquid
intro: 'You can use Markdown and Liquid to format content, create reusable content, and write content for different versions on {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs
---

View File

@@ -3,7 +3,9 @@ title: Using videos in GitHub Docs
shortTitle: Use videos
intro: 'This guide explains how to create videos that support user needs for {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About videos in {% data variables.product.prodname_docs %}

View File

@@ -1,9 +1,11 @@
---
title: Using YAML frontmatter
shortTitle: YAML frontmatter # Max 31 characters
shortTitle: YAML frontmatter
intro: 'You can use YAML frontmatter to define versioning, add metadata, and control the layout for articles.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter
---

View File

@@ -2,7 +2,9 @@
title: Versioning documentation
intro: '{% data variables.product.prodname_docs %} uses YAML frontmatter and liquid operators to support multiple versions of {% data variables.product.company_short %} with a single-source approach.'
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /contributing/syntax-and-versioning-for-github-docs/versioning-documentation
---

View File

@@ -1,9 +1,11 @@
---
title: Writing content to be translated
shortTitle: Write content to be translated
intro: 'Our documentation is translated into multiple languages. How we approach writing the English language documentation can greatly improve the quality of those translations.'
intro: Our documentation is translated into multiple languages. How we approach writing the English language documentation can greatly improve the quality of those translations.
versions:
feature: 'contributing'
fpt: '*'
ghec: '*'
ghes: '*'
---
## About writing content that is translation-friendly

View File

@@ -6,7 +6,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/adding-a-repository-from-your-local-computer-to-github-desktop
- /desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Add a repository
---

View File

@@ -6,7 +6,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/adding-an-existing-project-to-github-using-github-desktop
- /desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Add an existing project
---

View File

@@ -6,7 +6,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/cloning-a-repository-from-github-to-github-desktop
- /desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Clone a GitHub repo
---

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop
- /desktop/guides/contributing/cloning-a-repository-from-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Clone & fork from Desktop
---
## About local repositories

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/about-git-large-file-storage-and-github-desktop
- /desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
When you install {% data variables.product.prodname_desktop %}, {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) is installed, too. {% data variables.large_files.product_name_short %} lets you push files to {% data variables.product.prodname_dotcom %} that exceed the normal limit of {% data variables.large_files.max_github_size %}. For more information about {% data variables.large_files.product_name_short %}, see [AUTOTITLE](/repositories/working-with-files/managing-large-files/about-git-large-file-storage).

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor
- /desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Configure default editor
---

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-basic-settings
- /desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Configure basic settings
---
{% mac %}

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/configuring-git-for-github-desktop
- /desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-git-for-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About Git configuration for {% data variables.product.prodname_desktop %}

View File

@@ -6,7 +6,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/setting-a-theme-for-github-desktop
- /desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/setting-a-theme-for-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Set a theme
---
{% mac %}

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: About connections
---
{% data variables.product.prodname_desktop %} connects to {% data variables.product.prodname_dotcom %} when you pull from, push to, clone, and fork remote repositories. To connect to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_desktop %}, you must authenticate your account. For more information, see [AUTOTITLE](/desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop).

View File

@@ -9,7 +9,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About authentication

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/installing-github-desktop
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
<a href="https://desktop.github.com?ref_cta=download+desktop&ref_loc=installing+github+desktop&ref_page=docs" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Download {% data variables.product.prodname_desktop %}</span> {% octicon "link-external" height:16 %}</a>

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/setting-up-github-desktop
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## Part 1: Installing {% data variables.product.prodname_desktop %}

View File

@@ -6,7 +6,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/uninstalling-github-desktop
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/uninstalling-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Uninstalling
---
{% mac %}

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/updating-github-desktop
- /desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
{% mac %}

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Commit & review changes
---
## About commits

View File

@@ -10,8 +10,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About managing branches

View File

@@ -9,7 +9,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/pushing-changes-to-github
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About pushing changes to {% data variables.product.prodname_dotcom %}

View File

@@ -3,7 +3,9 @@ title: Stashing changes in GitHub Desktop
shortTitle: Stashing changes
intro: 'You can temporarily save your changes without committing them to a branch by stashing the changes in {% data variables.product.prodname_desktop %}.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/stashing-changes
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/stashing-changes

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/viewing-the-branch-history
- /desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: View branch history
---
Each commit shows:

View File

@@ -3,7 +3,9 @@ title: Amending a commit in GitHub Desktop
shortTitle: Amending a commit
intro: 'You can use {% data variables.product.prodname_desktop %} to amend your last commit.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/amending-a-commit
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/amending-a-commit-in-github-desktop

View File

@@ -3,7 +3,9 @@ title: Checking out a commit in GitHub Desktop
shortTitle: Checking out a commit
intro: 'You can use {% data variables.product.prodname_desktop %} to checkout a previous commit in your repository.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/checking-out-a-commit-in-github-desktop
---

View File

@@ -3,7 +3,9 @@ title: Cherry-picking a commit in GitHub Desktop
shortTitle: Cherry-picking a commit
intro: 'You can use {% data variables.product.prodname_desktop %} to pick a specific commit on one branch and copy the commit to another branch.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/cherry-picking-a-commit
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/cherry-picking-a-commit

View File

@@ -8,7 +8,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/managing-tags
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/managing-tags-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About tags in {% data variables.product.prodname_desktop %}

View File

@@ -3,7 +3,9 @@ title: Options for managing commits in GitHub Desktop
shortTitle: Options for managing commits
intro: 'You can use {% data variables.product.prodname_desktop %} to maintain an easy-to-follow commit history.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About commit history in {% data variables.product.prodname_desktop %}

View File

@@ -3,7 +3,9 @@ title: Reordering commits in GitHub Desktop
shortTitle: Reordering commits
intro: 'You can use {% data variables.product.prodname_desktop %} to reorder commits in your branch''s history.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reordering-commits
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reordering-commits-in-github-desktop

View File

@@ -1,9 +1,11 @@
---
title: Resetting to a commit in GitHub Desktop
shortTitle: Resetting to a commit
intro: 'You can reset to any commit up to the one that was last pushed to the remote branch.'
intro: You can reset to any commit up to the one that was last pushed to the remote branch.
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About resetting to a commit

View File

@@ -8,7 +8,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reverting-a-commit
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reverting-a-commit-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
When you revert to a previous commit, the revert is also a commit. The original commit also remains in the repository's history.

View File

@@ -3,7 +3,9 @@ title: Squashing commits in GitHub Desktop
shortTitle: Squashing commits
intro: 'You can use {% data variables.product.prodname_desktop %} to squash commits in your branch''s history.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/squashing-commits
- /desktop/contributing-and-collaborating-using-github-desktop/managing-commits/squashing-commits-in-github-desktop

View File

@@ -1,9 +1,11 @@
---
title: Undoing a commit in GitHub Desktop
shortTitle: Undoing a commit
intro: 'You can undo a commit before you have pushed it to the remote branch.'
intro: You can undo a commit before you have pushed it to the remote branch.
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About undoing a commit

View File

@@ -1,9 +1,11 @@
---
title: About GitHub Desktop
shortTitle: 'About'
shortTitle: About
intro: '{% data variables.product.prodname_desktop %} helps you work with projects hosted on {% data variables.product.prodname_dotcom %}.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/installing-and-configuring-github-desktop/overview/about-github-desktop
- /github/getting-started-with-github/github-desktop

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop
- /desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## Introduction

View File

@@ -2,7 +2,9 @@
title: Getting started with GitHub Desktop
intro: 'Learn how to set up, authenticate, and configure {% data variables.product.prodname_desktop %} to allow you to contribute to projects directly from your machine.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop
- /desktop/guides/getting-started

View File

@@ -9,7 +9,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/overview/keyboard-shortcuts
- /desktop/installing-and-configuring-github-desktop/overview/github-desktop-keyboard-shortcuts
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
{% mac %}

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/launching-github-desktop-from-the-command-line
- /desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
{% mac %}

View File

@@ -7,7 +7,9 @@ redirect_from:
- /desktop/installing-and-configuring-github-desktop/overview/supported-operating-systems
- /desktop/installing-and-configuring-github-desktop/overview/supported-operating-systems-for-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Supported OS
---
## About supported operating systems

View File

@@ -9,7 +9,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/changing-the-remote-url-for-a-repository-from-github-desktop
- /desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/changing-the-remote-url-for-a-repository-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Change the remote URL for a repository
---
{% mac %}

View File

@@ -3,7 +3,9 @@ title: Configuring notifications in GitHub Desktop
shortTitle: Configuring notifications
intro: '{% data variables.product.prodname_desktop %} will keep you up-to-date with notifications about events that occur in your pull request branch.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop
---

View File

@@ -9,7 +9,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request
- /desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
shortTitle: Create an issue or PR
---
## About issues and pull requests

View File

@@ -9,7 +9,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch-in-github-desktop
- /desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About branch synchronization

View File

@@ -8,7 +8,9 @@ redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/viewing-a-pull-request-in-github-desktop
- /desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
---
## About pull requests in {% data variables.product.prodname_desktop %}

View File

@@ -3,7 +3,9 @@ title: Viewing and re-running checks in GitHub Desktop
shortTitle: Viewing and re-running checks
intro: 'You can view the status of checks and re-run them in {% data variables.product.prodname_desktop %}.'
versions:
feature: desktop
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop
---

View File

@@ -3,7 +3,9 @@ title: 'Automating {% data variables.product.prodname_projects_v2 %} using Actio
shortTitle: Automating with Actions
intro: 'You can use {% data variables.product.prodname_actions %} to automate your projects.'
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/automating-projects
type: tutorial

View File

@@ -3,7 +3,9 @@ title: 'Using the API to manage {% data variables.product.prodname_projects_v2 %
shortTitle: Automating with the API
intro: You can use the GraphQL API to automate your projects.
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects
type: tutorial

View File

@@ -2,7 +2,9 @@
title: 'Creating a {% data variables.projects.project_v2 %}'
intro: Learn how to create an organization or user project.
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/creating-a-project
type: tutorial

View File

@@ -3,7 +3,9 @@ title: Changing the layout of a view
shortTitle: Changing the layout
intro: 'You can view your project as a high-density table, as a kanban board, or as a timeline-style roadmap.'
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/customizing-your-project-views
- /issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-a-view

View File

@@ -3,7 +3,9 @@ title: Customizing the board layout
shortTitle: Customizing boards
intro: You can use the board layout to arrange your project's items over customizable columns.
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
type: tutorial
topics:
- Projects

View File

@@ -3,7 +3,9 @@ title: Customizing the table layout
shortTitle: Customizing tables
intro: 'You can use the table layout to build a spreadsheet using your project''s items, {% data variables.product.company_short %} metadata, and your custom fields.'
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
type: tutorial
topics:
- Projects

View File

@@ -2,7 +2,9 @@
title: 'Filtering {% data variables.projects.projects_v2 %}'
intro: Use filters to choose which items appear in your project's views.
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/filtering-projects
type: tutorial

View File

@@ -2,7 +2,9 @@
title: Managing your views
intro: 'Learn how to create, save, and manage your project views.'
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
type: tutorial
topics:
- Projects

View File

@@ -3,7 +3,9 @@ title: 'About {% data variables.product.prodname_projects_v2 %}'
intro: '{% data variables.product.prodname_projects_v2 %} is an adaptable, flexible tool for planning and tracking work on {% data variables.product.company_short %}.'
allowTitleToDifferFromFilename: true
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/about-projects
type: overview

View File

@@ -3,7 +3,9 @@ title: 'Best practices for {% data variables.product.prodname_projects_v2 %}'
intro: Learn tips for managing your projects.
allowTitleToDifferFromFilename: true
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/best-practices-for-managing-projects
type: overview

View File

@@ -3,7 +3,9 @@ title: 'Finding your {% data variables.projects.projects_v2 %}'
intro: 'Learn how to locate projects in your account, organizations, repositories, and teams.'
allowTitleToDifferFromFilename: true
versions:
feature: projects-v2-global-nav
fpt: '*'
ghec: '*'
ghes: '*'
type: overview
topics:
- Projects

View File

@@ -3,7 +3,9 @@ title: 'Quickstart for {% data variables.product.prodname_projects_v2 %}'
intro: 'Experience the speed, flexibility, and customization of {% data variables.product.prodname_projects_v2 %} by creating a project in this interactive guide.'
allowTitleToDifferFromFilename: true
versions:
feature: projects-v2
fpt: '*'
ghec: '*'
ghes: '*'
redirect_from:
- /issues/trying-out-the-new-projects-experience/quickstart
type: quick_start

Some files were not shown because too many files have changed in this diff Show More