Skip to content

Commit d6dcd23

Browse files
authored
Landing page: Contributing (#60338)
1 parent d0cf23e commit d6dcd23

38 files changed

Lines changed: 93 additions & 8 deletions

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ versions:
66
fpt: '*'
77
ghec: '*'
88
ghes: '*'
9+
category:
10+
- Get set up to contribute
911
---
1012

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ versions:
55
fpt: '*'
66
ghec: '*'
77
ghes: '*'
8+
category:
9+
- Get set up to contribute
810
---
911

1012
You can use labels to locate a particular type of issue. The examples below show some commonly used labels that can help you get started. Each label links to a filtered list of open issues in the github/docs repository.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ versions:
66
fpt: '*'
77
ghec: '*'
88
ghes: '*'
9+
category:
10+
- Get set up to contribute
911
---
1012

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ versions:
55
fpt: '*'
66
ghec: '*'
77
ghes: '*'
8+
category:
9+
- Get set up to contribute
810
---
911

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ versions:
66
fpt: '*'
77
ghec: '*'
88
ghes: '*'
9+
category:
10+
- Get set up to contribute
911
---
1012

1113

content/contributing/index.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,31 @@
22
title: Contributing to GitHub Docs documentation
33
shortTitle: Contribute to GitHub Docs
44
intro: 'Learn about how the {% data variables.product.prodname_docs %} team creates documentation and how you can contribute.'
5-
layout: product-landing
6-
versions:
7-
feature: 'contributing'
8-
featuredLinks:
9-
startHere:
5+
introLinks:
6+
overview: /contributing/collaborating-on-github-docs/about-contributing-to-github-docs
7+
quickstart: /contributing/writing-for-github-docs/best-practices-for-github-docs
8+
changelog:
9+
label: docs
10+
layout: discovery-landing
11+
includedCategories:
12+
- Understand the GitHub approach to docs
13+
- Follow the style guide and content model
14+
- Write and format content
15+
- Get set up to contribute
16+
carousels:
17+
recommended:
18+
- /contributing/collaborating-on-github-docs/about-contributing-to-github-docs
1019
- /contributing/writing-for-github-docs/best-practices-for-github-docs
1120
- /contributing/style-guide-and-content-model/style-guide
1221
- /contributing/style-guide-and-content-model/about-the-content-model
13-
- /contributing/collaborating-on-github-docs/about-contributing-to-github-docs
14-
changelog:
15-
label: docs
22+
- /contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs
23+
- /contributing/writing-for-github-docs/templates
24+
versions:
25+
feature: 'contributing'
1626
children:
1727
- /writing-for-github-docs
1828
- /style-guide-and-content-model
1929
- /collaborating-on-github-docs
2030
- /setting-up-your-environment-to-work-on-github-docs
31+
contentType: landing
2132
---

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ versions:
66
fpt: '*'
77
ghec: '*'
88
ghes: '*'
9+
category:
10+
- Get set up to contribute
911
---
1012

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ versions:
55
fpt: '*'
66
ghec: '*'
77
ghes: '*'
8+
category:
9+
- Get set up to contribute
810
---
911

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ versions:
66
fpt: '*'
77
ghec: '*'
88
ghes: '*'
9+
category:
10+
- Get set up to contribute
911
---
1012

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ versions:
66
fpt: '*'
77
ghec: '*'
88
ghes: '*'
9+
category:
10+
- Follow the style guide and content model
911
---
1012

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

0 commit comments

Comments
 (0)