kubernetes / kubernetes/website
Containerized reference docs generation
- Dominant language
- HTML
- Stars
- 5.4k
- Forks
- 15.7k
- Avg merge
- 4d 18h
- Merged PRs (30d)
- 204
Description
**This is a Feature Request**
**What would you like to be added**
When we generate the reference docs, make it possible to do this with a command similar to:
`docker run registry.k8s.io/tooling/reference-docs-builder:1.34`
or
`podman run registry.k8s.io/tooling/reference-docs-builder:1.34`
(other container runtimes are available)
**Why is this needed**
Based on the parent issue: https://github.com/kubernetes/website/issues/52376
**Comments**
Allen: I would appreciate a bit more contexts on what is current workflow, and do we have any preferred container runtimes(I would prefer docker).
Is it only automation of existing flow, or I need to add additional steps?
@lmktfy and any other stakeholders
Contributor guide
Research direction
Start by reading parent issue #52376 and determine the current reference-docs generation workflow, since this issue does not name files, tests, or an entry point. Clarify the preferred container runtime and whether the request is only to automate the existing flow. Done means the documented workflow supports the requested container command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100