Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func main() {
}
```

A starter template is available at [`go/get-started/`](go/get-started/main.go). For the full walkthrough, see the [Tutorial](docs/tutorial.md).
A starter template is available at [`go/get-started/`](go/get-started/main.go). For the full walkthrough, see the [Tutorial](https://kpt.dev/guides/krm-functions/tutorial/).

## How It Works

Expand All @@ -71,15 +71,18 @@ The SDK provides two interfaces for implementing functions:
| `fn.Runner` | Transformers, validators | No | Yes |
| `fn.ResourceListProcessor` | Generators, complex functions | Yes | No |

See [Interfaces](docs/interfaces.md) for details and code examples.
See [Interfaces](https://kpt.dev/guides/krm-functions/interfaces/) for details and code examples.

## Documentation

The [KRM Function Developer Guide](https://kpt.dev/guides/krm-functions/) on
kpt.dev is the source of truth for function-authoring documentation.

- [API Reference](https://pkg.go.dev/github.com/kptdev/krm-functions-sdk/go/fn) — Go API docs
- [Tutorial](docs/tutorial.md) — end-to-end function development
- [Interfaces](docs/interfaces.md) — Runner vs ResourceListProcessor
- [Testing](docs/testing.md) — golden test patterns
- [Containerizing](docs/containerizing.md) — building and running function images
- [Tutorial](https://kpt.dev/guides/krm-functions/tutorial/) — end-to-end function development
- [Interfaces](https://kpt.dev/guides/krm-functions/interfaces/) — Runner vs ResourceListProcessor
- [Testing](https://kpt.dev/guides/krm-functions/testing/) — golden test patterns
- [Containerizing](https://kpt.dev/guides/krm-functions/containerizing/) — building and running function images

## Versioning

Expand Down
136 changes: 0 additions & 136 deletions docs/containerizing.md

This file was deleted.

178 changes: 0 additions & 178 deletions docs/interfaces.md

This file was deleted.

Loading