Add Community Sample Directory (knative#805)

* Move extra helloworld samples * Add documentation for community samples * Update readmes
ynwssjx · Jan 28, 2019 · 0d4c5c2 · 0d4c5c2
1 parent d206063
commit 0d4c5c2
Show file tree

Hide file tree

Showing 89 changed files with 27 additions and 1 deletion.
diff --git a/community/README.md b/community/README.md
@@ -15,6 +15,7 @@ improving docs, giving talks, etc.
 
 - [Introduction](#introduction)
 - [Knative authors](#knative-authors)
+  - [Authoring samples](#authoring-samples)
 - [Meetings and work groups](#meetings-and-work-groups)
 - [How can I help?](#how-can-i-help)
 - [Questions and issues](#questions-and-issues)
@@ -49,6 +50,24 @@ project was started by Google but has contributions from a growing number of
 industry-leading companies. For a current list of the authors, see
 [Authors](https://github.com/knative/serving/blob/master/AUTHORS).
 
+### Authoring samples
+
+Beyond the official documentation there are endless possibilities for combining
+tools, platforms, languages, and products. By submitting a tutorial you can
+share your experience and help others who are solving similar problems.
+
+Community tutorials are stored in Markdown files on
+[GitHub](./samples/README.md) where they can be reviewed and edited by the
+community.
+
+Please submit a Pull Request to the community sample directory under the
+Knative component that your tutorial highlights -
+[Serving](./samples/serving/), [Eventing](./samples/eventing/),
+or [Build](./samples/build/). A reviewer will be assigned to review your
+submission. They'll work with you to ensure your submission meets the
+[style guide](DOCS-CONTRIBUTING.md), but it helps if you follow it as you
+write your tutorial.
+
 ## Meetings and work groups
 
 Knative has public and recorded bi-weekly community meetings.

diff --git a/community/samples/README.md b/community/samples/README.md
@@ -0,0 +1,7 @@
+# Knative Community Samples
+
+This directory contains Knative sample applications submitted from the community.  
+
+| Sample Name                | Description                | Language(s)                |  
+| -------------------------- | -------------------------- | -------------------------- |
+| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Rust](./serving/helloworld-rust/README.md), [Shell](./serving/helloworld-shell/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) |
diff --git a/...ing/samples/helloworld-clojure/.gitignore → ...les/serving/helloworld-clojure/.gitignore b/...ing/samples/helloworld-clojure/.gitignore → ...les/serving/helloworld-clojure/.gitignore
diff --git a/...ing/samples/helloworld-clojure/Dockerfile → ...les/serving/helloworld-clojure/Dockerfile b/...ing/samples/helloworld-clojure/Dockerfile → ...les/serving/helloworld-clojure/Dockerfile
diff --git a/serving/samples/helloworld-clojure/README.md → ...ples/serving/helloworld-clojure/README.md b/serving/samples/helloworld-clojure/README.md → ...ples/serving/helloworld-clojure/README.md
diff --git a/...ng/samples/helloworld-clojure/project.clj → ...es/serving/helloworld-clojure/project.clj b/...ng/samples/helloworld-clojure/project.clj → ...es/serving/helloworld-clojure/project.clj
diff --git a/...g/samples/helloworld-clojure/service.yaml → ...s/serving/helloworld-clojure/service.yaml b/...g/samples/helloworld-clojure/service.yaml → ...s/serving/helloworld-clojure/service.yaml
diff --git a/...elloworld-clojure/src/helloworld/core.clj → ...elloworld-clojure/src/helloworld/core.clj b/...elloworld-clojure/src/helloworld/core.clj → ...elloworld-clojure/src/helloworld/core.clj
diff --git a/serving/samples/helloworld-dart/Dockerfile → ...amples/serving/helloworld-dart/Dockerfile b/serving/samples/helloworld-dart/Dockerfile → ...amples/serving/helloworld-dart/Dockerfile
diff --git a/serving/samples/helloworld-dart/README.md → ...samples/serving/helloworld-dart/README.md b/serving/samples/helloworld-dart/README.md → ...samples/serving/helloworld-dart/README.md
diff --git a/...g/samples/helloworld-dart/bin/server.dart → ...s/serving/helloworld-dart/bin/server.dart b/...g/samples/helloworld-dart/bin/server.dart → ...s/serving/helloworld-dart/bin/server.dart
diff --git a/serving/samples/helloworld-dart/pubspec.lock → ...ples/serving/helloworld-dart/pubspec.lock b/serving/samples/helloworld-dart/pubspec.lock → ...ples/serving/helloworld-dart/pubspec.lock
diff --git a/serving/samples/helloworld-dart/pubspec.yaml → ...ples/serving/helloworld-dart/pubspec.yaml b/serving/samples/helloworld-dart/pubspec.yaml → ...ples/serving/helloworld-dart/pubspec.yaml
diff --git a/serving/samples/helloworld-dart/service.yaml → ...ples/serving/helloworld-dart/service.yaml b/serving/samples/helloworld-dart/service.yaml → ...ples/serving/helloworld-dart/service.yaml
diff --git a/...g/samples/helloworld-elixir/.gcloudignore → ...s/serving/helloworld-elixir/.gcloudignore b/...g/samples/helloworld-elixir/.gcloudignore → ...s/serving/helloworld-elixir/.gcloudignore
diff --git a/serving/samples/helloworld-elixir/.gitignore → ...ples/serving/helloworld-elixir/.gitignore b/serving/samples/helloworld-elixir/.gitignore → ...ples/serving/helloworld-elixir/.gitignore
diff --git a/serving/samples/helloworld-elixir/Dockerfile → ...ples/serving/helloworld-elixir/Dockerfile b/serving/samples/helloworld-elixir/Dockerfile → ...ples/serving/helloworld-elixir/Dockerfile
diff --git a/serving/samples/helloworld-elixir/README.md → ...mples/serving/helloworld-elixir/README.md b/serving/samples/helloworld-elixir/README.md → ...mples/serving/helloworld-elixir/README.md
diff --git a/...helloworld-elixir/assets/brunch-config.js → ...helloworld-elixir/assets/brunch-config.js b/...helloworld-elixir/assets/brunch-config.js → ...helloworld-elixir/assets/brunch-config.js
diff --git a/...ples/helloworld-elixir/assets/css/app.css → ...ving/helloworld-elixir/assets/css/app.css b/...ples/helloworld-elixir/assets/css/app.css → ...ving/helloworld-elixir/assets/css/app.css
diff --git a/.../helloworld-elixir/assets/css/phoenix.css → .../helloworld-elixir/assets/css/phoenix.css b/.../helloworld-elixir/assets/css/phoenix.css → .../helloworld-elixir/assets/css/phoenix.css
diff --git a/...amples/helloworld-elixir/assets/js/app.js → ...erving/helloworld-elixir/assets/js/app.js b/...amples/helloworld-elixir/assets/js/app.js → ...erving/helloworld-elixir/assets/js/app.js
diff --git a/...les/helloworld-elixir/assets/js/socket.js → ...ing/helloworld-elixir/assets/js/socket.js b/...les/helloworld-elixir/assets/js/socket.js → ...ing/helloworld-elixir/assets/js/socket.js
diff --git a/...les/helloworld-elixir/assets/package.json → ...ing/helloworld-elixir/assets/package.json b/...les/helloworld-elixir/assets/package.json → ...ing/helloworld-elixir/assets/package.json
diff --git a/...lloworld-elixir/assets/static/favicon.ico → ...lloworld-elixir/assets/static/favicon.ico b/...lloworld-elixir/assets/static/favicon.ico → ...lloworld-elixir/assets/static/favicon.ico
diff --git a/...d-elixir/assets/static/images/phoenix.png → ...d-elixir/assets/static/images/phoenix.png b/...d-elixir/assets/static/images/phoenix.png → ...d-elixir/assets/static/images/phoenix.png
diff --git a/...elloworld-elixir/assets/static/robots.txt → ...elloworld-elixir/assets/static/robots.txt b/...elloworld-elixir/assets/static/robots.txt → ...elloworld-elixir/assets/static/robots.txt
diff --git a/...mples/helloworld-elixir/config/config.exs → ...rving/helloworld-elixir/config/config.exs b/...mples/helloworld-elixir/config/config.exs → ...rving/helloworld-elixir/config/config.exs
diff --git a/.../samples/helloworld-elixir/config/dev.exs → .../serving/helloworld-elixir/config/dev.exs b/.../samples/helloworld-elixir/config/dev.exs → .../serving/helloworld-elixir/config/dev.exs
diff --git a/...samples/helloworld-elixir/config/prod.exs → ...serving/helloworld-elixir/config/prod.exs b/...samples/helloworld-elixir/config/prod.exs → ...serving/helloworld-elixir/config/prod.exs
diff --git a/...orld-elixir/config/prod.secret.exs.sample → ...orld-elixir/config/prod.secret.exs.sample b/...orld-elixir/config/prod.secret.exs.sample → ...orld-elixir/config/prod.secret.exs.sample
diff --git a/...samples/helloworld-elixir/config/test.exs → ...serving/helloworld-elixir/config/test.exs b/...samples/helloworld-elixir/config/test.exs → ...serving/helloworld-elixir/config/test.exs
diff --git a/...ng/samples/helloworld-elixir/lib/hello.ex → ...es/serving/helloworld-elixir/lib/hello.ex b/...ng/samples/helloworld-elixir/lib/hello.ex → ...es/serving/helloworld-elixir/lib/hello.ex
diff --git a/...elloworld-elixir/lib/hello/application.ex → ...elloworld-elixir/lib/hello/application.ex b/...elloworld-elixir/lib/hello/application.ex → ...elloworld-elixir/lib/hello/application.ex
diff --git a/...amples/helloworld-elixir/lib/hello_web.ex → ...erving/helloworld-elixir/lib/hello_web.ex b/...amples/helloworld-elixir/lib/hello_web.ex → ...erving/helloworld-elixir/lib/hello_web.ex
diff --git a/...xir/lib/hello_web/channels/user_socket.ex → ...xir/lib/hello_web/channels/user_socket.ex b/...xir/lib/hello_web/channels/user_socket.ex → ...xir/lib/hello_web/channels/user_socket.ex
diff --git a/.../hello_web/controllers/page_controller.ex → .../hello_web/controllers/page_controller.ex b/.../hello_web/controllers/page_controller.ex → .../hello_web/controllers/page_controller.ex
diff --git a/...lloworld-elixir/lib/hello_web/endpoint.ex → ...lloworld-elixir/lib/hello_web/endpoint.ex b/...lloworld-elixir/lib/hello_web/endpoint.ex → ...lloworld-elixir/lib/hello_web/endpoint.ex
diff --git a/...elloworld-elixir/lib/hello_web/gettext.ex → ...elloworld-elixir/lib/hello_web/gettext.ex b/...elloworld-elixir/lib/hello_web/gettext.ex → ...elloworld-elixir/lib/hello_web/gettext.ex
diff --git a/...helloworld-elixir/lib/hello_web/router.ex → ...helloworld-elixir/lib/hello_web/router.ex b/...helloworld-elixir/lib/hello_web/router.ex → ...helloworld-elixir/lib/hello_web/router.ex
diff --git a/...b/hello_web/templates/layout/app.html.eex → ...b/hello_web/templates/layout/app.html.eex b/...b/hello_web/templates/layout/app.html.eex → ...b/hello_web/templates/layout/app.html.eex
diff --git a/...b/hello_web/templates/page/index.html.eex → ...b/hello_web/templates/page/index.html.eex b/...b/hello_web/templates/page/index.html.eex → ...b/hello_web/templates/page/index.html.eex
diff --git a/...ixir/lib/hello_web/views/error_helpers.ex → ...ixir/lib/hello_web/views/error_helpers.ex b/...ixir/lib/hello_web/views/error_helpers.ex → ...ixir/lib/hello_web/views/error_helpers.ex
diff --git a/...-elixir/lib/hello_web/views/error_view.ex → ...-elixir/lib/hello_web/views/error_view.ex b/...-elixir/lib/hello_web/views/error_view.ex → ...-elixir/lib/hello_web/views/error_view.ex
diff --git a/...-elixir/lib/hello_web/views/hello_view.ex → ...-elixir/lib/hello_web/views/hello_view.ex b/...-elixir/lib/hello_web/views/hello_view.ex → ...-elixir/lib/hello_web/views/hello_view.ex
diff --git a/...elixir/lib/hello_web/views/layout_view.ex → ...elixir/lib/hello_web/views/layout_view.ex b/...elixir/lib/hello_web/views/layout_view.ex → ...elixir/lib/hello_web/views/layout_view.ex
diff --git a/...d-elixir/lib/hello_web/views/page_view.ex → ...d-elixir/lib/hello_web/views/page_view.ex b/...d-elixir/lib/hello_web/views/page_view.ex → ...d-elixir/lib/hello_web/views/page_view.ex
diff --git a/serving/samples/helloworld-elixir/mix.exs → ...samples/serving/helloworld-elixir/mix.exs b/serving/samples/helloworld-elixir/mix.exs → ...samples/serving/helloworld-elixir/mix.exs
diff --git a/serving/samples/helloworld-elixir/mix.lock → ...amples/serving/helloworld-elixir/mix.lock b/serving/samples/helloworld-elixir/mix.lock → ...amples/serving/helloworld-elixir/mix.lock
diff --git a/...xir/priv/gettext/en/LC_MESSAGES/errors.po → ...xir/priv/gettext/en/LC_MESSAGES/errors.po b/...xir/priv/gettext/en/LC_MESSAGES/errors.po → ...xir/priv/gettext/en/LC_MESSAGES/errors.po
diff --git a/...helloworld-elixir/priv/gettext/errors.pot → ...helloworld-elixir/priv/gettext/errors.pot b/...helloworld-elixir/priv/gettext/errors.pot → ...helloworld-elixir/priv/gettext/errors.pot
diff --git a/.../samples/helloworld-elixir/rel/config.exs → .../serving/helloworld-elixir/rel/config.exs b/.../samples/helloworld-elixir/rel/config.exs → .../serving/helloworld-elixir/rel/config.exs
diff --git a/...ng/samples/helloworld-elixir/service.yaml → ...es/serving/helloworld-elixir/service.yaml b/...ng/samples/helloworld-elixir/service.yaml → ...es/serving/helloworld-elixir/service.yaml
diff --git a/..._web/controllers/page_controller_test.exs → ..._web/controllers/page_controller_test.exs b/..._web/controllers/page_controller_test.exs → ..._web/controllers/page_controller_test.exs
diff --git a/.../test/hello_web/views/error_view_test.exs → .../test/hello_web/views/error_view_test.exs b/.../test/hello_web/views/error_view_test.exs → .../test/hello_web/views/error_view_test.exs
diff --git a/...test/hello_web/views/layout_view_test.exs → ...test/hello_web/views/layout_view_test.exs b/...test/hello_web/views/layout_view_test.exs → ...test/hello_web/views/layout_view_test.exs
diff --git a/...r/test/hello_web/views/page_view_test.exs → ...r/test/hello_web/views/page_view_test.exs b/...r/test/hello_web/views/page_view_test.exs → ...r/test/hello_web/views/page_view_test.exs
diff --git a/...world-elixir/test/support/channel_case.ex → ...world-elixir/test/support/channel_case.ex b/...world-elixir/test/support/channel_case.ex → ...world-elixir/test/support/channel_case.ex
diff --git a/...lloworld-elixir/test/support/conn_case.ex → ...lloworld-elixir/test/support/conn_case.ex b/...lloworld-elixir/test/support/conn_case.ex → ...lloworld-elixir/test/support/conn_case.ex
diff --git a/...es/helloworld-elixir/test/test_helper.exs → ...ng/helloworld-elixir/test/test_helper.exs b/...es/helloworld-elixir/test/test_helper.exs → ...ng/helloworld-elixir/test/test_helper.exs
diff --git a/...ing/samples/helloworld-haskell/.gitignore → ...les/serving/helloworld-haskell/.gitignore b/...ing/samples/helloworld-haskell/.gitignore → ...les/serving/helloworld-haskell/.gitignore
diff --git a/...ing/samples/helloworld-haskell/Dockerfile → ...les/serving/helloworld-haskell/Dockerfile b/...ing/samples/helloworld-haskell/Dockerfile → ...les/serving/helloworld-haskell/Dockerfile
diff --git a/serving/samples/helloworld-haskell/README.md → ...ples/serving/helloworld-haskell/README.md b/serving/samples/helloworld-haskell/README.md → ...ples/serving/helloworld-haskell/README.md
diff --git a/...ng/samples/helloworld-haskell/app/Main.hs → ...es/serving/helloworld-haskell/app/Main.hs b/...ng/samples/helloworld-haskell/app/Main.hs → ...es/serving/helloworld-haskell/app/Main.hs
diff --git a/...g/samples/helloworld-haskell/package.yaml → ...s/serving/helloworld-haskell/package.yaml b/...g/samples/helloworld-haskell/package.yaml → ...s/serving/helloworld-haskell/package.yaml
diff --git a/...g/samples/helloworld-haskell/service.yaml → ...s/serving/helloworld-haskell/service.yaml b/...g/samples/helloworld-haskell/service.yaml → ...s/serving/helloworld-haskell/service.yaml
diff --git a/...ing/samples/helloworld-haskell/stack.yaml → ...les/serving/helloworld-haskell/stack.yaml b/...ing/samples/helloworld-haskell/stack.yaml → ...les/serving/helloworld-haskell/stack.yaml
diff --git a/serving/samples/helloworld-rust/Cargo.toml → ...amples/serving/helloworld-rust/Cargo.toml b/serving/samples/helloworld-rust/Cargo.toml → ...amples/serving/helloworld-rust/Cargo.toml
diff --git a/serving/samples/helloworld-rust/Dockerfile → ...amples/serving/helloworld-rust/Dockerfile b/serving/samples/helloworld-rust/Dockerfile → ...amples/serving/helloworld-rust/Dockerfile
diff --git a/serving/samples/helloworld-rust/README.md → ...samples/serving/helloworld-rust/README.md b/serving/samples/helloworld-rust/README.md → ...samples/serving/helloworld-rust/README.md
diff --git a/serving/samples/helloworld-rust/service.yaml → ...ples/serving/helloworld-rust/service.yaml b/serving/samples/helloworld-rust/service.yaml → ...ples/serving/helloworld-rust/service.yaml
diff --git a/serving/samples/helloworld-rust/src/main.rs → ...mples/serving/helloworld-rust/src/main.rs b/serving/samples/helloworld-rust/src/main.rs → ...mples/serving/helloworld-rust/src/main.rs
diff --git a/serving/samples/helloworld-shell/Dockerfile → ...mples/serving/helloworld-shell/Dockerfile b/serving/samples/helloworld-shell/Dockerfile → ...mples/serving/helloworld-shell/Dockerfile
diff --git a/serving/samples/helloworld-shell/README.md → ...amples/serving/helloworld-shell/README.md b/serving/samples/helloworld-shell/README.md → ...amples/serving/helloworld-shell/README.md
diff --git a/serving/samples/helloworld-shell/invoke.go → ...amples/serving/helloworld-shell/invoke.go b/serving/samples/helloworld-shell/invoke.go → ...amples/serving/helloworld-shell/invoke.go
diff --git a/serving/samples/helloworld-shell/script.sh → ...amples/serving/helloworld-shell/script.sh b/serving/samples/helloworld-shell/script.sh → ...amples/serving/helloworld-shell/script.sh
diff --git a/...ing/samples/helloworld-shell/service.yaml → ...les/serving/helloworld-shell/service.yaml b/...ing/samples/helloworld-shell/service.yaml → ...les/serving/helloworld-shell/service.yaml
diff --git a/...g/samples/helloworld-swift/.swift-version → ...s/serving/helloworld-swift/.swift-version b/...g/samples/helloworld-swift/.swift-version → ...s/serving/helloworld-swift/.swift-version
diff --git a/serving/samples/helloworld-swift/Dockerfile → ...mples/serving/helloworld-swift/Dockerfile b/serving/samples/helloworld-swift/Dockerfile → ...mples/serving/helloworld-swift/Dockerfile
diff --git a/...ng/samples/helloworld-swift/Package.swift → ...es/serving/helloworld-swift/Package.swift b/...ng/samples/helloworld-swift/Package.swift → ...es/serving/helloworld-swift/Package.swift
diff --git a/serving/samples/helloworld-swift/README.md → ...amples/serving/helloworld-swift/README.md b/serving/samples/helloworld-swift/README.md → ...amples/serving/helloworld-swift/README.md
diff --git a/...world-swift/Sources/HelloSwift/main.swift → ...world-swift/Sources/HelloSwift/main.swift b/...world-swift/Sources/HelloSwift/main.swift → ...world-swift/Sources/HelloSwift/main.swift
diff --git a/...ing/samples/helloworld-swift/service.yaml → ...les/serving/helloworld-swift/service.yaml b/...ing/samples/helloworld-swift/service.yaml → ...les/serving/helloworld-swift/service.yaml
diff --git a/serving/samples/helloworld-vertx/Dockerfile → ...mples/serving/helloworld-vertx/Dockerfile b/serving/samples/helloworld-vertx/Dockerfile → ...mples/serving/helloworld-vertx/Dockerfile
diff --git a/serving/samples/helloworld-vertx/README.md → ...amples/serving/helloworld-vertx/README.md b/serving/samples/helloworld-vertx/README.md → ...amples/serving/helloworld-vertx/README.md
diff --git a/serving/samples/helloworld-vertx/pom.xml → .../samples/serving/helloworld-vertx/pom.xml b/serving/samples/helloworld-vertx/pom.xml → .../samples/serving/helloworld-vertx/pom.xml
diff --git a/...ing/samples/helloworld-vertx/service.yaml → ...les/serving/helloworld-vertx/service.yaml b/...ing/samples/helloworld-vertx/service.yaml → ...les/serving/helloworld-vertx/service.yaml
diff --git a/...va/com/example/helloworld/HelloWorld.java → ...va/com/example/helloworld/HelloWorld.java b/...va/com/example/helloworld/HelloWorld.java → ...va/com/example/helloworld/HelloWorld.java
diff --git a/serving/samples/README.md b/serving/samples/README.md
@@ -7,7 +7,7 @@ more about Knative Serving resources.
 
 | Name                       | Description                                                                                                                                                                                                              |                                                                                                                                                                                                                            Languages                                                                                                                                                                                                                             |
 | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-| Hello World                | A quick introduction that highlights how to deploy an app using Knative Serving.                                                                                                                                         | [C#](helloworld-csharp/README.md), [Clojure](helloworld-clojure/README.md), [Eclipse Vert.x](helloworld-vertx/README.md), [Haskell](helloworld-haskell/README.md), [Go](helloworld-go/README.md), [Java](helloworld-java/README.md), [Kotlin](helloworld-kotlin/README.md), [Node.js](helloworld-nodejs/README.md), [PHP](helloworld-php/README.md), [Python](helloworld-python/README.md), [Ruby](helloworld-ruby/README.md), [Rust](helloworld-rust/README.md) |
+| Hello World                | A quick introduction that highlights how to deploy an app using Knative Serving.                                                                                                                                         | [C#](helloworld-csharp/README.md), [Go](helloworld-go/README.md), [Java](helloworld-java/README.md), [Kotlin](helloworld-kotlin/README.md), [Node.js](helloworld-nodejs/README.md), [PHP](helloworld-php/README.md), [Python](helloworld-python/README.md), [Ruby](helloworld-ruby/README.md) |
 | Advanced Deployment        | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic.                                                                              |                                                                                                                                                                                                                 [YAML](blue-green-deployment.md)                                                                                                                                                                                                                 |
 | Autoscale                  | A demonstration of the autoscaling capabilities of Knative.                                                                                                                                                              |                                                                                                                                                                                                                   [Go](autoscale-go/README.md)                                                                                                                                                                                                                   |
 | Private Repo Build         | An example of deploying a Knative Serving Service using a Github deploy-key and a DockerHub image pull secret.                                                                                                           |                                                                                                                                                                                                              [Go](build-private-repo-go/README.md)                                                                                                                                                                                                               |