Remove product callouts from contributing docs (#49301)
This commit is contained in:
@@ -2,7 +2,6 @@
|
||||
title: About GitHub's documentation philosophy
|
||||
shortTitle: Documentation philosophy
|
||||
intro: 'Our documentation philosophy guides what content we create and how we create it.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
---
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: 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."
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
layout: inline
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
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."
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
redirect_from:
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Configuring redirects
|
||||
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:
|
||||
feature: 'contributing'
|
||||
redirect_from:
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
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 %}.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
---
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: Creating diagrams for {% data variables.product.prodname_docs %}
|
||||
shortTitle: Creating diagrams
|
||||
intro: 'This guide explains when and how to create diagrams for {% data variables.product.prodname_docs %}.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
allowTitleToDifferFromFilename: true
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: Creating reusable content
|
||||
shortTitle: Create reusable content
|
||||
intro: 'You can create reusable content that can be referenced in multiple content files.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
---
|
||||
|
||||
@@ -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 %}."
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
---
|
||||
|
||||
## About screenshots in {% data variables.product.prodname_docs %}
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: Creating tool switchers in articles
|
||||
shortTitle: Creating tool switchers
|
||||
intro: 'You can use a tool switcher to show how to complete tasks using specific tools.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
redirect_from:
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: Writing for GitHub Docs
|
||||
shortTitle: Writing for GitHub Docs
|
||||
intro: 'Learn about writing for {% data variables.product.prodname_docs %}.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
children:
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Templates
|
||||
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:
|
||||
feature: 'contributing'
|
||||
---
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: Using Markdown and Liquid in GitHub Docs
|
||||
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 %}.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
redirect_from:
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: Using videos in GitHub Docs
|
||||
shortTitle: Using videos
|
||||
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:
|
||||
feature: 'contributing'
|
||||
---
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
title: Using YAML frontmatter
|
||||
shortTitle: YAML frontmatter # Max 31 characters
|
||||
intro: 'You can use YAML frontmatter to define versioning, add metadata, and control the layout for articles.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
redirect_from:
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
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.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
redirect_from:
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
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.'
|
||||
product: '{% data reusables.contributing.product-note %}'
|
||||
versions:
|
||||
feature: 'contributing'
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user