kubernetes-sigs / kubernetes-sigs/kustomize

Docs site should integrate Kustomize repo examples

Open
#3,974 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/documentation lifecycle/frozen needs-triage
Dominant language
Go
Stars
12.2k
Forks
2.4k
Avg merge
2d 14h
Merged PRs (30d)
25

Description

We have a lot of great documentation content, particular examples, that only lives in various places in this repo and is not very discoverable. The Docs site should pull examples from the repo, and some of the content should probably move to the site entirely.

/triage accepted
/kind documentation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified in the issue, so start by locating the Docs site and the repository examples it should expose. Done means examples are discoverable through the Docs site and any content selected for migration is moved there, with the resulting documentation checked for completeness.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.