Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance readability of Kubernetes contributor onboarding guide #8152

Open
henriquesantanati opened this issue Nov 20, 2024 · 2 comments · May be fixed by #8153
Open

Enhance readability of Kubernetes contributor onboarding guide #8152

henriquesantanati opened this issue Nov 20, 2024 · 2 comments · May be fixed by #8153
Labels
sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@henriquesantanati
Copy link

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
@k8s-ci-robot k8s-ci-robot added the needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Nov 20, 2024
@henriquesantanati
Copy link
Author

henriquesantanati commented Nov 20, 2024

/sig contributor-experience

@k8s-ci-robot k8s-ci-robot added sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Nov 20, 2024
@henriquesantanati
Copy link
Author

/sig docs

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants