Update to docs, examples, and tutorial links (#546)

* Update to docs, examples, and tutorial links

* Added categories to docs index page. Removed icons.

* Update to docs, examples, and tutorial links.
Added categories to docs index page. Removed icons.

* updates to docs upon review
This commit is contained in:
Michael J Williams
2017-12-01 10:53:51 -07:00
committed by Chad Arimura
parent b0b113477d
commit 1aa1618404
4 changed files with 64 additions and 53 deletions

View File

@@ -6,26 +6,28 @@
Fn is an event-driven, open source, [functions-as-a-service](docs/serverless.md) compute Fn is an event-driven, open source, [functions-as-a-service](docs/serverless.md) compute
platform that you can run anywhere. Some of it's key features: platform that you can run anywhere. Some of it's key features:
* Write once * Open Source
* [Any language](docs/faq.md#which-languages-are-supported) * Native Docker: use any Docker container as your Function
* [AWS Lambda format supported](docs/lambda/README.md) * Supports all languages even AWS [Lambda format](docs/lambda/README.md)
* [Run anywhere](docs/faq.md#where-can-i-run-functions) * Run anywhere
* Public, private and hybrid cloud * Public, private and hybrid cloud
* [Import functions directly from Lambda](docs/lambda/import.md) and run them wherever you want * [Import functions directly from Lambda](docs/lambda/import.md) and run them wherever you want
* Easy to use [for developers](docs/README.md#for-developers) * Easy to use for developers
* Easy to manage [for operators](docs/README.md#for-operators) * Easy to manage for operators
* Written in [Go](https://golang.org) * Written in Go
* Simple yet powerful extensibility * Simple yet powerful extensibility
The fastest way to experience Fn is to follow the quickstart below, or you can jump right to our [full documentation](docs/README.md), [API Docs](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/fnproject/fn/master/docs/swagger.yml), or his us up in our [Slack Community](http://slack.fnproject.io)!
## Prequisites
## Quickstart
### Pre-requisites
* Docker 17.05 or later installed and running * Docker 17.05 or later installed and running
* A Docker Hub account ([Docker Hub](https://hub.docker.com/)) (or other Docker-compliant registry) * A Docker Hub account ([Docker Hub](https://hub.docker.com/)) (or other Docker-compliant registry)
* Log Docker into your Docker Hub account: `docker login` * Log Docker into your Docker Hub account: `docker login`
## Quickstart
### Install CLI tool ### Install CLI tool
The command line tool isn't required, but it sure makes things a lot easier. There are a few options to install it: The command line tool isn't required, but it sure makes things a lot easier. There are a few options to install it:
@@ -130,7 +132,8 @@ For more information, see: [https://github.com/fnproject/ui](https://github.com/
## Learn More ## Learn More
* Visit our Functions [Tutorial Series](examples/tutorial/). This tutorial will demonstrate some of the core Fn capabilities through a series of examples. We'll try to show examples in most major languages. This is a great Fn place to start! * With our [Fn Getting Started Series](examples/tutorial/), quickly create Fn Hello World applications in multiple languages. This is a great Fn place to start!
* Visit [Fn tutorials](https://github.com/fnproject/tutorials) for step by step guides to creating apps with Fn . These tutorials range from introductory to more advanced.
* See our [full documentation](docs/README.md) * See our [full documentation](docs/README.md)
* View all of our [examples](/examples) * View all of our [examples](/examples)
* View our [YouTube Channel](https://www.youtube.com/channel/UCo3fJqEGRx9PW_ODXk3b1nw) * View our [YouTube Channel](https://www.youtube.com/channel/UCo3fJqEGRx9PW_ODXk3b1nw)

View File

@@ -4,39 +4,51 @@
If you are a developer using Fn through the API, this section is for you. If you are a developer using Fn through the API, this section is for you.
### Getting Started
* [Quickstart](https://github.com/fnproject/fn) * [Quickstart](https://github.com/fnproject/fn)
* [Usage](usage.md) * [API Reference](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/fnproject/fn/master/docs/swagger.yml)
* [Writing functions](writing.md) * [FAQ](faq.md)
* [Testing functions](testing.md) * [Object Model](developers/model.md)
* [Hot functions](hot-functions.md)
* [Async functions](async.md)
* [Configuration](developers/configs.md) * [Configuration](developers/configs.md)
* [fn (CLI Tool)](https://github.com/fnproject/cli/blob/master/README.md) * [FDKs](developers/clients.md)
* [Function file (func.yaml)](function-file.md)
* [Hot functions](hot-functions.md) * [Hot functions](hot-functions.md)
* [Testing functions](testing.md)
* [Writing functions](writing.md)
### Advanced
* [Open Function Format](function-format.md)
* [Packaging functions](packaging.md)
* [CLI Source](https://github.com/fnproject/cli/)
* [Async functions](async.md) * [Async functions](async.md)
* [Organizing functions into an application](developers/apps.md) * [Organizing functions into an application](developers/apps.md)
* [Function file (func.yaml)](function-file.md)
* [Client Libraries](developers/clients.md)
* [Packaging functions](packaging.md)
* [Open Function Format](function-format.md)
* [API Reference](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/fnproject/fn/master/docs/swagger.yml)
* [Object Model](developers/model.md)
* [FAQ](faq.md)
* [Setting up development environment with Docker compose](./operating/compose.md)
## For Operators ## For Operators
If you are operating Fn, this section is for you. If you are operating Fn, this section is for you.
* [Running in Production Overview](operating/production.md) ### Getting Started
* [Runtime Options](operating/options.md) * [Running in Production](operating/production.md)
* [Databases](operating/databases/README.md)
* [Message Queues](operating/mqs/README.md)
* [UI](operating/ui.md)
* [Logging](operating/logging.md) * [Logging](operating/logging.md)
* [Message Queues](operating/mqs/README.md)
* [Metrics](operating/metrics.md) * [Metrics](operating/metrics.md)
* [Triggers](operating/triggers.md) * [Operating on Windows](operating/windows.md)
* [Runtime Options](operating/options.md)
* [User Interface](operating/ui.md)
### Advanced
* [Extending Fn](operating/extending.md) * [Extending Fn](operating/extending.md)
* [Docker Configuration](operating/docker.md)
* [Operating On Windows](operating/windows.md)
* [Running Fn on Kubernetes](operating/kubernetes/README.md) * [Running Fn on Kubernetes](operating/kubernetes/README.md)
* [Setting up development environment with Docker compose](./operating/compose.md)
* [OpenStack Triggers](operating/triggers.md)
* [Docker Configuration](operating/docker.md)
## Learn More
* [Examples](../examples)
* [Getting Started Series](../examples/tutorial)
* [Tutorials](https://github.com/fnproject/tutorials)

View File

@@ -1,7 +1,9 @@
# Example Functions # Example Functions
This directory has a collection of example functions you can look at to learn more about how to write them or just copy one and build on it to get started faster. This directory has a collection of example functions you can look at to learn more about how to write them or just copy one and build on it to get started faster.
## Tutorial Series ## Learn More
The [Tutorial Series](tutorial/) will demonstrate some of Fn capabilities through a series of exmaples. We'll try to show examples in most major languages. This is a great place to start! * [Documentation](../docs)
* [Getting Started Series](../examples/tutorial)
* [Tutorials](https://github.com/fnproject/tutorials)

View File

@@ -1,31 +1,25 @@
# Tutorial Series # Getting Started Series
Welcome to the Fn Tutorial Series, the best way to get started with Fn and serverless computing. In the following tutorials, we'll gradually introduce many of the key features of Fn. Welcome to the Fn Getting Started Series, the best way to get started with Fn and serverless computing.
## Guided Tour
### Part 1 ## Hello World Examples
Learn the basics about sending data into your function. Choose your language: Learn the basics about sending data into your function. Choose your language:
* [go](hello/go)
* [java](hello/java) * [java](hello/java)
* [go](hello/go)
* [node](hello/node) * [node](hello/node)
* [php](hello/php)
* [python](hello/python) * [python](hello/python)
* [ruby](hello/ruby)
* [rust](hello/rust)
### Part 2 ## Key Examples
Learn how to get parameters from a web request. [Click here](params) * Learn how to get parameters from a web request. [Click here](params)
* Write your first HotFunction (stays alive to minimize latency between requests). [Click here](../../docs/hot-functions.md)
### Part 3 ## Learn More
Write your first HotFunction (stays alive to minimize latency between requests). [Click here](https://github.com/fnproject/fn/tree/master/examples/formats) * [Documentation](../../docs)
* [Examples](..)
## Other Tutorials * [Tutorials](https://github.com/fnproject/tutorials)
* [Introduction to Fn](https://github.com/fnproject/tutorials/tree/master/Introduction)
* [Introduction to Java Fn](https://github.com/fnproject/tutorials/tree/master/JavaFDKIntroduction)