Skip to content

Commit

Permalink
documentation: remove old docs and restructure (#1430)
Browse files Browse the repository at this point in the history
Removes old, outdated documentation and links to existing docs on https://knative.dev. Restructures some of the documentation directory, moving everything that is not generated out of the `reference` directory.

/kind documentation

Signed-off-by: Lance Ball <lball@redhat.com>

Signed-off-by: Lance Ball <lball@redhat.com>
  • Loading branch information
lance authored Nov 16, 2022
1 parent 148f30a commit 0073106
Show file tree
Hide file tree
Showing 29 changed files with 57 additions and 891 deletions.
37 changes: 7 additions & 30 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# Knative Functions

### Telegram Image Analysis Demo Screencast
[![Telegram Image Analysis Demo Screencast](http://img.youtube.com/vi/CsYo0SmQ0Uk/0.jpg)](https://youtu.be/CsYo0SmQ0Uk "Telegram Image Analysis Demo Screencast")
`func` is a Client Library and CLI for enabling the development of platform-agnostic functions.

`func` is a Client Library and CLI for enabling the development of implicitly deployed, platform agnostic functions.

Functions can be written in the following languages:
Functions can be written in the following languages using built-in templates:

* Go (Golang)
* Node.js (JavaScript)
Expand All @@ -20,33 +17,13 @@ Functions can be deployed on the following platforms:
* OpenShift
* Localhost

<!--
[Quickstart Video]
-->
## Client Installation

[Install the latest CLI](installing_cli.md)

Functions can be created and managed using the CLI interactively, scripted, or by direct integration with the client library. The [Function Developer's Guide](function-developers/developers_guide.md) and examples herein demonstrate the CLI-based approach.

For direct integration using the Go client library, it is advisable to first follow these CLI-based guides to become familiar with creating and deploying software in this way and then proceed to the [Function Integrator's Guide](reference/integrators_guide.md).

## Platform Configuration

[Getting Started with Kubernetes](getting_started_kubernetes.md)
## Function Installation, Development and Integration

[Getting Started on Localhost](getting_started_localhost.md)

Functions are portable between different infrastructure configurations. While your Function itself remains the same, the platform upon which it is deployed will provide different services and guarantees. For instance, a Function deployed to your local host will not autoscale, nor be highly available or externally routable by default. Deploying to a properly configured Kubernetes cluster would however provide these features. There is also variance within infrastructure types. For instance, a small Kubernetes cluster will be limited in the resources which will be ultimately available for allocation to your Function.

## Function Development

[Function Developer's Guide](function-developers/developers_guide.md)

Any code which provides one of a set of supported function signatures can be deployed to any of the supported platforms using this client library. No process boundary code, container, or configuration outside of the function itself is required.
At its most fundamental, a Function is a set of instructions that export a public function whose method signature conforms to one of the supported forms. It is implicitly deployed to a supported platform when created using the client library and can be migrated between platforms without code changes. Runtime execution is handled by the platform, which may offer guarantees such as autoscaling and load balancing.
[Install the latest CLI](https://knative.dev/docs/functions/install-func/)
[Function Quickstart](https://knative.dev/docs/getting-started/about-knative-functions/)
[Function Developer's Guide](https://knative.dev/docs/functions/)
[Function Integrator's Guide](integrators_guide.md).

## Contributing

We are always looking for contributions to the project from the Function Developer community. For more information on how to participate, see the [Contributing Guide](CONTRIBUTING.md)

File renamed without changes.
File renamed without changes.
32 changes: 0 additions & 32 deletions docs/function-developers/developers_guide.md

This file was deleted.

209 changes: 0 additions & 209 deletions docs/function-developers/getting_started.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 0073106

Please sign in to comment.