Add frontmatter descriptions to the contributor guide docs
This commit is contained in:
Bob Killen
parent
fd5df0deed
commit
427ccfbc7d
|
|
@ -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/
|
||||
-->
|
||||
|
||||
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!
|
||||
|
||||
|
|
|
|||
|
|
@ -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**
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.*
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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*
|
||||
|
||||
|
|
|
|||
|
|
@ -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].
|
||||
|
|
|
|||
Loading…
Reference in New Issue