1
0
mirror of synced 2025-12-23 21:07:12 -05:00

Remove product callouts from contributing docs (#49301)

This commit is contained in:
Steve Guntrip
2024-02-22 11:11:10 +00:00
committed by GitHub
parent cbf356ec8a
commit 1430fafa41
42 changed files with 0 additions and 42 deletions

View File

@@ -2,7 +2,6 @@
title: About contributing to GitHub Docs title: About contributing to GitHub Docs
shortTitle: About contributing 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Collaborating on GitHub Docs title: Collaborating on GitHub Docs
shortTitle: Collaborate on GitHub Docs shortTitle: Collaborate on GitHub Docs
intro: 'Find out about collaborating on GitHub Docs.' intro: 'Find out about collaborating on GitHub Docs.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
children: children:

View File

@@ -1,7 +1,6 @@
--- ---
title: Label reference 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."
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Self review checklist title: Self review checklist
intro: "Before you submit your pull request for review, you should first review it yourself." intro: "Before you submit your pull request for review, you should first review it yourself."
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Using Git on GitHub Docs title: Using Git on GitHub Docs
shortTitle: Using Git 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Using the content linter 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Using the TODOCS placeholder to leave notes title: Using the TODOCS placeholder to leave notes
shortTitle: Using the TODOCS placeholder 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -3,7 +3,6 @@ title: Contributing to GitHub Docs documentation
shortTitle: Contribute to GitHub Docs shortTitle: Contribute to GitHub Docs
intro: 'Learn about how the {% data variables.product.prodname_docs %} team creates documentation and how you can contribute.' intro: 'Learn about how the {% data variables.product.prodname_docs %} team creates documentation and how you can contribute.'
layout: product-landing layout: product-landing
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
featuredLinks: featuredLinks:

View File

@@ -2,7 +2,6 @@
title: Creating a local environment title: Creating a local environment
shortTitle: Create a local environment shortTitle: Create a local environment
intro: 'You can run the {% data variables.product.prodname_docs %} application locally on your computer.' intro: 'You can run the {% data variables.product.prodname_docs %} application locally on your computer.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Setting up your environment to work on {% data variables.product.prodname_docs %} title: Setting up your environment to work on {% data variables.product.prodname_docs %}
shortTitle: Your working environment shortTitle: Your working environment
intro: 'Learn about running the {% data variables.product.prodname_docs %} site locally or in {% data variables.product.prodname_github_codespaces %}.' intro: 'Learn about running the {% data variables.product.prodname_docs %} site locally or in {% data variables.product.prodname_github_codespaces %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
children: children:

View File

@@ -1,7 +1,6 @@
--- ---
title: Troubleshooting your environment 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."
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Working on GitHub Docs in a codespace title: Working on GitHub Docs in a codespace
shortTitle: Working 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 %}.' intro: 'You can use {% data variables.product.prodname_github_codespaces %} to work on documentation for {% data variables.product.prodname_docs %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: About combining multiple content types title: About combining multiple content types
shortTitle: Combining multiple 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: About the content model title: About the content model
shortTitle: 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.'
product: '{% data reusables.contributing.product-note %}'
redirect_from: redirect_from:
- /contributing/writing-for-github-docs/content-model - /contributing/writing-for-github-docs/content-model
versions: versions:

View File

@@ -2,7 +2,6 @@
title: About topics title: About topics
shortTitle: About topics shortTitle: About topics
intro: 'Use topics to make articles searchable.' intro: 'Use topics to make articles searchable.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Conceptual content type 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Contents of a GitHub Docs article title: Contents of a GitHub Docs article
shortTitle: Contents of an 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.' 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Style guide and content model title: Style guide and content model
intro: 'Learn about how we keep GitHub''s documentation consistent, easy to follow, and maintainable.' intro: 'Learn about how we keep GitHub''s documentation consistent, easy to follow, and maintainable.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
children: children:

View File

@@ -1,7 +1,6 @@
--- ---
title: Procedural content type 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Quickstart content type 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Referential content type 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Release note content type 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.' 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Style guide 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.' 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
redirect_from: redirect_from:

View File

@@ -1,7 +1,6 @@
--- ---
title: Troubleshooting content type 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.' 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1,7 +1,6 @@
--- ---
title: Tutorial content type 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'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: About GitHub's documentation philosophy title: About GitHub's documentation philosophy
shortTitle: 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Annotating code examples title: Annotating code examples
shortTitle: Annotating code examples shortTitle: Annotating 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."
product: '{% data reusables.contributing.product-note %}'
layout: inline layout: inline
versions: versions:
feature: 'contributing' feature: 'contributing'

View File

@@ -2,7 +2,6 @@
title: Changing an article's title title: Changing an article's title
shortTitle: Change 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."
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
redirect_from: redirect_from:

View File

@@ -1,7 +1,6 @@
--- ---
title: Configuring redirects title: Configuring 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."
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
redirect_from: redirect_from:

View File

@@ -2,7 +2,6 @@
title: Content design principles title: Content design principles
shortTitle: 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 %}.' intro: 'We share these principles to design and create the best content for people who use {% data variables.product.prodname_dotcom %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Creating diagrams for {% data variables.product.prodname_docs %} title: Creating diagrams for {% data variables.product.prodname_docs %}
shortTitle: Creating diagrams shortTitle: Creating diagrams
intro: 'This guide explains when and how to create diagrams for {% data variables.product.prodname_docs %}.' intro: 'This guide explains when and how to create diagrams for {% data variables.product.prodname_docs %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true

View File

@@ -2,7 +2,6 @@
title: Creating reusable content title: Creating reusable content
shortTitle: Create 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -4,7 +4,6 @@ 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: versions:
feature: 'contributing' feature: 'contributing'
product: '{% data reusables.contributing.product-note %}'
--- ---
## About screenshots in {% data variables.product.prodname_docs %} ## About screenshots in {% data variables.product.prodname_docs %}

View File

@@ -2,7 +2,6 @@
title: Creating tool switchers in articles title: Creating tool switchers in articles
shortTitle: Creating tool switchers shortTitle: Creating 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
redirect_from: redirect_from:

View File

@@ -2,7 +2,6 @@
title: Writing for GitHub Docs title: Writing for GitHub Docs
shortTitle: Writing for GitHub Docs shortTitle: Writing for GitHub Docs
intro: 'Learn about writing for {% data variables.product.prodname_docs %}.' intro: 'Learn about writing for {% data variables.product.prodname_docs %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
children: children:

View File

@@ -1,7 +1,6 @@
--- ---
title: Templates title: Templates
intro: 'This article contains starter templates for the different content types used in {% data variables.product.prodname_docs %}.' intro: 'This article contains starter templates for the different content types used in {% data variables.product.prodname_docs %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Using Markdown and Liquid in GitHub Docs title: Using Markdown and Liquid in GitHub Docs
shortTitle: Markdown and Liquid # Max 31 characters shortTitle: Markdown and Liquid # Max 31 characters
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 %}.' 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 %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
redirect_from: redirect_from:

View File

@@ -2,7 +2,6 @@
title: Using videos in GitHub Docs title: Using videos in GitHub Docs
shortTitle: Using videos shortTitle: Using videos
intro: 'This guide explains how to create videos that support user needs for {% data variables.product.prodname_docs %}.' intro: 'This guide explains how to create videos that support user needs for {% data variables.product.prodname_docs %}.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -2,7 +2,6 @@
title: Using YAML frontmatter title: Using YAML frontmatter
shortTitle: YAML frontmatter # Max 31 characters shortTitle: YAML frontmatter # Max 31 characters
intro: 'You can use YAML frontmatter to define versioning, add metadata, and control the layout for articles.' intro: 'You can use YAML frontmatter to define versioning, add metadata, and control the layout for articles.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
redirect_from: redirect_from:

View File

@@ -1,7 +1,6 @@
--- ---
title: Versioning documentation 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.' 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
redirect_from: redirect_from:

View File

@@ -2,7 +2,6 @@
title: Writing content to be translated title: Writing content to be translated
shortTitle: Write 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.'
product: '{% data reusables.contributing.product-note %}'
versions: versions:
feature: 'contributing' feature: 'contributing'
--- ---

View File

@@ -1 +0,0 @@
Articles in the "Contributing to GitHub Docs" section refer to the documentation itself and are a resource for GitHub staff and open source contributors.