Skip to content

Enhance readability of Kubernetes contributor onboarding guide #8152

@henriquesantanati

Description

@henriquesantanati
Contributor

Describe the issue

The current new-contributor-resources is presented as a flat list of instructions and links. While informative, its format could be improved to enhance readability and user experience for new contributors.

The current format of the contributor guide may be overwhelming for newcomers and doesn't effectively highlight the key steps in the onboarding process.

Proposed Solution

Restructure and reformat the contributor guide to improve its readability and effectiveness. This should include:

  1. Adding a clear title/header for the document
  2. Organizing content into logical sections with appropriate subheaders
  3. Using bullet points and numbered lists to break down information
  4. Improving the overall visual hierarchy of the information

Expected Outcome

A more user-friendly and visually organized contributor guide that:

  • Is easier to read and understand at a glance
  • Clearly outlines the steps for getting involved in the Kubernetes community
  • Improves the onboarding experience for new contributors

Activity

added
needs-sigIndicates an issue or PR lacks a `sig/foo` label and requires one.
on Nov 20, 2024
henriquesantanati

henriquesantanati commented on Nov 20, 2024

@henriquesantanati
ContributorAuthor

/sig contributor-experience

added
sig/contributor-experienceCategorizes an issue or PR as relevant to SIG Contributor Experience.
and removed
needs-sigIndicates an issue or PR lacks a `sig/foo` label and requires one.
on Nov 20, 2024
henriquesantanati

henriquesantanati commented on Nov 20, 2024

@henriquesantanati
ContributorAuthor

/sig docs

added
sig/docsCategorizes an issue or PR as relevant to SIG Docs.
on Nov 20, 2024
AmanSarraf

AmanSarraf commented on Dec 2, 2024

@AmanSarraf

/assign

k8s-triage-robot

k8s-triage-robot commented on Mar 2, 2025

@k8s-triage-robot

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

added
lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.
on Mar 2, 2025
henriquesantanati

henriquesantanati commented on Mar 2, 2025

@henriquesantanati
ContributorAuthor

/remove-lifecycle stale

removed
lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.
on Mar 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

sig/contributor-experienceCategorizes an issue or PR as relevant to SIG Contributor Experience.sig/docsCategorizes an issue or PR as relevant to SIG Docs.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Participants

    @k8s-ci-robot@henriquesantanati@k8s-triage-robot@AmanSarraf

    Issue actions

      Enhance readability of Kubernetes contributor onboarding guide · Issue #8152 · kubernetes/community