Skip to content

Modernize upstream reference docs contribution guide#56441

Open
mementovici wants to merge 1 commit into
kubernetes:mainfrom
mementovici:docs-modernize-contribute-upstream-ref-docs
Open

Modernize upstream reference docs contribution guide#56441
mementovici wants to merge 1 commit into
kubernetes:mainfrom
mementovici:docs-modernize-contribute-upstream-ref-docs

Conversation

@mementovici

Copy link
Copy Markdown

Fixes #56385 (A3)

Changes

  • Modernizes contribute-upstream.md setup instructions to use git clone instead of GOPATH-era go get.
  • Removes stale prerequisites such as Go 1.13 and etcd.
  • Clarifies how the kubernetes/kubernetes, reference-docs, and website clones are used in the upstream fix workflow.
  • Keeps the existing fix-content-in-kubernetes/kubernetes flow, including separate source and generated-file commits.
  • Refreshes wording around generated OpenAPI files, branch naming, and pull request steps.

Validation

  • git diff --check
  • git show --check --oneline HEAD

I could not run the full reference-doc generator flow from this environment because go and make are not installed, and the available WSL backend failed to start. I verified the documented upstream script paths through the GitHub API:

  • hack/update-codegen.sh
  • hack/update-openapi-spec.sh
  • staging/src/k8s.io/api/apps/v1/types.go

@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign nate-double-u for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added the language/en Issues or PRs related to English language label Jul 8, 2026
@kubernetes-prow kubernetes-prow Bot requested a review from shannonxtreme July 8, 2026 13:43
@kubernetes-prow kubernetes-prow Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 8, 2026
@netlify

netlify Bot commented Jul 8, 2026

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit f58bfae
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a4e53e1619aca00089079ab
😎 Deploy Preview https://deploy-preview-56441--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Umbrella: Improve and update the generate-ref-docs contributor guide

1 participant