Contributions to Kubernetes

Overview

Technical documentation is a cornerstone of software development, playing a pivotal role in the success of a project. It serves as a comprehensive guide that outlines the architecture, design, functionality, and implementation details of a software system. In the long run, robust technical documentation contributes to maintainability, scalability, and the overall sustainability of a software project, ensuring its continued success and evolution. I firmly believe that no software project can be truly successfully without being backed by a high quality documentation.

Kubernetes Kubernetes is a widely adopted open source project.

A big factor for its success is its rich documentation and the vibrant community contributing to it. Additionally, the Kubernetes documentation is extensively used in the CKAD, CKA and CKS competitive exams offered by the Linux Foundation. So its correctness, quality and accuracy is of paramount importance. I’ve always been an admirer of the Kubernetes documentation, and it led to me being an active contributor to the project.

This page collates all the contributions made by me to the Kubernetes project.

Pull Requests authored by me

Date (dd/mm/yy) PR# (Size) Issue# (Kind) Description Status

09/02/24

45071 (L)

44651 (bug)

Added instructions to access Services and Ingress Resources through a minikube tunnel.

In Review

24/01/24

44875 (XS)

N/A

Corrected the example for kubelet in the code style for command tool and component names.

Merged

21/01/24

44832 (M)

N/A

Added the use of sudo for commands that need elevated permissions in the documentation for Upgrading kubeadm clusters and Upgrading Linux nodes.

Merged

15/01/24

44752 (XS)

44749 (feature)

Improved the tutorial for scaling an application by specifying the command to expose the Deployment

Merged

15/01/24

44748 (XS)

44728 (undefined)

Fixed links related to projection of keys and file permissions in the ConfigMap documentation

Merged

10/01/24

122672 (XS)

122671 (bug)

Updated the Building Kubernetes readme page to reflect the correct link to install Docker Desktop for Mac.[1]

Merged

10/01/24

44693 (XS)

44687 (undefined)

Removed the references to hostPort in the examples for probes as it is against the configuration best practices

In Review

01/01/24

44594 (XS)

40114 (bug)

Improved the wording around Kata containers and OCI runtime spec in the Sandboxing containers section.

In Review

27/12/23

44540 (L)

23101 (feature)

New tutorial - Updating Configuration via a ConfigMap

In Review

14/12/23

44569 (M)

44359 (bug)

Revised the documentation for several Volume Types to align with the CSI Migration Schedule

In Review

13/12/23

44322 (XS)

44321 (bug)

Added a comment in the Upgrading Linux nodes page to specify that the drain and uncordon commands must be executed from one of the controlplane nodes

Merged

08/12/23

44266 (S)

32835 (bug)

Changes to reflect the deprecation of the --pod-manifest-path argument in the Static Pod documentation

Merged

06/12/23

44239 (XS)

40645 (bug)

Added a note about Minikube tunnel for Docker Desktop in the documentation for Running Multiple Instances of Your App

Merged

06/12/23

44234 (S)

43256 (bug)

Improved the Kubernetes basic tutorials on setting up a Minikube cluster

Merged

23/11/23

44050 (S)

44216 (bug)

The Operating etcd clusters for Kubernetes page is improved to use etcdutl commands instead of deprecated etcdctl commands

In Review

04/04/23

40514 (XS)

N/A

Migrated to use the v1beta3 API version of FlowSchema in the Health check concurrency exemption section

Merged

Pull Request reviews

I have assisted in the review for the following pull requests:

Date (dd/mm/yy) PR# (Size) Issue# (Kind) Description Status

11/01/2024

40241 (S)

39638 (bug)

Updating the Contributing to the Upstream Kubernetes Code page

In Review

10/01/24

44683 (XS)

44674 (undefined)

Suggested small grammatical improvement

Merged

19/12/23

44290 (XS)

44190 (bug)

Correction of an unavailable image on this page

Merged

19/12/23

44279 (XS)

44271 (bug)

Comments on this tutorial not working well on arm architecture

Merged


1. Contribution to upstream Kubernetes