Skip to content

Commit f932da2

Browse files
mrbobbytablesmrbobbytables
committed
Add frontmatter descriptions to the contributor guide docs
1 parent fd5df0d commit f932da2

17 files changed

+63
-26
lines changed

‎contributors/guide/README.md

-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
1-
---
2-
title: "Contributors Guide"
3-
weight: 1
4-
slug: "guide"
5-
---
6-
7-
<!--
8-
Contributing to this document?
9-
Please use semantic line feeds for readability: http://rhodesmill.org/brandon/2012/one-sentence-per-line/
10-
-->
11-
121
This document is the single source of truth for how to contribute to the code base.
132
Feel free to browse the [open issues](https://github.com/kubernetes/community/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fcontributor-guide) and file new ones, all feedback welcome!
143

‎contributors/guide/coding-conventions.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: "Coding Conventions"
33
weight: 8
4-
slug: "coding-conventions"
4+
description: |
5+
A collection of guidelines, style suggestions, and tips for writing code in
6+
the different programming languages used throughout the project.
57
---
68

79
**Table of Contents**

‎contributors/guide/contributing.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: "Contributing to Kubernetes"
33
weight: 4
4-
slug: "contributing"
4+
description: |
5+
An entrypoint to getting started with contributing to the Kubernetes project.
56
---
67

78
# Contributing

‎contributors/guide/contributor-cheatsheet/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: Contributor Cheatsheet
3+
weight: 2
4+
description: |
5+
A list of common resources when contributing to Kubernetes, tips, tricks, and
6+
common best practices used within the Kubernetes project. It is a "TL;DR" or
7+
quick reference of useful information to make your GitHub contribution experience
8+
better.
9+
---
10+
111
<!-- omit in toc -->
212
# Kubernetes Contributor Cheat Sheet
313

‎contributors/guide/expectations.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: "Community Expectations"
33
weight: 17
4-
slug: "expectations"
4+
description: |
5+
Expectations of conduct and code review that govern all members of the
6+
community.
57
---
68

79
Kubernetes is a community project. Consequently, it is wholly dependent on

‎contributors/guide/first-contribution.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: "Making your First Contribution"
33
weight: 3
4-
slug: "first-contribution"
4+
description: |
5+
Not sure where to make your first contribution? This doc has some tips and
6+
ideas to help get you started.
57
---
68

79
# Your First Contribution

‎contributors/guide/getting-started.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Getting Started"
33
weight: 2
4-
slug: "getting-started"
4+
description: |
5+
A small list of things that you should read and be familiar with before you
6+
get started with contributing. This includes such things as signing the
7+
Contributor License Agreement, familiarizing yourself with our Code of Conduct
8+
and more.
59
---
610

711
# Before you get started

‎contributors/guide/github-workflow.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
22
title: "GitHub Workflow"
33
weight: 6
4-
slug: "github-workflow"
4+
description: |
5+
An overview of the GitHub workflow used by the Kubernetes project. It includes
6+
some tips and suggestions on things such as keeping your local environment in
7+
sync with upstream and commit hygiene.
58
---
69

710
![Git workflow](git_workflow.png)

‎contributors/guide/help-wanted.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
22
title: "Help Wanted and Good First Issue Labels"
33
weight: 9
4-
slug: "help-wanted"
4+
description: |
5+
Provides guidance on how and when to use the help wanted and good first issue
6+
labels. These are used to identify issues that have been specially groomed for
7+
new contributors.
58
---
69

710
# Overview

‎contributors/guide/issue-triage.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
22
title: "Issue Triage Guidelines"
33
weight: 10
4-
slug: "issue-triage"
4+
description: |
5+
These guidelines serve as a primary document for triaging incoming issues to
6+
Kubernetes. SIGs and projects are encouraged to use this guidance as a
7+
starting point, and customize to address specific triaging needs.
58
---
69

710
# Issue Triage: A Primer

‎contributors/guide/non-code-contributions.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Non-code Contributions"
33
weight: 11
4-
slug: "non-code-contributions"
4+
description: |
5+
Looking for a good entrance into the project? or to do something different?
6+
There are many ways to contribute to the the Kubernetes project without having
7+
to have coding experience: issue triage, writing documentation, joining the
8+
release team and much more.
59
---
610

711
*This section is new and in progress. Expect this document to change often.*

‎contributors/guide/owners.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
22
title: "OWNERS Files"
33
weight: 15
4-
slug: "owners"
4+
description: |
5+
OWNERS files are used to designate responsibility over different parts of the
6+
Kubernetes codebase and serve as the implementation mechanism for the two-phase
7+
code review process used by the project.
58
---
69

710
## Overview

‎contributors/guide/pull-requests.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: "Pull Request Process"
33
weight: 5
4-
slug: "pull-requests"
4+
description: |
5+
Explains the process and best practices for submitting a pull request
6+
to the Kubernetes project and its associated sub-repositories. It should serve
7+
as a reference for all contributors, and be useful especially to new or
8+
infrequent submitters.
59
---
610

711
This doc explains the process and best practices for submitting a pull request to the [Kubernetes project](https://github.com/kubernetes/kubernetes) and its associated sub-repositories. It should serve as a reference for all contributors, and be useful especially to new and infrequent submitters.

‎contributors/guide/release-notes.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: "Adding Release Notes"
33
weight: 12
4-
slug: "release-notes"
4+
description: |
5+
Guidance on providing release notes for changes made to the main Kubernetes
6+
project repo.
57
---
68

79
On the kubernetes/kubernetes repository, release notes are required for any pull

‎contributors/guide/review-guidelines.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: "Pull Request Review Guidelines"
33
weight: 13
4-
slug: "review-guidelines"
4+
description: |
5+
A collection of of tips to help both those looking to get their PR reviewed
6+
and the code reviewers themselves.
57
---
68
- [Tips for getting your PR reviewed](#tips-for-getting-your-pr-reviewed)
79
- [Use Tokens to signal the state of your PR](#use-tokens-to-signal-the-state-of-your-pr)

‎contributors/guide/scalability-good-practices.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: "Scalability Good Practices"
33
weight: 13
4-
slug: "scalability-good-practices"
4+
description: |
5+
Some programming best practices and examples to help you avoid potential
6+
scalability regressions.
57
---
68

79
*This document is written for contributors who would like to avoid their code being reverted for performance reasons*

‎contributors/guide/style-guide.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: "Documentation Style Guide"
33
weight: 14
4-
slug: "style-guide"
4+
description: |
5+
A comprehensive collection of guidelines for writing contributor documentation.
56
---
67

78
This style guide is for content in the Kubernetes github [community repository].

0 commit comments

Comments
 (0)