From bdc4f02deb0b21ae6d02f381a004827be5425b1b Mon Sep 17 00:00:00 2001 From: Alex Ellis Date: Sat, 31 Mar 2018 13:59:46 +0100 Subject: [PATCH] Update README.md Adds link to the under-construction docs site and the new workshop. --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fb2499ee..ed98f1ec 100644 --- a/README.md +++ b/README.md @@ -91,21 +91,27 @@ Other [Sample functions](https://github.com/openfaas/faas/tree/master/sample-fun ## 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 -### 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** 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) - -**Kubernetes** - -OpenFaaS is Kubernetes-native - you can follow the [deployment guide here](https://github.com/openfaas/faas/blob/master/guide/deployment_k8s.md). +[Deployment guide for Docker Swarm](http://docs.openfaas.com/deployment/docker-swarm/) The new login feature breaks the one-click deployment to PWD. **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) - #### Begin the TestDrive * [Begin the TestDrive with Docker Swarm](https://github.com/openfaas/faas/blob/master/TestDrive.md)