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

Add user guide #64

Closed
5 of 8 tasks
alculquicondor opened this issue Feb 24, 2022 · 8 comments · Fixed by #177 or #186
Closed
5 of 8 tasks

Add user guide #64

alculquicondor opened this issue Feb 24, 2022 · 8 comments · Fixed by #177 or #186
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.

Comments

@alculquicondor
Copy link
Contributor

alculquicondor commented Feb 24, 2022

/kind feature
/size M

Something more comprehensive that the existing README. Some of the use cases in bit.ly/kueue-apis can be dumped into samples/guides.

If possible, generate some documentation out of the APIs, similar to https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/

Contents (not necessarily each one will be a page, but they could be sections on existing pages).

  • Single CQ setup
  • Multiple flavors
  • Multiple CQ setup (cohorts)
  • Namespace selectors
  • Cohorts
  • Running a Job
  • Configuring RBAC
  • Monitoring usage (kubectl describe)
@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Feb 24, 2022
@ArangoGutierrez
Copy link
Contributor

Could we use github pages? or just a folder with markdown is ok for now?
GitHub pages is easy to manage using prow automation

@ArangoGutierrez
Copy link
Contributor

/kind documentation
/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@ArangoGutierrez:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/kind documentation
/good-first-issue

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.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Mar 20, 2022
@alculquicondor
Copy link
Contributor Author

We can probably start with markdown and move it to github pages when there is some useful content :)

@alculquicondor
Copy link
Contributor Author

I'll start this

/assign

@alculquicondor
Copy link
Contributor Author

I just added in the description a list of things I would like to cover. Anything else?

@ArangoGutierrez
Copy link
Contributor

for a v0.0.1 , we are ok i Think

@ahg-g
Copy link
Contributor

ahg-g commented Apr 5, 2022

one more thing to add to CQ concept is queueing strategy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
4 participants