faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-23 23:33:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Adds link to the under-construction docs site and the new workshop.
This commit is contained in:
Alex Ellis
2018-03-31 13:59:46 +01:00
committed by GitHub
parent b11d7aa42b
commit bdc4f02deb
1 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -91,21 +91,27 @@ Other [Sample functions](https://github.com/openfaas/faas/tree/master/sample-fun
## Documentation ## Documentation
[View our guides](https://github.com/openfaas/faas/tree/master/guide) for documentation, deployment guides and tutorials. We are building a new documentation site at [docs.openfaas.com](http://docs.openfaas.com).
For all other guides, tutorials, trouble-shooting and blog posts head over to our [guides page](https://github.com/openfaas/faas/tree/master/guide) on GitHub.
## Get started with OpenFaaS ## Get started with OpenFaaS
### TestDrive ### Hands-on labs (detailed getting started)
You can learn how to build functions with OpenFaaS using our hands-on labs in the [OpenFaaS workshop](http://github.com/openfaas/workshop).
### TestDrive (classic getting started)
**Kubernetes**
OpenFaaS is Kubernetes-native - you can follow the [deployment guide here](http://docs.openfaas.com/deployment/kubernetes/).
**Docker Swarm** **Docker Swarm**
The deployment guide for Docker Swarm contains a simple one-line command to get you up and running in around 60 seconds. It also includes a set of [sample functions](https://github.com/openfaas/faas/tree/master/sample-functions) which you can use with the TestDrive instructions below. The deployment guide for Docker Swarm contains a simple one-line command to get you up and running in around 60 seconds. It also includes a set of [sample functions](https://github.com/openfaas/faas/tree/master/sample-functions) which you can use with the TestDrive instructions below.
[Deployment guide for Docker Swarm](https://github.com/openfaas/faas/blob/master/guide/deployment_swarm.md) [Deployment guide for Docker Swarm](http://docs.openfaas.com/deployment/docker-swarm/)
**Kubernetes**
OpenFaaS is Kubernetes-native - you can follow the [deployment guide here](https://github.com/openfaas/faas/blob/master/guide/deployment_k8s.md).
The new login feature breaks the one-click deployment to PWD. The new login feature breaks the one-click deployment to PWD.
**Docker Playground** **Docker Playground**
@ -114,7 +120,6 @@ You can quickly start OpenFaaS on Docker Swarm online using the community-run Do
[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/openfaas/faas/master/docker-compose.yml&stack_name=func) [![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/openfaas/faas/master/docker-compose.yml&stack_name=func)
#### Begin the TestDrive #### Begin the TestDrive
* [Begin the TestDrive with Docker Swarm](https://github.com/openfaas/faas/blob/master/TestDrive.md) * [Begin the TestDrive with Docker Swarm](https://github.com/openfaas/faas/blob/master/TestDrive.md)