From 7fc8b990834b4141aa8e3b25f0d52548941da07a Mon Sep 17 00:00:00 2001 From: Michael Williams Date: Thu, 28 Sep 2017 17:47:42 -0600 Subject: [PATCH 1/5] Minor fixes to main README.md --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9f222af40..971411432 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,10 @@ platform that you can run anywhere. Some of it's key features: ## Prequisites * Docker 17.05 or later installed and running -* Logged into Docker Hub (`docker login`) +* A Docker Hub account ([Docker Hub](https://hub.docker.com/)) +* Log Docker into your Docker Hub account + * Linux: `docker login` + * MacOS: Click Docker icon in menu bar. Select **Sign In**. ## Quickstart @@ -27,11 +30,12 @@ platform that you can run anywhere. Some of it's key features: The command line tool isn't required, but it sure makes things a lot easier. There are a few options to install it: -#### 1. Homebrew +#### 1. Homebrew - MacOS If you're on a Mac and use [Homebrew](https://brew.sh/), this one is for you: ```sh +brew update brew install fn ``` @@ -127,7 +131,7 @@ you can update your code and run `fn deploy myapp` again. ## Stay Informed * [Blog](https://medium.com/fnproject) -* [Twitter](https://twitter.com/fnproj) TODO +* [Twitter](https://twitter.com/fnproj) ## Get Involved @@ -137,16 +141,16 @@ you can update your code and run `fn deploy myapp` again. ## User Interface -This is the graphical user interface for Fn. It is currently not buildable. +Check out this graphical user interface for Fn. ```sh -docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" treeder/functions-ui +docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" fnproject/ui ``` -For more information, see: [https://github.com/treeder/functions-ui](https://github.com/treeder/functions-ui) +For more information, see: [https://github.com/fnproject/ui](https://github.com/fnproject/ui) ## Next up ### Check out the [Tutorial Series](examples/tutorial/) - It 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! +It 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! From a3e274105f1f99092742710eb18d529580be985b Mon Sep 17 00:00:00 2001 From: Michael Williams Date: Thu, 28 Sep 2017 18:05:28 -0600 Subject: [PATCH 2/5] Changes to Tutorials README.md to fix broken links --- examples/tutorial/README.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/examples/tutorial/README.md b/examples/tutorial/README.md index ab947e8ae..cbf20b3a4 100644 --- a/examples/tutorial/README.md +++ b/examples/tutorial/README.md @@ -1,15 +1,31 @@ # Tutorial Series -Welcome to the Oracle Functions Tutorial Series, the best way to get started with Oracle Functions and serverless computing. In the following -tutorials, we'll gradually introduce many of the key features of Oracle Functions. +Welcome to the Oracle Functions Tutorial Series, the best way to get started with Oracle Functions and serverless computing. In the following tutorials, we'll gradually introduce many of the key features of Oracle Functions. +## Guided Tour -**[Tutorial 1](examples/tutorial/hello)** -: Learn the basics about sending data into your function +### Part 1 -**[Tutorial 2](examples/tutorial/params)**: Learn how to get parameters from a web request +Learn the basics about sending data into your function. Choose your language: -**[Tutorial 3](examples/tutorial/hotfunctions)**: Write your first HotFunction (stays alive to minimize latency between requests) +* [go](hello/go) +* [java](hello/java) +* [node](hello/node) +* [php](hello/php) +* [python](hello/python) +* [ruby](hello/ruby) +* [rust](helo/rust) -**[Tutorial 4]()**: TBD +### Part 2 + +Learn how to get parameters from a web request. [Click here](params) + +### Part 3 + +Write your first HotFunction (stays alive to minimize latency between requests). [Click here](hotfunctions/http) + +## Oracle Open World Tutorials + +* [Introduction to Fn](https://github.com/fnproject/tutorials/tree/master/Introduction) +* [Introduction to Java Fn](https://github.com/fnproject/tutorials/tree/master/JavaFDKIntroduction) \ No newline at end of file From f8eda190a93bb52571fd59cd6670c2bd386eae84 Mon Sep 17 00:00:00 2001 From: Michael Williams Date: Thu, 28 Sep 2017 18:14:37 -0600 Subject: [PATCH 3/5] Fix broken links in README.md for hello --- examples/tutorial/README.md | 2 +- examples/tutorial/hello/go/README.md | 2 +- examples/tutorial/hello/java/README.md | 2 +- examples/tutorial/hello/node/README.md | 2 +- examples/tutorial/hello/php/README.md | 2 +- examples/tutorial/hello/python/README.md | 2 +- examples/tutorial/hello/ruby/README.md | 2 +- examples/tutorial/hello/rust/README.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/examples/tutorial/README.md b/examples/tutorial/README.md index cbf20b3a4..01475760a 100644 --- a/examples/tutorial/README.md +++ b/examples/tutorial/README.md @@ -15,7 +15,7 @@ Learn the basics about sending data into your function. Choose your language: * [php](hello/php) * [python](hello/python) * [ruby](hello/ruby) -* [rust](helo/rust) +* [rust](hello/rust) ### Part 2 diff --git a/examples/tutorial/hello/go/README.md b/examples/tutorial/hello/go/README.md index c5c4ba269..2709da152 100644 --- a/examples/tutorial/hello/go/README.md +++ b/examples/tutorial/hello/go/README.md @@ -63,4 +63,4 @@ In Go, simply put them all in the `vendor/` directory. # Next Up -## [Tutorial 2: Input Parameters](examples/tutorial/params) +## [Tutorial 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/java/README.md b/examples/tutorial/hello/java/README.md index 8ab0d6fd7..6bb3dde4a 100644 --- a/examples/tutorial/hello/java/README.md +++ b/examples/tutorial/hello/java/README.md @@ -48,4 +48,4 @@ That's it! # Next Up -## [Tutorial 2: Input Parameters](examples/tutorial/params) +## [Tutorial 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/node/README.md b/examples/tutorial/hello/node/README.md index 3871f225a..c03f31b35 100644 --- a/examples/tutorial/hello/node/README.md +++ b/examples/tutorial/hello/node/README.md @@ -77,7 +77,7 @@ request('http://www.google.com', function (error, response, body) { # Next Up -## [Tutorial 2: Input Parameters](examples/tutorial/params) +## [Tutorial 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/php/README.md b/examples/tutorial/hello/php/README.md index 419e05486..46cbd8b84 100644 --- a/examples/tutorial/hello/php/README.md +++ b/examples/tutorial/hello/php/README.md @@ -78,4 +78,4 @@ Open `func.php` to see it in action. # Next Up -## [Tutorial 2: Input Parameters](examples/tutorial/params) +## [Tutorial 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/python/README.md b/examples/tutorial/hello/python/README.md index a6ddd4b16..71f3bdbdf 100644 --- a/examples/tutorial/hello/python/README.md +++ b/examples/tutorial/hello/python/README.md @@ -64,4 +64,4 @@ In Python, we create a [requirements](https://pip.pypa.io/en/stable/user_guide/) # Next Up -## [Tutorial 2: Input Parameters](examples/tutorial/params) +## [Tutorial 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/ruby/README.md b/examples/tutorial/hello/ruby/README.md index acdbf387e..14aa871f6 100644 --- a/examples/tutorial/hello/ruby/README.md +++ b/examples/tutorial/hello/ruby/README.md @@ -79,7 +79,7 @@ Open `func.rb` to see it in action. # Next Up -## [Tutorial 2: Input Parameters](examples/tutorial/params) +## [Tutorial 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/rust/README.md b/examples/tutorial/hello/rust/README.md index 0b6e556d7..7447096c8 100644 --- a/examples/tutorial/hello/rust/README.md +++ b/examples/tutorial/hello/rust/README.md @@ -90,4 +90,4 @@ That's it! # Next Up -## [Tutorial 2: Input Parameters](examples/tutorial/params) +## [Tutorial 2: Input Parameters](../../params) From a036436d4e4a158a462f2b65581112e96b58cf09 Mon Sep 17 00:00:00 2001 From: Michael Williams Date: Thu, 28 Sep 2017 18:19:43 -0600 Subject: [PATCH 4/5] Fix broken links names in README.md for hello --- examples/tutorial/hello/go/README.md | 2 +- examples/tutorial/hello/java/README.md | 2 +- examples/tutorial/hello/node/README.md | 2 +- examples/tutorial/hello/php/README.md | 2 +- examples/tutorial/hello/python/README.md | 2 +- examples/tutorial/hello/ruby/README.md | 2 +- examples/tutorial/hello/rust/README.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/examples/tutorial/hello/go/README.md b/examples/tutorial/hello/go/README.md index 2709da152..2e59ba40c 100644 --- a/examples/tutorial/hello/go/README.md +++ b/examples/tutorial/hello/go/README.md @@ -63,4 +63,4 @@ In Go, simply put them all in the `vendor/` directory. # Next Up -## [Tutorial 2: Input Parameters](../../params) +## [Part 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/java/README.md b/examples/tutorial/hello/java/README.md index 6bb3dde4a..ba4af2c5b 100644 --- a/examples/tutorial/hello/java/README.md +++ b/examples/tutorial/hello/java/README.md @@ -48,4 +48,4 @@ That's it! # Next Up -## [Tutorial 2: Input Parameters](../../params) +## [Part 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/node/README.md b/examples/tutorial/hello/node/README.md index c03f31b35..3fa6650e2 100644 --- a/examples/tutorial/hello/node/README.md +++ b/examples/tutorial/hello/node/README.md @@ -77,7 +77,7 @@ request('http://www.google.com', function (error, response, body) { # Next Up -## [Tutorial 2: Input Parameters](../../params) +## [Part 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/php/README.md b/examples/tutorial/hello/php/README.md index 46cbd8b84..d91f3a6ff 100644 --- a/examples/tutorial/hello/php/README.md +++ b/examples/tutorial/hello/php/README.md @@ -78,4 +78,4 @@ Open `func.php` to see it in action. # Next Up -## [Tutorial 2: Input Parameters](../../params) +## [Part 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/python/README.md b/examples/tutorial/hello/python/README.md index 71f3bdbdf..7ee2f2d8f 100644 --- a/examples/tutorial/hello/python/README.md +++ b/examples/tutorial/hello/python/README.md @@ -64,4 +64,4 @@ In Python, we create a [requirements](https://pip.pypa.io/en/stable/user_guide/) # Next Up -## [Tutorial 2: Input Parameters](../../params) +## [Part 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/ruby/README.md b/examples/tutorial/hello/ruby/README.md index 14aa871f6..5631d293e 100644 --- a/examples/tutorial/hello/ruby/README.md +++ b/examples/tutorial/hello/ruby/README.md @@ -79,7 +79,7 @@ Open `func.rb` to see it in action. # Next Up -## [Tutorial 2: Input Parameters](../../params) +## [Part 2: Input Parameters](../../params) diff --git a/examples/tutorial/hello/rust/README.md b/examples/tutorial/hello/rust/README.md index 7447096c8..4f46b153f 100644 --- a/examples/tutorial/hello/rust/README.md +++ b/examples/tutorial/hello/rust/README.md @@ -90,4 +90,4 @@ That's it! # Next Up -## [Tutorial 2: Input Parameters](../../params) +## [Part 2: Input Parameters](../../params) From 144fb1791c9e16be97ec2090043560fa2ee8f3db Mon Sep 17 00:00:00 2001 From: Michael Williams Date: Fri, 29 Sep 2017 08:50:59 -0600 Subject: [PATCH 5/5] Small fixes after first review --- README.md | 2 +- examples/tutorial/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 971411432..5ec6e2d77 100644 --- a/README.md +++ b/README.md @@ -153,4 +153,4 @@ For more information, see: [https://github.com/fnproject/ui](https://github.com/ ### Check out the [Tutorial Series](examples/tutorial/) -It 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! +The series will demonstrate some of the core Fn capabilities through a series of exmaples. We'll try to show examples in most major languages. This is a great place to start! diff --git a/examples/tutorial/README.md b/examples/tutorial/README.md index 01475760a..24866749f 100644 --- a/examples/tutorial/README.md +++ b/examples/tutorial/README.md @@ -1,7 +1,7 @@ # Tutorial Series -Welcome to the Oracle Functions Tutorial Series, the best way to get started with Oracle Functions and serverless computing. In the following tutorials, we'll gradually introduce many of the key features of Oracle Functions. +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. ## Guided Tour @@ -25,7 +25,7 @@ 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](hotfunctions/http) -## Oracle Open World Tutorials +## Other Tutorials * [Introduction to Fn](https://github.com/fnproject/tutorials/tree/master/Introduction) * [Introduction to Java Fn](https://github.com/fnproject/tutorials/tree/master/JavaFDKIntroduction) \ No newline at end of file