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

api documentation is not aimed at kubectl users #9753

Closed
erictune opened this issue Jun 12, 2015 · 6 comments
Closed

api documentation is not aimed at kubectl users #9753

erictune opened this issue Jun 12, 2015 · 6 comments
Assignees
@erictune
Labels
area/kubectl kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.

Comments

@erictune
Copy link
Member

We have lots of api documentation in docs/api.md and docs/api-conventions.md. But it is focused
on direct REST access and on how to extend the API.

We need documentation which is for people who:

  • will interact mostly with kubectl
    • gloss over REST/HTTP
  • don't plan on extending the API
    • less prescriptive tone, less design discussion
  • are not thinking about the problem of multiple api versions yet
    • deemphasize the version stuff.
@erictune erictune added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 12, 2015
@erictune
Copy link
Member Author

I'll take an initial pass at this.

@erictune erictune self-assigned this Jun 12, 2015
@erictune erictune mentioned this issue Jun 15, 2015
Merged
@mikedanese mikedanese mentioned this issue Jun 16, 2015
Closed
@saad-ali saad-ali added priority/backlog Higher priority than priority/awaiting-more-evidence. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Jun 18, 2015
@bgrant0607
Copy link
Member

Also sort of relevant: #7257, #5331, #3060

@erictune erictune reopened this Jun 24, 2015
@satnam6502
Copy link
Contributor

Ah, sorry for prematurely closing this issue.

@erictune
Copy link
Member Author

erictune commented Jul 9, 2015

Related to #10966

@bgrant0607
Copy link
Member

cc @caesarxuchao

@erictune
Copy link
Member Author

Fixed by #11357

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

@erictune erictune

Labels
area/kubectl kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@satnam6502 @bgrant0607 @erictune @saad-ali