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

cluster_spec.md documentation is quite out of date #1528

Closed
chrislovecnm opened this issue Jan 18, 2017 · 4 comments
Closed

cluster_spec.md documentation is quite out of date #1528

chrislovecnm opened this issue Jan 18, 2017 · 4 comments
Labels
area/documentation
Milestone
1.5.1

Comments

@chrislovecnm
Copy link
Contributor

What is the best way to document out API? Once we have swagger spec, I think we can get some documentation for free. In the mean time: https://github.com/kubernetes/kops/blob/master/docs/cluster_spec.md <- out of date
@chrislovecnm chrislovecnm mentioned this issue Jan 18, 2017
Merged
@justinsb justinsb added this to the 1.5.0 milestone Jan 19, 2017
@krisnova
Copy link
Contributor

This needs to be pulled from code..

Also this brings up the question of versioning our documentation #1583

@krisnova
Copy link
Contributor

Follow up thought..

what if the API machinery could generate docs based on API versions..

@chrislovecnm
Copy link
Contributor Author

K8s is generating this https://kubernetes.io/docs/api-reference/v1.5/ <- we need to figure out how to

@chrislovecnm
Copy link
Contributor Author

Closing this and opening another issue about using the API server to generate docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation
Projects
None yet
Milestone
1.5.1
Development

No branches or pull requests
3 participants
@justinsb @chrislovecnm @krisnova