Docs requirements for this project

[kerthcet]

What would you like to be added:

My ideal document should include:

• What the project structure looks like, e.g. what're the core folders for because this project looks quite different with standard kubernetes projects
• How to write my own scheduler plugin
• How to run the custom kube-scheduler with wasm extension
• How to keep up with the upstream kubernetes because we may have to update the proto files regularly
• ...

If possible, we can also have some tutorials for wasm beginners for most of them come from the kubernetes world, I guess so.
This is a long term plans, hope to finish them before the first release.

/kind documentation
/kind help
/priority long-term

Why is this needed:

For the long term healthy growing of the community.

Completion requirements:

This enhancement requires the following artifacts:

• Design doc
• API change
• Docs update

The artifacts should be linked in subsequent comments.

[k8s-ci-robot]

@kerthcet: The label(s) kind/help, priority/long-term cannot be applied, because the repository doesn't have them.

In response to this:

What would you like to be added:

My ideal document should include:

• What the project structure looks like, e.g. what're the core folders for because this project looks quite different with standard kubernetes projects
• How to write my own scheduler plugin
• How to run the custom kube-scheduler with wasm extension
• How to keep up with the upstream kubernetes because we may have to update the proto files regularly
• ...

If possible, we can also have some tutorials for wasm beginners for most of them come from the kubernetes world, I guess so.
This is a long term plans, hope to finish them before the first release.

/kind documentation
/kind help
/priority long-term

Why is this needed:

For the long term healthy growing of the community.

Completion requirements:

This enhancement requires the following artifacts:

• Design doc
• API change
• Docs update

The artifacts should be linked in subsequent comments.

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.

[kerthcet]

/priority important-longterm

[sanposhiho]

/kind design

[k8s-ci-robot]

@sanposhiho: The label(s) kind/design cannot be applied, because the repository doesn't have them.

In response to this:

/kind design

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.

[sanposhiho]

Basically agree with @kerthcet. This issue is kinda too big, so let me break it down to smaller issues:

• [Document/contributor guide] The basic folder architecture
• [Document/user guide] How to write my own scheduler plugin
• [Document/user guide] How to run the custom kube-scheduler with wasm extension
• [Document/user guide] How to maintain your wasm plugins

[sanposhiho]

Close this issue as I created smaller issues, thanks.

/close

[k8s-ci-robot]

@sanposhiho: Closing this issue.

In response to this:

Close this issue as I created smaller issues, thanks.

/close

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.