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

Separate resource description from list of resource fields, API Markdown reference generator #188

Closed
kbhawkey opened this issue Dec 20, 2020 · 4 comments

Comments

@kbhawkey
Copy link
Contributor

Possibly add a separator between the top description and the body of the resource (fields). Otherwise, the two lists blend together.

For example, StatefulSet:

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

    * Network: A single stable DNS and hostname.

    * Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

https://deploy-preview-23294--kubernetes-io-master-staging.netlify.app/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1/#StatefulSet

Related to github.com/kubernetes/website#23294

@feloy
Copy link
Contributor

feloy commented Jan 6, 2021

@kbhawkey I think you can close this issue which you resolved with #190

@kbhawkey
Copy link
Contributor Author

kbhawkey commented Jan 6, 2021

👀

@kbhawkey
Copy link
Contributor Author

kbhawkey commented Jan 6, 2021

Sure.
/close

@k8s-ci-robot
Copy link
Contributor

@kbhawkey: Closing this issue.

In response to this:

Sure.
/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
None yet
Projects
None yet
Development

No branches or pull requests

3 participants