kubernetes / kubernetes/website

Umbrella Issue: Remove Duplicate Content

Open
#16,091 9 comments 2 reactions 0 assignees View on GitHub
lifecycle/frozen priority/important-longterm sig/docs
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

**This is a Feature Request**

The new [content guidelines](https://kubernetes.io/docs/contribute/style/content-guide/) address duplicate content.

The Kubernetes documentation contains duplicate content in several places. This is an umbrella issue to track removal of that content.

Duplicate content should be removed. Content should be added that points to instructions in external documentation (kubernetes, kubernetes-sigs, CNCF), or a prerequisite added that states what is required (for example, in the case of minikube state that successful installation and configuration of minikube is required).

People working on this issue should be heavy docs contributors or

- [x] Minikube installation and configuration (Issue #15969)
- [x] [Instructions for installing Docker, CRI-O, containerd, and other container runtimes on various operating systems](https://kubernetes.io/docs/setup/production-environment/container-runtimes/); [GitHub](https://github.com/kubernetes/website/edit/master/content/en/docs/setup/production-environment/container-runtimes.md); each of those projects has its own docs
- [x] [ Instructions for installing Kubernetes on production environments using kops](https://kubernetes.io/docs/setup/production-environment/tools/kops/); kops has installation instructions in its [github]((https://github.com/kubernetes/kops) repo so link to those
- [x] [Installing Kubernetes with Kubespray](https://kubernetes.io/docs/setup/production-environment/tools/kubespray/); kubespray has its own [docs](https://kubespray.io) so link to those
- [ ] [Monitor Node Health](https://kubernetes.io/docs/tasks/debug-application-cluster/monitor-node-health/#enable-disable-in-gce-cluster) - this whole page is about the [node-problem-detector](https://github.com/kubernetes/node-problem-detector). The README in the node-problem-detector repo contains explanation, installation, usage and tutorial sections. Some content is similar between the two pages but other sections contain conflicting content for the same concept, such as installation. Contact the code leads and find out which is correct and update docs content accordingly.

/cc @zacharysarah

Contributor guide

Open the contributing guide

Research direction

Start with the Monitor Node Health page, especially the “Enable/Disable in GCE Cluster” section, and compare it with the node-problem-detector repository README. Contact the relevant project leads to resolve conflicting installation and usage guidance. Done means the Kubernetes page no longer duplicates or contradicts the external documentation and points readers to the authoritative instructions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.