Skip to content

Commit e83d47d

Browse files
addressing changes
1 parent 2745517 commit e83d47d

File tree

4 files changed

+54
-51
lines changed

4 files changed

+54
-51
lines changed

contributors/guide/README.md

+3-29
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Getting started with Kubernetes"
3-
weight: 2
2+
title: "Getting Started with Contributing"
3+
weight: 1
44
slug: "guide"
55
---
66

@@ -17,11 +17,7 @@ Feel free to browse the [open issues](https://github.com/kubernetes/community/is
1717
Welcome to Kubernetes!
1818

1919
- [Welcome](#welcome)
20-
- [Before you get started](#before-you-get-started)
21-
- [Sign the CLA](#sign-the-cla)
22-
- [Code of Conduct](#code-of-conduct)
23-
- [Setting up your development environment](#setting-up-your-development-environment)
24-
- [Community Expectations and Roles](#community-expectations-and-roles)
20+
- [Before you get started](before-get-started.md)
2521
- [Your First Contribution](first-contribution.md)
2622
- [Contributing](contributing.md)
2723
- [Kubernetes Contributor Playground](#kubernetes-contributor-playground)
@@ -33,28 +29,6 @@ Welcome to Kubernetes!
3329
- [Mentorship](#mentorship)
3430
- [Advanced Topics](#advanced-topics)
3531

36-
# Before you get started
37-
38-
## Sign the CLA
39-
40-
Before you can contribute, you will need to sign the [Contributor License Agreement](/CLA.md).
41-
42-
## Code of Conduct
43-
44-
Please make sure to read and observe our [Code of Conduct](/code-of-conduct.md).
45-
46-
## Setting up your development environment
47-
48-
If you haven’t set up your environment, check the [developer resources](/contributors/devel/README.md#setting-up-your-dev-environment-coding-and-debugging).
49-
50-
## Community Expectations and Roles
51-
52-
Kubernetes is a community project.
53-
Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.
54-
55-
- Read and review the [Community Expectations](expectations.md) for an understanding of code and review expectations.
56-
- See [Community Membership](/community-membership.md) for a list the various responsibilities of contributor roles. You are encouraged to move up this contributor ladder as you gain experience.
57-
5832
# Kubernetes Contributor Playground
5933

6034
If you are looking for a safe place, where you can familiarize yourself with (some of) the Kubernetes Project's review and pull request processes, then the [Kubernetes Contributor Playground](https://github.com/kubernetes-sigs/contributor-playground/) is the right place for you.
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Before you get started"
3+
weight: 2
4+
slug: "before-get-started"
5+
---
6+
7+
# Before you get started
8+
9+
- [Sign the CLA](#sign-the-cla)
10+
- [Code of Conduct](#code-of-conduct)
11+
- [Setting up your development environment](#setting-up-your-development-environment)
12+
- [Community Expectations and Roles](#community-expectations-and-roles)
13+
14+
## Sign the CLA
15+
16+
Before you can contribute, you will need to sign the [Contributor License Agreement](/CLA.md).
17+
18+
## Code of Conduct
19+
20+
Please make sure to read and observe our [Code of Conduct](/code-of-conduct.md).
21+
22+
## Setting up your development environment
23+
24+
If you haven’t set up your environment, check the [developer resources](/contributors/devel/README.md#setting-up-your-dev-environment-coding-and-debugging).
25+
26+
## Community Expectations and Roles
27+
28+
Kubernetes is a community project.
29+
Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.
30+
31+
- Read and review the [Community Expectations](expectations.md) for an understanding of code and review expectations.
32+
- See [Community Membership](/community-membership.md) for a list the various responsibilities of contributor roles. You are encouraged to move up this contributor ladder as you gain experience.

contributors/guide/contributing.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,18 @@ weight: 2
44
slug: "contributing"
55
---
66

7-
8-
- [Contributing](#contributing)
9-
- [Communication](#communication)
10-
- [GitHub workflow](#github-workflow)
11-
- [Open a Pull Request](#open-a-pull-request)
12-
- [Code Review](#code-review)
13-
- [Best Practices](#best-practices)
14-
- [Testing](#testing)
15-
- [Security](#security)
16-
- [Documentation](#documentation)
17-
- [Issues Management or Triage](#issues-management-or-triage)
18-
197
# Contributing
208

9+
- [Communication](#communication)
10+
- [GitHub workflow](#github-workflow)
11+
- [Open a Pull Request](#open-a-pull-request)
12+
- [Code Review](#code-review)
13+
- [Best Practices](#best-practices)
14+
- [Testing](#testing)
15+
- [Security](#security)
16+
- [Documentation](#documentation)
17+
- [Issues Management or Triage](#issues-management-or-triage)
18+
2119
Kubernetes is open source, but many of the people working on it do so as their day job.
2220
In order to avoid forcing people to be "at work" effectively 24/7, we want to establish some semi-formal protocols around development.
2321
Hopefully, these rules make things go more smoothly.

contributors/guide/first-contribution.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ weight: 2
44
slug: "first-contribution"
55
---
66

7+
# Your First Contribution
78

8-
- [Your First Contribution](#your-first-contribution)
9-
- [Find something to work on](#find-something-to-work-on)
10-
- [Find a good first topic](#find-a-good-first-topic)
11-
- [Issue Assignment in Github](#issue-assignment-in-github)
12-
- [Learn about SIGs](#learn-about-sigs)
13-
- [SIG structure](#sig-structure)
14-
- [Find a SIG that is related to your contribution](#find-a-sig-that-is-related-to-your-contribution)
15-
- [SIG-specific contributing guidelines](#sig-specific-contributing-guidelines)
16-
- [File an Issue](#file-an-issue)
9+
- [Find something to work on](#find-something-to-work-on)
10+
- [Find a good first topic](#find-a-good-first-topic)
11+
- [Issue Assignment in Github](#issue-assignment-in-github)
12+
- [Learn about SIGs](#learn-about-sigs)
13+
- [SIG structure](#sig-structure)
14+
- [Find a SIG that is related to your contribution](#find-a-sig-that-is-related-to-your-contribution)
15+
- [SIG-specific contributing guidelines](#sig-specific-contributing-guidelines)
16+
- [File an Issue](#file-an-issue)
1717

18-
# Your First Contribution
1918

2019
Have you ever wanted to contribute to the coolest cloud technology?
2120
We will help you understand the organization of the Kubernetes project and direct you to the best places to get started.

0 commit comments

Comments
 (0)