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

Create API reference doc #169

Closed
ahg-g opened this issue Jul 1, 2024 · 3 comments · Fixed by #171
Closed

Create API reference doc #169

ahg-g opened this issue Jul 1, 2024 · 3 comments · Fixed by #171
Assignees
@zmvictor
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@ahg-g
Copy link
Contributor

ahg-g commented Jul 1, 2024

What would you like to be added:

See kubernetes-sigs/jobset#611 as an example how this was generated for JobSet.

For now, we can add it in a directory named reference under https://github.com/kubernetes-sigs/lws/tree/main/docs

Why is this needed:

So that we can easily reference LWS API fields.
@ahg-g ahg-g added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 1, 2024
@ahg-g
Copy link
Contributor Author

ahg-g commented Jul 1, 2024

/assign

@zmvictor
Copy link
Contributor

zmvictor commented Jul 1, 2024

/assign

@ahg-g
Copy link
Contributor Author

ahg-g commented Jul 1, 2024

/unassign

zmvictor added a commit to zmvictor/lws that referenced this issue Jul 1, 2024
@zmvictor
docs: add LeaderWorkerSet API reference for issues kubernetes-sigs#169
5dc9587
@zmvictor zmvictor mentioned this issue Jul 1, 2024
Merged
zmvictor added a commit to zmvictor/lws that referenced this issue Jul 1, 2024
@zmvictor
docs: add LeaderWorkerSet API reference for issues kubernetes-sigs#169
8a8e0db
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zmvictor zmvictor

Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add LeaderWorkerSet API reference zmvictor/lws
2 participants
@zmvictor @ahg-g