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

Added kueuectl-docs generator. #2540

Merged
merged 1 commit into from
Jul 14, 2024
Merged

Added kueuectl-docs generator. #2540

merged 1 commit into from
Jul 14, 2024

Conversation

mbobrovskyi
Copy link
Contributor

@mbobrovskyi mbobrovskyi commented Jul 5, 2024 •
edited by k8s-ci-robot
Loading

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Added kueuectl-docs generator.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/documentation Categorizes issue or PR as related to documentation. labels Jul 5, 2024
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 5, 2024
@netlify Netlify
Copy link

netlify bot commented Jul 5, 2024 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-kueue canceled.

Name Link
🔨 Latest commit 21cf437
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/66919070e5de6900094495e9

@mbobrovskyi
Copy link
Contributor Author

/cc @trasc

@k8s-ci-robot k8s-ci-robot requested a review from trasc July 5, 2024 15:11
@mbobrovskyi
Copy link
Contributor Author

/test all

@mbobrovskyi mbobrovskyi changed the title Added gen-kueuectldocs. Added kueuectl-docs generator. Jul 5, 2024
@mbobrovskyi mbobrovskyi marked this pull request as ready for review July 8, 2024 09:21
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 8, 2024
@mbobrovskyi mbobrovskyi force-pushed the docs/gen-kueuectldocs branch 3 times, most recently from 6259c21 to 177294b Compare July 8, 2024 10:38
@mbobrovskyi
Copy link
Contributor Author

/assign @trasc

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 9, 2024
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 9, 2024
trasc
trasc reviewed Jul 9, 2024
View reviewed changes
Copy link
Contributor

@trasc trasc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think using https://pkg.go.dev/html/template cam make it a lot easier to follow and maintain the implementation.

cmd/kueuectl-docs/main.go Outdated Show resolved Hide resolved
cmd/kueuectl-docs/generators/doc.go Outdated Show resolved Hide resolved
cmd/kueuectl-docs/generators/doc.go Outdated Show resolved Hide resolved
cmd/kueuectl-docs/generators/doc.go Outdated Show resolved Hide resolved
cmd/kueuectl-docs/generators/doc.go Outdated Show resolved Hide resolved
cmd/kueuectl-docs/generators/doc.go Outdated Show resolved Hide resolved
@mbobrovskyi
Copy link
Contributor Author

/retest

@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 417b99583794dff217991c9e357644b273e76327

@mbobrovskyi
Copy link
Contributor Author

/retest

@mbobrovskyi
Copy link
Contributor Author

/cc @alculquicondor

@alculquicondor
Copy link
Contributor

What is the context here?
What is this based on and where would it output the documentation?

What is the benefit of autogenerating, as opposed to keeping a minimal documentation and directing users to use --help to learn more?

@mbobrovskyi
Copy link
Contributor Author

IIRC we discussed to use minimal documentation, because it's very hard to add all details manually.

I think it can be useful.

  • The documentation will be consistent, so we won't miss something on follow ups.
  • User doesn't need to install CLI to check full documentation.
  • We can also use generator code to generate documentation for kjobctl too.

@mbobrovskyi
Copy link
Contributor Author

/retest

alculquicondor
alculquicondor reviewed Jul 12, 2024
View reviewed changes
Makefile Outdated Show resolved Hide resolved
@alculquicondor
Copy link
Contributor

/approve
/hold for moving the directive

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 12, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, mbobrovskyi

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 12, 2024
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 12, 2024
@k8s-ci-robot k8s-ci-robot requested a review from trasc July 12, 2024 20:22
alculquicondor
alculquicondor reviewed Jul 14, 2024
View reviewed changes
Copy link
Contributor

@alculquicondor alculquicondor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 14, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 14, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 00e3c193870b4c33a3c0abd2ecfd14b7a5771514

@k8s-ci-robot k8s-ci-robot merged commit 6710a9d into kubernetes-sigs:main Jul 14, 2024
16 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.8 milestone Jul 14, 2024
@mbobrovskyi mbobrovskyi deleted the docs/gen-kueuectldocs branch July 15, 2024 04:55
mbobrovskyi added a commit to epam/kubernetes-kueue that referenced this pull request Jul 15, 2024
@mbobrovskyi
Revert "Added kueuectl-docs generator. (kubernetes-sigs#2540)"
809bf2e 
This reverts commit 6710a9d.
@mbobrovskyi mbobrovskyi mentioned this pull request Jul 15, 2024
Merged
k8s-ci-robot pushed a commit that referenced this pull request Jul 15, 2024
@mbobrovskyi
Revert "Added kueuectl-docs generator. (#2540)" (#2611)
32e3c33 
This reverts commit 6710a9d.
@mbobrovskyi
Copy link
Contributor Author

/release-note-edit

NONE

Because it was reverted in in #2611.

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alculquicondor alculquicondor alculquicondor left review comments

@denkensk denkensk Awaiting requested review from denkensk

@mimowo mimowo Awaiting requested review from mimowo

@kerthcet kerthcet Awaiting requested review from kerthcet

@trasc trasc Awaiting requested review from trasc

Assignees

@alculquicondor alculquicondor

@trasc trasc

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
v0.8
Development

Successfully merging this pull request may close these issues.
4 participants
@mbobrovskyi @k8s-ci-robot @alculquicondor @trasc