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.

Sign up for GitHub

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

Jump to bottom

Update /docs/contribute/generate-ref-docs #14111

Closed
2 tasks
jimangel opened this issue Apr 30, 2019 · 13 comments
Closed
2 tasks

Update /docs/contribute/generate-ref-docs #14111

jimangel opened this issue Apr 30, 2019 · 13 comments
Assignees
@kbhawkey @tengqm @makoscafee @simplytunde
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone
1.16

Comments

@jimangel
Copy link
Member

jimangel commented Apr 30, 2019 •
edited
Loading

This is a Feature Request

Review https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/ and https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-components/ for technical accuracy. At it's current state it's currently not usable.

What would you like to be added

  • Any references to software versions (like docker / etcd) should be pinned to ensure success
  • Review active steps to generate docs (removing incorrect or irrelevant info)

Why is this needed
To make it easier for the sig-docs release lead to generate ref docs content.

Comments

I can own this, but have some backlog to clear out first before I can get to it. If there's someone who's available now to tackle this sooner, I'm happy to work with you!

/cc @makoscafee @tengqm
@jimangel jimangel added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Apr 30, 2019
@jimangel jimangel added this to the 1.15 milestone Apr 30, 2019
@jimangel jimangel changed the title Update /docs/contribute/generate-ref-docs/kubernetes-api Update /docs/contribute/generate-ref-docs Apr 30, 2019
@tengqm
Copy link
Contributor

tengqm commented May 6, 2019

Ping me if anything I can help.

@SupriyaSirbi
Copy link
Contributor

Hello Jim and Tengqm,

I am interested to work on this issue.

Thanks

@claurence
Copy link

@jimangel - this issue is open on the 1.15 milestone - is this planning to happen in the 1.15 release?

@jimangel
Copy link
Member Author

@claurence - detaching from the milestone to not affect the Docs deadline. I will add to the 1.16 milestone; if not resolved before then. Thanks!

@jimangel jimangel removed this from the 1.15 milestone Jun 11, 2019
@kbhawkey
Copy link
Contributor

Hello. I will update the documentation for generating the API reference and sync up with @jimangel 's cheatsheet. Which format is easier to follow? I am somewhat in favor of the less verbose, task-oriented instructions. Let me know what you think. I will temporarily assign this issue to myself.
/assign @kbhawkey

kbhawkey added a commit to kbhawkey/website that referenced this issue Jun 25, 2019
@kbhawkey
Update api reference contrib doc
f942666 
See issue kubernetes#14111
@kbhawkey kbhawkey mentioned this issue Jun 25, 2019
Merged
@makoscafee makoscafee mentioned this issue Jun 26, 2019
Closed
@jimangel jimangel added this to the 1.16 milestone Jun 26, 2019
@jimangel
Copy link
Member Author

@kbhawkey @tengqm @makoscafee - It sounds like there is work underway to improve process and surrounding documentation, thanks!

@simplytunde - This has been a major issue for the past 2 releases. Please keep up with this discussion and I would strongly encourage you trying to generate the 1.15 docs again (for testing when 1.16 is ready).

kbhawkey added a commit to kbhawkey/website that referenced this issue Jun 26, 2019
@kbhawkey
Update api reference contrib doc
b71e73d 
See issue kubernetes#14111
kbhawkey added a commit to kbhawkey/website that referenced this issue Jul 1, 2019
@kbhawkey
Update api reference contrib doc
9f969d5 
See issue kubernetes#14111
@kbhawkey kbhawkey mentioned this issue Jul 1, 2019
Merged
k8s-ci-robot pushed a commit that referenced this issue Jul 7, 2019
@kbhawkey @k8s-ci-robot
Update api reference contrib doc (#15114)
48e68a9 
* Update api reference contrib doc

See issue #14111

* updates to api ref contrib guide

* further updates to api ref contrib

* more updates api ref contrib
@k8s-ci-robot
Copy link
Contributor

@simplytunde: The provided milestone is not valid for this repository. Milestones in this repository: [1.11, 1.12, 1.15-ja.1, 1.15, 1.16, FMC, Korean translation, KubeCon EU 2019]

Use /milestone clear to clear the milestone.

In response to this:

/milestone 1.17

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.

@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 Dec 18, 2019
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

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 rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jan 17, 2020
@jimangel
Copy link
Member Author

/remove-lifecycle rotten

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jan 19, 2020
@kbhawkey
Copy link
Contributor

Hi @jimangel . Just letting you know that I am working on #18567.

@kbhawkey kbhawkey mentioned this issue Jan 20, 2020
Merged
@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
@jimangel
Copy link
Member Author

/close as @kbhawkey is covering this work under #18567

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

@kbhawkey kbhawkey

@tengqm tengqm

@makoscafee makoscafee

@simplytunde simplytunde

Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Milestone
1.16
Development

No branches or pull requests
9 participants
@kbhawkey @jimangel @tengqm @makoscafee @simplytunde @SupriyaSirbi @claurence @k8s-ci-robot @fejta-bot