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

update(docs): update readme to explain what it is briefly #4

Merged
merged 3 commits into from
May 23, 2023
Merged

update(docs): update readme to explain what it is briefly #4

merged 3 commits into from
May 23, 2023

Conversation

sanposhiho
Copy link
Member

@sanposhiho sanposhiho commented May 16, 2023 •
edited

What type of PR is this?

/kind documentation

What this PR does / why we need it:

update docs to explain what it is briefly

Which issue(s) this PR fixes:

Fixes #3

Special notes for your reviewer:

Does this PR introduce a user-facing change?

No.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 16, 2023
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 16, 2023
@sanposhiho sanposhiho marked this pull request as ready for review May 16, 2023 09:41
@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 May 16, 2023
@sanposhiho sanposhiho mentioned this pull request May 16, 2023
Merged
@sanposhiho
Copy link
Member Author

Sorry, opened it because I wanted to check the bot's behavior. Actually, it's WIP yet.

/hold

@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 May 16, 2023
@sanposhiho
Copy link
Member Author

/kind documentation
/unhold

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels May 16, 2023
kerthcet
kerthcet reviewed May 17, 2023
View reviewed changes
Copy link
Contributor

@kerthcet kerthcet left a comment

Choose a reason for hiding this comment

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

I'm not a native speaker, but I still left some comments for reference.

RELEASE.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
codefromthecrypt
codefromthecrypt approved these changes May 17, 2023
View reviewed changes
Copy link
Contributor

@codefromthecrypt codefromthecrypt left a comment

Choose a reason for hiding this comment

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

I reworked the intro using some hints from the well-reviewed dapr docs which are similar. hope it helps.

https://github.com/dapr/docs/blob/f89c4df19783a68902f093e2637304ecd3a221d2/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-wasm.md

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 20, 2023
@sanposhiho
Copy link
Member Author

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 20, 2023
@sanposhiho
Copy link
Member Author

PTAL @kerthcet @codefromthecrypt

codefromthecrypt
codefromthecrypt reviewed May 20, 2023
View reviewed changes
README.md
- Language SDKs used to build scheduler plugins, compiled to wasm.
- The scheduler plugin which loads and runs wasm plugins

## Motivation
Copy link
Contributor

Choose a reason for hiding this comment

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

here's a rephrase of your motivation in perhaps more natural English:

Today, you can extend the kube-scheduler, but it is non-trivial. To customize the scheduler means writing Go, and a complicated build process. Once you've built your scheduler, you have deployment and configuration work to have your cluster use it. This isn't one time work, as it needs to be redone on every upgrade of your cluster.

This project lowers that tension by making the default scheduler capable of loading custom plugins, compiled to WebAssembly (wasm). This removes the deployment burdens above. It also allows plugins to be written in languages besides Go.

Copy link
Member Author

Choose a reason for hiding this comment

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

Great, I fixed based on your suggestion.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: codefromthecrypt, sanposhiho

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

@sanposhiho
Copy link
Member Author

@kerthcet could you check this one again please?

@kerthcet
Copy link
Contributor

/lgtm
/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 23, 2023
@k8s-ci-robot k8s-ci-robot merged commit f801a88 into kubernetes-sigs:main May 23, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kerthcet kerthcet kerthcet left review comments

@codefromthecrypt codefromthecrypt codefromthecrypt approved these changes

Assignees

@kerthcet kerthcet

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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

have an initial version of the basic docs
4 participants
@sanposhiho @k8s-ci-robot @kerthcet @codefromthecrypt