Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update contrib: building reference docs #18567

Closed
kbhawkey opened this issue Jan 9, 2020 · 4 comments
Closed

update contrib: building reference docs #18567

kbhawkey opened this issue Jan 9, 2020 · 4 comments
Assignees
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@kbhawkey
Copy link
Contributor

kbhawkey commented Jan 9, 2020

This is a Bug Report

Problem
The contrib pages for generating the reference docs are outdated. The required
golang version, the build dependencies, the generated directory structure, and the update-imported-docs script has changed.

Proposed Solution:
Rewrite the contribute pages outlining the changes.

Page to Update:
https://kubernetes.io/docs/contribute/generate-ref-docs/

  • Add a new page which outlines a streamlined approach to building all of the reference doc components.
  • Create another page which details the common setup instructions for generating the
    reference docs without the script (manually setting up the required repositories).
    The supporting reference doc instructions will link to the setup instructions.
@kbhawkey
Copy link
Contributor Author

kbhawkey commented Jan 9, 2020

/assign

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 19, 2020
@kbhawkey
Copy link
Contributor Author

/close

@k8s-ci-robot
Copy link
Contributor

@kbhawkey: Closing this issue.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

3 participants