kubernetes-sigs / kube-scheduler-wasm-extension

All the things to make the scheduler extendable with wasm.
Apache License 2.0
86 stars 17 forks source link

docs: adds RATIONALE.md with section on why TinyGo #28

Closed codefromthecrypt closed 11 months ago

codefromthecrypt commented 11 months ago

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This reverse documents a decision we made about TinyGo.

Which issue(s) this PR fixes:

NONE

Special notes for your reviewer:

documents the most important part of https://github.com/kubernetes-sigs/kube-scheduler-wasm-extension/pull/6

Does this PR introduce a user-facing change?

NONE

What are the benchmark results of this change?

N/A

codefromthecrypt commented 11 months ago

ps you may wonder why have RATIONALE.md vs a separate website etc. For a fast moving project, it is more coherent to have changes self-contained. For example, a decision and its rationale in the same commit ideally. When things settle down, we can easily harvest these docs to a separate web page, if it is required to host them externally. Meanwhile, it encourages documentation of decisions otherwise left to PR comments because the follow-up overhead penalty adds friction and work.

ffromani commented 11 months ago

/cc

codefromthecrypt commented 11 months ago

once this is in, I'll rebase https://github.com/kubernetes-sigs/kube-scheduler-wasm-extension/pull/25 and add the rationale for nottinygc as that is also not intuitive unless you had our experiences.

kerthcet commented 11 months ago

part of https://github.com/kubernetes-sigs/kube-scheduler-wasm-extension/issues/14

k8s-ci-robot commented 11 months ago

[APPROVALNOTIFIER] This PR is APPROVED

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

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: - ~~[OWNERS](https://github.com/kubernetes-sigs/kube-scheduler-wasm-extension/blob/main/OWNERS)~~ [kerthcet] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment