Edits to Thumbnailer sample #231
Conversation
google-prow-robot
added
do-not-merge/work-in-progress
google-prow-robot
added
the
size/M
samodell
changed the title
google-prow-robot
removed
the
do-not-merge/work-in-progress
|
/assign @labadav |
| @@ -1,44 +1,55 @@ | |||
| # Thumbnailer Demo | |||
There was a problem hiding this comment.
I think the point of this demo is the ability to bring in the underlying dependencies (e.g. ffmpeg) -- since this is something many platforms don't allow you to do.
Ideally the title (and description) would reflect that scenario.
There was a problem hiding this comment.
Added this to the intro and updated the title; let me know if my wording makes sense!
| @@ -1,44 +1,55 @@ | |||
| # Thumbnailer Demo | |||
|
|
|||
| Thumbnailer demo is a walk-through example on how to deploy a 'dockerized' application to the Knative Serving service. In this demo we will use a sample `golang` application that takes video URL as an input and generates its thumbnail image. | |||
| This is a walk-through example that demonstrates deploying a dockerized | |||
| application to the Knative Serving service. In this demo we will use a sample | |||
There was a problem hiding this comment.
Knative Serving, I'd drop the 'service' since we overload that term already.
|
|
||
| ## Sample Code | ||
| * [Install Knative Serving](../../../install/README.md) | ||
| * [Install Go](https://golang.org/doc/install) (if you want to run and test the sample app locally) |
There was a problem hiding this comment.
You'll also need ffmpeg installed locally.
|
|
||
| ### App code | ||
| In this demo we are going to use a simple `golang` REST app called | ||
| [rester-tester](https://github.com/mchmarny/rester-tester). It's important |
There was a problem hiding this comment.
I don't think we should be linking to non-knative repos. Can we pull the relevant code / configuration into this folder so we don't need to cross-reference?
There was a problem hiding this comment.
Also, we can rename it when we do that to something that fits the scenario.
There was a problem hiding this comment.
So there's a lot going on in Rester Tester: https://github.com/mchmarny/rester-tester
I'm not 100% sure what to copy into this sample repo and what to leave behind. For example, if I were to copy all the files, would I want to bring along the .gcloudignore, .gitignore, and .travis.yml files? And rester-tester also includes the ability to calculate prime numbers; could I leave that folder out since this sample doesn't use that functionality? (Looks like that might require a minor code re-write...) And would we just leave out the original README, in favor of this one? I guess the other option is to keep everything in a subfolder of /thumbnailer-go/...
|
|
||
| To quickly make sure the application is ready, execute the integrated tests | ||
| To make sure the application is ready, run the integrated tests: | ||
|
|
||
| ``` | ||
| go test ./... |
There was a problem hiding this comment.
Will this fail if I don't have ffmpeg installed?
There was a problem hiding this comment.
Rewrote the "before you begin" section to include ffmpeg
| > To make the JSON service responses more readable consider installing [jq](https://stedolan.github.io/jq/), makes JSON pretty | ||
| > To make the JSON service responses more readable, this guide uses | ||
| [jq](https://stedolan.github.io/jq/). If you don't want to install | ||
| it, remove `| jq '.'` from the following commands. | ||
|
|
||
| ### Ping |
google-prow-robot
added
size/L
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: labadav, samodell The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Edit Thumbnailer sample