Skip to content

Commit 1aa1618

Browse files
michael-w-williamscarimura
authored andcommitted
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
1 parent b0b1134 commit 1aa1618

File tree

4 files changed

+64
-53
lines changed

4 files changed

+64
-53
lines changed

README.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,28 @@
66
Fn is an event-driven, open source, [functions-as-a-service](docs/serverless.md) compute
77
platform that you can run anywhere. Some of it's key features:
88

9-
* Write once
10-
* [Any language](docs/faq.md#which-languages-are-supported)
11-
* [AWS Lambda format supported](docs/lambda/README.md)
12-
* [Run anywhere](docs/faq.md#where-can-i-run-functions)
9+
* Open Source
10+
* Native Docker: use any Docker container as your Function
11+
* Supports all languages even AWS [Lambda format](docs/lambda/README.md)
12+
* Run anywhere
1313
* Public, private and hybrid cloud
1414
* [Import functions directly from Lambda](docs/lambda/import.md) and run them wherever you want
15-
* Easy to use [for developers](docs/README.md#for-developers)
16-
* Easy to manage [for operators](docs/README.md#for-operators)
17-
* Written in [Go](https://golang.org)
15+
* Easy to use for developers
16+
* Easy to manage for operators
17+
* Written in Go
1818
* Simple yet powerful extensibility
1919

20+
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)!
2021

21-
## Prequisites
22+
23+
## Quickstart
24+
25+
### Pre-requisites
2226

2327
* Docker 17.05 or later installed and running
2428
* A Docker Hub account ([Docker Hub](https://hub.docker.com/)) (or other Docker-compliant registry)
2529
* Log Docker into your Docker Hub account: `docker login`
2630

27-
## Quickstart
28-
2931
### Install CLI tool
3032

3133
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/
130132

131133
## Learn More
132134

133-
* 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!
135+
* 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!
136+
* 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.
134137
* See our [full documentation](docs/README.md)
135138
* View all of our [examples](/examples)
136139
* View our [YouTube Channel](https://www.youtube.com/channel/UCo3fJqEGRx9PW_ODXk3b1nw)

docs/README.md

+34-22
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,51 @@
44

55
If you are a developer using Fn through the API, this section is for you.
66

7+
### Getting Started
78
* [Quickstart](https://github.com/fnproject/fn)
8-
* [Usage](usage.md)
9-
* [Writing functions](writing.md)
10-
* [Testing functions](testing.md)
11-
* [Hot functions](hot-functions.md)
12-
* [Async functions](async.md)
9+
* [API Reference](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/fnproject/fn/master/docs/swagger.yml)
10+
* [FAQ](faq.md)
11+
* [Object Model](developers/model.md)
1312
* [Configuration](developers/configs.md)
14-
* [fn (CLI Tool)](https://github.com/fnproject/cli/blob/master/README.md)
13+
* [FDKs](developers/clients.md)
14+
* [Function file (func.yaml)](function-file.md)
1515
* [Hot functions](hot-functions.md)
16+
* [Testing functions](testing.md)
17+
* [Writing functions](writing.md)
18+
19+
### Advanced
20+
* [Open Function Format](function-format.md)
21+
* [Packaging functions](packaging.md)
22+
* [CLI Source](https://github.com/fnproject/cli/)
1623
* [Async functions](async.md)
1724
* [Organizing functions into an application](developers/apps.md)
18-
* [Function file (func.yaml)](function-file.md)
19-
* [Client Libraries](developers/clients.md)
20-
* [Packaging functions](packaging.md)
21-
* [Open Function Format](function-format.md)
22-
* [API Reference](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/fnproject/fn/master/docs/swagger.yml)
23-
* [Object Model](developers/model.md)
24-
* [FAQ](faq.md)
25-
* [Setting up development environment with Docker compose](./operating/compose.md)
2625

2726
## For Operators
2827

2928
If you are operating Fn, this section is for you.
3029

31-
* [Running in Production Overview](operating/production.md)
32-
* [Runtime Options](operating/options.md)
33-
* [Databases](operating/databases/README.md)
34-
* [Message Queues](operating/mqs/README.md)
35-
* [UI](operating/ui.md)
30+
### Getting Started
31+
* [Running in Production](operating/production.md)
3632
* [Logging](operating/logging.md)
33+
* [Message Queues](operating/mqs/README.md)
3734
* [Metrics](operating/metrics.md)
38-
* [Triggers](operating/triggers.md)
35+
* [Operating on Windows](operating/windows.md)
36+
* [Runtime Options](operating/options.md)
37+
* [User Interface](operating/ui.md)
38+
39+
### Advanced
3940
* [Extending Fn](operating/extending.md)
40-
* [Docker Configuration](operating/docker.md)
41-
* [Operating On Windows](operating/windows.md)
4241
* [Running Fn on Kubernetes](operating/kubernetes/README.md)
42+
* [Setting up development environment with Docker compose](./operating/compose.md)
43+
* [OpenStack Triggers](operating/triggers.md)
44+
* [Docker Configuration](operating/docker.md)
45+
46+
47+
48+
## Learn More
49+
50+
* [Examples](../examples)
51+
* [Getting Started Series](../examples/tutorial)
52+
* [Tutorials](https://github.com/fnproject/tutorials)
53+
54+

examples/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Example Functions
22

3-
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.
3+
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.
44

5-
## Tutorial Series
5+
## Learn More
66

7-
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!
7+
* [Documentation](../docs)
8+
* [Getting Started Series](../examples/tutorial)
9+
* [Tutorials](https://github.com/fnproject/tutorials)

examples/tutorial/README.md

+11-17
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,25 @@
11

2-
# Tutorial Series
2+
# Getting Started Series
33

4-
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.
4+
Welcome to the Fn Getting Started Series, the best way to get started with Fn and serverless computing.
55

6-
## Guided Tour
76

8-
### Part 1
7+
## Hello World Examples
98

109
Learn the basics about sending data into your function. Choose your language:
1110

12-
* [go](hello/go)
1311
* [java](hello/java)
12+
* [go](hello/go)
1413
* [node](hello/node)
15-
* [php](hello/php)
1614
* [python](hello/python)
17-
* [ruby](hello/ruby)
18-
* [rust](hello/rust)
19-
20-
### Part 2
21-
22-
Learn how to get parameters from a web request. [Click here](params)
2315

24-
### Part 3
16+
## Key Examples
2517

26-
Write your first HotFunction (stays alive to minimize latency between requests). [Click here](https://github.com/fnproject/fn/tree/master/examples/formats)
18+
* Learn how to get parameters from a web request. [Click here](params)
19+
* Write your first HotFunction (stays alive to minimize latency between requests). [Click here](../../docs/hot-functions.md)
2720

28-
## Other Tutorials
21+
## Learn More
2922

30-
* [Introduction to Fn](https://github.com/fnproject/tutorials/tree/master/Introduction)
31-
* [Introduction to Java Fn](https://github.com/fnproject/tutorials/tree/master/JavaFDKIntroduction)
23+
* [Documentation](../../docs)
24+
* [Examples](..)
25+
* [Tutorials](https://github.com/fnproject/tutorials)

0 commit comments

Comments
 (0)