Feature Request: A section that gives a high-level overview of the Kubernetes project (targeted towards new contributors)

kubernetes / contributor-site

Code for kubernetes.dev

https://www.kubernetes.dev

Apache License 2.0

66 stars 149 forks source link

Feature Request: A section that gives a high-level overview of the Kubernetes project (targeted towards new contributors) #285

Closed tahsintunan closed 1 year ago

tahsintunan commented 2 years ago

For new contributors (esp. if they are new to open source projects), understanding such a big codebase may seem daunting. There should be a section that walks us through the codebase and gives us a high-level overview.

The section should go over the following topics:

Codebase Tour: Goes over the project repo and explains how the project is structured
Architecture: Explains the overall architecture of the project (i.e. why things are the way they are)

This section doesn't have to go too deep into the details. Rather, the goal is to give new contributors a high-level view of the project.

tahsintunan commented 2 years ago

/kind feature

k8s-triage-robot commented 2 years ago

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot commented 2 years ago

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

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

/lifecycle rotten

jberkus commented 2 years ago

/remove-lifecycle rotten

This is actually a planned feature for the site, so no reason to close the issue.

k8s-triage-robot commented 2 years ago

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

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

/lifecycle stale

imnmo commented 2 years ago

/remove-lifecycle stale

imnmo commented 2 years ago

/assign

imnmo commented 2 years ago

@mrbobbytables could you help me with this? I know you are creating the new contributor workshop material and I would be happy to add the content here for new contributors.

sftim commented 2 years ago

This is actually a planned feature for the site, so no reason to close the issue.

/lifecycle frozen

imnmo commented 2 years ago

Hi Folks, any help or pointers for this task would be great for me to kick-start. I am still interested in finishing this task.

imnmo commented 1 year ago

Update: I got details to proceed with the architecture. It's a seemingly big issue with a chunk of tasks. I will try to create a task list as I move on. Thanks, @mrbobbytables for the heads up.

imnmo commented 1 year ago

FYI, for folks interested in reviewing this check this rendered content

imnmo commented 1 year ago

/close

k8s-ci-robot commented 1 year ago

@imnmo: Closing this issue.

In response to [this](https://github.com/kubernetes/contributor-site/issues/285#issuecomment-1444002384): >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.