mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
# Fn Documentation
|
|
|
|
## For Developers
|
|
|
|
If you are a developer using Fn through the API, this section is for you.
|
|
|
|
### Getting Started
|
|
|
|
* [Quickstart](https://github.com/fnproject/fn#quickstart)
|
|
* [Function file (func.yaml)](developers/function-file.md)
|
|
* [FDKs](developers/fdks.md)
|
|
* [Config Vars for Functions](developers/configs.md)
|
|
* [Hot functions](developers/hot-functions.md)
|
|
* [Testing functions](developers/testing.md)
|
|
* [Applications - groups of functions](developers/apps.md)
|
|
* [Async functions](developers/async.md)
|
|
* [FAQ](faq.md)
|
|
|
|
### Examples and Tutorials
|
|
|
|
* [Examples](../examples)
|
|
* [Getting Started Series](../examples/tutorial)
|
|
* [Tutorials](https://github.com/fnproject/tutorials)
|
|
|
|
### Advanced
|
|
|
|
* [API Reference](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/fnproject/fn/master/docs/swagger.yml)
|
|
* [API Clients](developers/clients.md)
|
|
* [Open Function Format](developers/function-format.md)
|
|
* [Packaging functions](developers/packaging.md)
|
|
* [CLI Source](https://github.com/fnproject/cli/)
|
|
|
|
## For Operators
|
|
|
|
If you are operating Fn, this section is for you.
|
|
|
|
### Getting Started
|
|
|
|
* [Running in Production](operating/production.md)
|
|
* [Logging](operating/logging.md)
|
|
* [Message Queues](operating/mqs/README.md)
|
|
* [Metrics](operating/metrics.md)
|
|
* [Operating on Windows](operating/windows.md)
|
|
* [Runtime Options](operating/options.md)
|
|
* [User Interface](operating/ui.md)
|
|
* [Private Registries](operating/private_registries.md)
|
|
|
|
### Advanced
|
|
|
|
* [Extending Fn](operating/extending.md)
|
|
* [Kubernetes Helm Chart for Fn](https://github.com/fnproject/fn-helm/)
|
|
* [Setting up development environment with Docker compose](operating/compose.md)
|
|
* [Docker Configuration](operating/docker.md)
|
|
|
|
## For Contributors
|
|
|
|
If you are working on the Fn Project, want to work on it or are creating extensions, this section is for you.
|
|
|
|
* [Writing Extensions](contributors/extensions.md)
|
|
* [Using Annotations](contributors/annotations.md)
|