kubernetes / kubernetes/website
Update Deployment concept topic
- Dominant language
- HTML
- Stars
- 5.4k
- Forks
- 15.7k
- Avg merge
- 4d 18h
- Merged PRs (30d)
- 204
Description
**This is a...**
- [x] Feature Request
- [ ] Bug Report
**Proposed Solution:**
Study the rather long Deployment concept topic. The current topic is a mix of conceptual information and examples of specific tasks. Possibly move the task content into one or more Task topics. Then see whether the remaining conceptual content can be streamlined.
~Remove any suggestion that the `containerPort` field causes the container to listen on a certain port. Example alternative: "Open port 80 so that the container can send and accept traffic."~
Introduce the idea that a Pod has an `ownerReference` field. Coordinate this with #12081.
**Page to Update:**
https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
---
_(edited)_
**Include a *fact sheet* for the Deployment and the Deployment controller.** The fact sheet will condense the behavior of the Deployment controller into a concise set of statements about behavior, guarantees, and steady state. Use the Deployment topic as a prototype for how to write a fact sheet. Eventually, advocate for the use of fact sheets in all controller topics.
See https://github.com/kubernetes/website/issues/38682
Contributor guide
Research direction
Start with the Deployment concept topic at https://kubernetes.io/docs/concepts/workloads/controllers/deployment/ and compare its structure with the fact-sheet discussion in issue #38682. Identify which content is conceptual versus task-oriented, then define the revised topic structure, ownerReference coverage coordinated with #12081, and the Deployment and controller fact sheet as done criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100