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

Convert all API documentation and examples to v1beta3 #3671

Closed
abonas opened this issue Jan 21, 2015 · 16 comments
Closed

Convert all API documentation and examples to v1beta3 #3671

abonas opened this issue Jan 21, 2015 · 16 comments
Labels
area/api Indicates an issue on api area. area/usability kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Milestone
v1.0

Comments

@abonas
Copy link
Contributor

abonas commented Jan 21, 2015

similar to guestbook intended for v1, v3 also needs example json for all entity types
@bgrant0607
Copy link
Member

Known issue.

Ref #1519

/cc @eparis

@bgrant0607 bgrant0607 changed the title v1beta3 REST api lacks examples in documentation for all entities Convert all API documentation and examples to v1beta3 Jan 21, 2015
@bgrant0607 bgrant0607 added area/api Indicates an issue on api area. kind/documentation Categorizes issue or PR as related to documentation. area/usability priority/backlog Higher priority than priority/awaiting-more-evidence. labels Jan 21, 2015
@bgrant0607 bgrant0607 mentioned this issue Jan 21, 2015
Closed
@thockin thockin mentioned this issue Jan 26, 2015
Closed
@bgrant0607 bgrant0607 mentioned this issue Feb 5, 2015
Closed
@bgrant0607 bgrant0607 added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Feb 5, 2015
@bgrant0607 bgrant0607 modified the milestones: v1.0, Doc Fixit Feb 6, 2015
@ArtfulCoder
Copy link
Contributor

I can convert redis and gce-pd examples to v1beta3

@bgrant0607
Copy link
Member

@sub-mod: Which examples are you working on? We're starting on this as well.

Done: cassandra, guestbook-go, guestbook, hazelcast, liveness

@lavalamp
Copy link
Member

lavalamp commented Mar 4, 2015

I will do the update-demo.

@dchen1107
Copy link
Member

I am starting with example/gce-pd

Edit: Oops, start with kubernetes-namespaces example

@sub-mod
Copy link
Contributor

sub-mod commented Mar 4, 2015

@bgrant0607
I am working on the ones in addons
under examples folder :cassandra, guestbook-go, guestbook, hazelcast, liveness

@bgrant0607
Copy link
Member

Thanks to @lavalamp, we now have a conversion utility (which needs documentation!): #5041.

@dchen1107
Copy link
Member

Converting examples/limitrange now

@dchen1107 dchen1107 mentioned this issue Mar 4, 2015
Merged
@dchen1107
Copy link
Member

doing examples/resourcequota/resource-quota.json

@dchen1107
Copy link
Member

Doing examples/rethinkdb now

@bgrant0607
Copy link
Member

If you are using the conversion tool, please prune the set of fields to those relevant to the example. In particular, no config should contain status.

@ArtfulCoder ArtfulCoder mentioned this issue Mar 4, 2015
Merged
@dchen1107 dchen1107 mentioned this issue Mar 5, 2015
Merged
@bgrant0607 bgrant0607 modified the milestones: v1.0, Doc Fixit Mar 11, 2015
@bgrant0607
Copy link
Member

We'll need to cover v1beta3 in e2e, also. See #5475.

@bgrant0607
Copy link
Member

docs/volumes.md needs to be converted also (#5795)

@bgrant0607 bgrant0607 mentioned this issue Mar 23, 2015
Closed
@bgrant0607 bgrant0607 added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed priority/backlog Higher priority than priority/awaiting-more-evidence. labels Apr 1, 2015
@wojtek-t
Copy link
Member

This is duplicate of #5475

@bgrant0607 bgrant0607 reopened this Apr 10, 2015
@bgrant0607
Copy link
Member

@wojtek-t You meant #6584.

@wojtek-t
Copy link
Member

@bgrant0607 Yes - sorry. I copied the wrong number.

@bgrant0607 bgrant0607 mentioned this issue Apr 17, 2015
Closed
@ty-dc ty-dc mentioned this issue May 18, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/api Indicates an issue on api area. area/usability kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
7 participants
@lavalamp @ArtfulCoder @abonas @sub-mod @bgrant0607 @dchen1107 @wojtek-t