New Contributor Course on Kubernetes Contributors

Section 1: Starting Out

Mon, 01 Jan 0001 00:00:00 +0000

Welcome to Kubernetes!

Welcome to the New Contributor course for Kubernetes!

Section 1: Starting Out

Each unit of this course consists of a slideshow and links to resources. Take your time reading the materials, and feel free to reach out to the community with questions.

We look forward to your contributions!

What you are about to learn

This first unit is all about starting out in the Kubernetes community. By the end of this unit, you will:

Section 2: Getting Into GitHub

Mon, 01 Jan 0001 00:00:00 +0000

Section 2: Getting Into GitHub

What you’re about to learn

The first step to being a Kubernetes contributor is getting into GitHub! After this unit, you will:

Understand GitHub capabilities and how Kubernetes uses it
Understand fork and clone and be able to perform these on a repository
Be able to complete the contributor license agreement (CLA) and make a first pull request

What is GitHub?

GitHub is a web service for managing software development with Git.
It provides bug tracking, task management, hosted development environments, continuous integration, and other important features .
GitHub hosts the source code for many open source projects, including Kubernetes.

Working with GitHub is straightforward, but if you are new to it, it can seem complex. We want to make the process as easy as possible for you!

Section 3: Pull Requests

Mon, 01 Jan 0001 00:00:00 +0000

Section 3: Pull Requests

Objectives

This unit will teach you all about how to submit and manage pull requests for the different Kubernetes repositories. By the end of this unit, you will be able to:

Reference and operate in the Kubernetes GitHub workflow
Recognize common bots and their messages
Respond to code comments and test failures

What is a pull request?

Before we start teaching you how to use pull requests, we should tell you what they are!

Section 4: Issues Management and Triage

Mon, 01 Jan 0001 00:00:00 +0000

Section 4: Issues Management/Triage

What you’re about to learn

This unit will help you get started with issue management across the Kubernetes GitHub repositories. By the end, you’ll:

Understand and locate the issues management and triage tags
Know where bugs are reported and how they are triaged
Be able to understand how to prioritize work based on issues
Be able to locate the security response committee for security issues

How does Kubernetes use GitHub issues?

Contributors and end users use issues for a variety of reasons:

Section 5: Getting Started with Kubernetes Development

Mon, 01 Jan 0001 00:00:00 +0000

Section 5: Getting Started with Kubernetes Development

What you’re about to learn

It’s time to set up a development environment so you can build Kubernetes. By end of this unit, you will:

Know the various environments for building and developing Kubernetes
Know where to find the Kubernetes Development Guide

What are your options for a development environment?

There are three primary options, all with their own benefits and drawbacks.

Building Kubernetes with Docker
Building Kubernetes on your local OS and shell environment
Building Kubernetes with GitHub Codespaces

Why build with Docker?

This method uses a containerized build environment. There are some good reasons to use it:

Section 6: Testing

Mon, 01 Jan 0001 00:00:00 +0000

Section 6: Testing

This unit is all about the various types of tests, both automated and manual, in the Kubernetes project.

What you’re about to learn

By the time you’re done with this unit, you’ll:

Be able to locate the requirements for manual testing during development
Be able to respond to the automatic tests of bots for a pull request

Testing Kubernetes is pretty complicated. We will try to make it easy for you, but you might want to start by reading the Development Guide .

Section 7: Code Review

Mon, 01 Jan 0001 00:00:00 +0000

Section 7: Code Review

What you’re about to learn

In this unit, you will learn everything about getting your code contributions to Kubernetes reviewed. By the end of this unit, you will be able to:

Understand the role of code reviews in the lifecycle of a pull request.
Use your SIG process to get a senior contributor to review code for approval.

What is a code review?

A code review is when other developers examine proposed changes and additions to source code.

Section 8: Community

Mon, 01 Jan 0001 00:00:00 +0000

Section 8: Community

What you’re about to learn

It’s time to learn about communication and community among Kubernetes contributors. By the end of this unit, you will:

Understand the size, diversity, and capability of the Kubernetes community
Be able to interact with members productively
When to use email, when to use Slack, when to use GitHub issues, etc.
Know the venues for involvement, including Kubecon and SIG meetings.

How big is the Kubernetes contributor community?

The Kubernetes community has thousands of active contributors.

Section 9: Documentation

Mon, 01 Jan 0001 00:00:00 +0000

Section 9: Documentation

What you’re about to learn

This unit is about documentation, and by the end, you will:

Know where documentation is stored for Kubernetes
Understand the importance of localization
Understand the process and responsibilities for updating documentation
Know who is responsible for documentation
Locate the style guide and other guidance for writing documentation

How is the Kubernetes documentation organized?

The documentation for the Kubernetes project can be divided into a number of categories.

Section 10: Architecture and Enhancements

Mon, 01 Jan 0001 00:00:00 +0000

Section 10: Architecture and Enhancements

What you’re about to learn

We’re getting into the guts of Kubernetes now! After this module, you will:

Be able to locate the architecture documents for Kubernetes
Understand how the different components interact
Know how features and major changes are added to Kubernetes

Where are the architecture documents?

The good news is that the Kubernetes architecture is very well documented.

A great place to start is this overview of Kubernetes components .
You can find the cluster architecture in the Concepts section of the documentation .

What are the components of a Kubernetes cluster?

A Kubernetes deployment is called a cluster. So what is it made of?