Kubebuilder: kubernetes docs - coming soon

Created on 14 Nov 2018 · 9Comments · Source: kubernetes-sigs/kubebuilder

Doc issue

The documentation of kubebuilder details how to document the API but unfortunately the command is not yet available

kubebuilder version
Version: version.Version{KubeBuilderVersion:"master", KubernetesVendor:"1.11", GitCommit:"002c18b2eced18628703fe43f41de725daf78b4a", BuildDate:"2018-11-12T21:15:09Z", GoOs:"unknown", GoArch:"unknown"}
kubebuilder docs   
Coming soon.

See code of the command : https://github.com/kubernetes-sigs/kubebuilder/blob/master/cmd/docs.go#L30

kinfeature lifecyclrotten

Source

cmoulliard

Most helpful comment

see also https://github.com/ahmetb/gen-knative-api-reference-docs (basic docs that has a similar goal). We probably want to make sure that we support usecases that it supports (simple to run, can generate markdown, can generate links to main Kubernetes docs, etc)

DirectXMan12 on 3 Jan 2019

👍2

All 9 comments

@pwittrock Any plans for this? What are your thoughts on how to implement this?

jimmidyson on 27 Nov 2018

I am going to implement this feature. 😄

fanzhangio on 13 Dec 2018

👍1

530

API document reference involves create example subcommand. Do we take these subcommand implementation into consideration with docs ?

@droot @pwittrock

fanzhangio on 13 Dec 2018

DirectXMan12 on 3 Jan 2019

👍2

we probably want to move some of the agnostic parts to controller-tools

DirectXMan12 on 3 Jan 2019

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

fejta-bot on 28 Apr 2019

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

fejta-bot on 28 May 2019

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

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

fejta-bot on 27 Jun 2019

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/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.