-
Notifications
You must be signed in to change notification settings - Fork 6
Labels
area/GsoCarea/documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Code without docs is of not much use!
This task is part of the Google Summer Of Code work.
Acceptance criteria
- Transform the current docs tutorial entry here into a section
tutorials/writing-policies/typescript, that matches other tutorial sections such as Rust, Go. Under that tutorial add the following pages:- Intro page:
- like https://docs.kubewarden.io/tutorials/writing-policies/go/intro-go, explain the current state-of-the-art Wasm support for Typescript. This includes info about WASI (linking this other page), the README from the policy-sdk-js, and previous content of the intro page.
- List limitations (using WASI, hence only stdin/stdout/stderr, logging through lib capabilities), prerequisites, explain briefly the javy-plugin.
- Creating a validation policy from the js template policy (analogous to https://docs.kubewarden.io/tutorials/writing-policies/go/scaffold)
- Defining policy settings
- Validation log
- End-to-end testing (with kwctl)
- Logging
- Github actions
- Distributing policy
- Intro page:
- See README.md for running it locally.
- The new content should be under
docs/, notvesioned_docs/
Metadata
Metadata
Assignees
Labels
area/GsoCarea/documentationImprovements or additions to documentationImprovements or additions to documentation