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

Split Pod concept into a simple introduction and further details #38867

Open
shirady opened this issue Jan 10, 2023 · 12 comments
Open

Split Pod concept into a simple introduction and further details #38867

shirady opened this issue Jan 10, 2023 · 12 comments
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. language/en Issues or PRs related to English language priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. refactor Indicates a PR with large refactoring changes e.g. removes files or moves content triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@shirady
Copy link

shirady commented Jan 10, 2023

I think this page needs to be separated, today it includes basic information about pods as well as detailed advanced subjects.

https://k8s.io/docs/concepts/workloads/pods/

This page should include:

  • What is a Pod?
  • Using Pods: Workload resources for managing pods
  • Working with Pods: Pod template
  • any basic information

... all the rest are detailed advanced subjects, and if someone did not know what is a pod, he will hardly understand those details.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jan 10, 2023
@sftim
Copy link
Contributor

sftim commented Jan 10, 2023

/retitle Split Pod concept into a simple introduction and further details
/language en
/label refactor

/triage accepted
/priority important-longterm

Yes, we should.

Before starting work on this please reply here to outline your approach, and check that SIG Docs is happy with the approach you're considering.

This is an important change to get right.

@k8s-ci-robot k8s-ci-robot changed the title Improvement for k8s.io/docs/concepts/workloads/pods/ Split Pod concept into a simple introduction and further details Jan 10, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. refactor Indicates a PR with large refactoring changes e.g. removes files or moves content and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 10, 2023
@devarsh10
Copy link

I would like to contribute to this issue. And would like to seperate begineer concepts and advanced concepts of PODs.
Btw, I'm a begineer in Kubernetes but I'm familiar with pod, deployments, sevice and some of its concepts.

Regards,
Devarsh.

@tengqm
Copy link
Contributor

tengqm commented Feb 18, 2023

@devarsh10 A beginner's feelings are more useful when differentiating basic concepts from advanced concepts.
Feel free to assign this to yourself.

@devarsh10
Copy link

Okay @tengqm.
/assign

@devarsh10
Copy link

I have created rough notes of the points you mentioned.
Please let me know if I am going in right direction or not.

K8s_Pod..pdf

@sftim
Copy link
Contributor

sftim commented Feb 22, 2023

I had a look at the PDF.

I'm afraid that it is a bit hard to understand that's in that fil;e, as the language isn't clear (it's not the kind of English that people speak around me).

I'm worried that I can't work out the intent you have here @devash10, and so it's not easy to confirm that you're going in the right direction.

@devarsh10
Copy link

Hey all,
I am sorry for the delayed response.
I had created the notes.
I am attaching a PDF. Please consider reviewing it.

Pod Notes

Regards.

@sftim
Copy link
Contributor

sftim commented Apr 3, 2024

What we'd really like is either an editable document (HackMD, Google Doc) where approvers can make suggestions, or a pull request.

I recommend opening an actual pull request.

@devarsh10
Copy link

Hello @sftim,
I apologize for the delayed response. I have prepared the Google Doc, and here's the link to it -> Link

My plan is to make changes to the Kubernetes Pod documentation once the Google Doc is approved. Here's the link to the section I'll be editing: https://kubernetes.io/docs/concepts/workloads/pods/

Please let me know if you have any suggestions or if you think this approach could be improved.

@sftim sftim pinned this issue Aug 22, 2024
@sftim
Copy link
Contributor

sftim commented Aug 22, 2024

/help

@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Aug 22, 2024
@sftim
Copy link
Contributor

sftim commented Aug 22, 2024

Help, from any contributor, is welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. language/en Issues or PRs related to English language priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. refactor Indicates a PR with large refactoring changes e.g. removes files or moves content triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

5 participants