Skip to content

Add frontmatter descriptions to the contributor guide docs #4870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions contributors/guide/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
---
title: "Contributors Guide"
weight: 1
slug: "guide"
---

<!--
Contributing to this document?
Please use semantic line feeds for readability: http://rhodesmill.org/brandon/2012/one-sentence-per-line/
-->

Comment on lines -1 to -11
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page is no longer being included and our current practice is to word wrap at 80 characters following the style guide

This document is the single source of truth for how to contribute to the code base.
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!

Expand Down
4 changes: 3 additions & 1 deletion contributors/guide/coding-conventions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Coding Conventions"
weight: 8
slug: "coding-conventions"
description: |
A collection of guidelines, style suggestions, and tips for writing code in
the different programming languages used throughout the project.
---

**Table of Contents**
Expand Down
3 changes: 2 additions & 1 deletion contributors/guide/contributing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Contributing to Kubernetes"
weight: 4
slug: "contributing"
description: |
An entrypoint to getting started with contributing to the Kubernetes project.
---

# Contributing
Expand Down
10 changes: 10 additions & 0 deletions contributors/guide/contributor-cheatsheet/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
title: Contributor Cheatsheet
weight: 2
description: |
A list of common resources when contributing to Kubernetes, tips, tricks, and
common best practices used within the Kubernetes project. It is a "TL;DR" or
quick reference of useful information to make your GitHub contribution experience
better.
---

<!-- omit in toc -->
# Kubernetes Contributor Cheat Sheet

Expand Down
4 changes: 3 additions & 1 deletion contributors/guide/expectations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Community Expectations"
weight: 17
slug: "expectations"
description: |
Expectations of conduct and code review that govern all members of the
community.
---

Kubernetes is a community project. Consequently, it is wholly dependent on
Expand Down
4 changes: 3 additions & 1 deletion contributors/guide/first-contribution.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Making your First Contribution"
weight: 3
slug: "first-contribution"
description: |
Not sure where to make your first contribution? This doc has some tips and
ideas to help get you started.
---

# Your First Contribution
Expand Down
6 changes: 5 additions & 1 deletion contributors/guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
---
title: "Getting Started"
weight: 2
slug: "getting-started"
description: |
A small list of things that you should read and be familiar with before you
get started with contributing. This includes such things as signing the
Contributor License Agreement, familiarizing yourself with our Code of Conduct
and more.
---

# Before you get started
Expand Down
5 changes: 4 additions & 1 deletion contributors/guide/github-workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: "GitHub Workflow"
weight: 6
slug: "github-workflow"
description: |
An overview of the GitHub workflow used by the Kubernetes project. It includes
some tips and suggestions on things such as keeping your local environment in
sync with upstream and commit hygiene.
---

![Git workflow](git_workflow.png)
Expand Down
5 changes: 4 additions & 1 deletion contributors/guide/help-wanted.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: "Help Wanted and Good First Issue Labels"
weight: 9
slug: "help-wanted"
description: |
Provides guidance on how and when to use the help wanted and good first issue
labels. These are used to identify issues that have been specially groomed for
new contributors.
---

# Overview
Expand Down
5 changes: 4 additions & 1 deletion contributors/guide/issue-triage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: "Issue Triage Guidelines"
weight: 10
slug: "issue-triage"
description: |
These guidelines serve as a primary document for triaging incoming issues to
Kubernetes. SIGs and projects are encouraged to use this guidance as a
starting point, and customize to address specific triaging needs.
---

# Issue Triage: A Primer
Expand Down
6 changes: 5 additions & 1 deletion contributors/guide/non-code-contributions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
---
title: "Non-code Contributions"
weight: 11
slug: "non-code-contributions"
description: |
Looking for a good entrance into the project? or to do something different?
There are many ways to contribute to the the Kubernetes project without having
to have coding experience: issue triage, writing documentation, joining the
release team and much more.
---

*This section is new and in progress. Expect this document to change often.*
Expand Down
5 changes: 4 additions & 1 deletion contributors/guide/owners.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: "OWNERS Files"
weight: 15
slug: "owners"
description: |
OWNERS files are used to designate responsibility over different parts of the
Kubernetes codebase and serve as the implementation mechanism for the two-phase
code review process used by the project.
---

## Overview
Expand Down
6 changes: 5 additions & 1 deletion contributors/guide/pull-requests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
---
title: "Pull Request Process"
weight: 5
slug: "pull-requests"
description: |
Explains the process and best practices for submitting a pull request
to the Kubernetes project and its associated sub-repositories. It should serve
as a reference for all contributors, and be useful especially to new or
infrequent submitters.
---

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.
Expand Down
4 changes: 3 additions & 1 deletion contributors/guide/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Adding Release Notes"
weight: 12
slug: "release-notes"
description: |
Guidance on providing release notes for changes made to the main Kubernetes
project repo.
---

On the kubernetes/kubernetes repository, release notes are required for any pull
Expand Down
4 changes: 3 additions & 1 deletion contributors/guide/review-guidelines.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Pull Request Review Guidelines"
weight: 13
slug: "review-guidelines"
description: |
A collection of of tips to help both those looking to get their PR reviewed
and the code reviewers themselves.
---
- [Tips for getting your PR reviewed](#tips-for-getting-your-pr-reviewed)
- [Use Tokens to signal the state of your PR](#use-tokens-to-signal-the-state-of-your-pr)
Expand Down
5 changes: 0 additions & 5 deletions contributors/guide/scalability-good-practices.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: "Scalability Good Practices"
weight: 13
slug: "scalability-good-practices"
---

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

Expand Down
3 changes: 2 additions & 1 deletion contributors/guide/style-guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Documentation Style Guide"
weight: 14
slug: "style-guide"
description: |
A comprehensive collection of guidelines for writing contributor documentation.
---

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