Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Commit

Permalink
updating doc for other providers
Browse files Browse the repository at this point in the history
  • Loading branch information
Christophe Bougère committed Jan 4, 2018
1 parent 61cbeb1 commit 86e13bb
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 12 deletions.
13 changes: 11 additions & 2 deletions docs/providers/azure/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ serverless create --template azure-nodejs --path myService
```

## Options
- `--template` or `-t` The name of one of the available templates. **Required if --template-url is not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template is not present**.
- `--template` or `-t` The name of one of the available templates. **Required if --template-url and --template-path are not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template and --template-path are not present**.
- `--template-path` The local path of your template. **Required if --template and --template-url are not present**.
- `--path` or `-p` The path where the service should be created.
- `--name` or `-n` the name of the service in `serverless.yml`.

Expand Down Expand Up @@ -70,6 +71,14 @@ Serverless will use the already present directory.
Additionally Serverless will rename the service according to the path you
provide. In this example the service will be renamed to `my-new-service`.

### Creating a new service using a local template

```bash
serverless create --template-path path/to/my/template/folder --path path/to/my/service --name my-new-service
```

This will copy the `path/to/my/template/folder` folder into `path/to/my/service` and rename the service to `my-new-service`.

### Create service in new folder using a custom template

```bash
Expand Down
13 changes: 11 additions & 2 deletions docs/providers/google/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ serverless create --template google-nodejs --path my-service

## Options

- `--template` or `-t` The name of one of the available templates. **Required if --template-url is not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template is not present**.
- `--template` or `-t` The name of one of the available templates. **Required if --template-url and --template-path are not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template and --template-path are not present**.
- `--template-path` The local path of your template. **Required if --template and --template-url are not present**.
- `--path` or `-p` The path where the service should be created.
- `--name` or `-n` the name of the service in `serverless.yml`.

Expand Down Expand Up @@ -61,6 +62,14 @@ This example will generate scaffolding for a service with `google` as a provider

Additionally Serverless will rename the service according to the path you provide. In this example the service will be renamed to `my-new-service`.

### Creating a new service using a local template

```bash
serverless create --template-path path/to/my/template/folder --path path/to/my/service --name my-new-service
```

This will copy the `path/to/my/template/folder` folder into `path/to/my/service` and rename the service to `my-new-service`.

### Create service in new folder using a custom template

```bash
Expand Down
13 changes: 11 additions & 2 deletions docs/providers/kubeless/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ serverless create --template kubeless-nodejs --path my-service
```

## Options
- `--template` or `-t` The name of one of the available templates. **Required if --template-url is not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template is not present**.
- `--template` or `-t` The name of one of the available templates. **Required if --template-url and --template-path are not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template and --template-path are not present**.
- `--template-path` The local path of your template. **Required if --template and --template-url are not present**.
- `--path` or `-p` The path where the service should be created.
- `--name` or `-n` the name of the service in `serverless.yml`.

Expand Down Expand Up @@ -73,3 +74,11 @@ serverless create --template kubeless-python --path my-new-service
This example will generate scaffolding for a service with `kubeless` as a provider and `python2.7` as runtime. The scaffolding will be generated in the `my-new-service` directory. This directory will be created if not present. Otherwise Serverless will use the already present directory.

Additionally Serverless will rename the service according to the path you provide. In this example the service will be renamed to `my-new-service`.

### Creating a new service using a local template

```bash
serverless create --template-path path/to/my/template/folder --path path/to/my/service --name my-new-service
```

This will copy the `path/to/my/template/folder` folder into `path/to/my/service` and rename the service to `my-new-service`.
13 changes: 11 additions & 2 deletions docs/providers/openwhisk/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ serverless create --template openwhisk-nodejs --path myService
```

## Options
- `--template` or `-t` The name of one of the available templates. **Required if --template-url is not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template is not present**.
- `--template` or `-t` The name of one of the available templates. **Required if --template-url and --template-path are not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template and --template-path are not present**.
- `--template-path` The local path of your template. **Required if --template and --template-url are not present**.
- `--path` or `-p` The path where the service should be created.
- `--name` or `-n` the name of the service in `serverless.yml`.

Expand Down Expand Up @@ -69,6 +70,14 @@ This example will generate scaffolding for a service with `openwhisk` as a provi

Additionally Serverless will rename the service according to the path you provide. In this example the service will be renamed to `my-new-service`.

### Creating a new service using a local template

```bash
serverless create --template-path path/to/my/template/folder --path path/to/my/service --name my-new-service
```

This will copy the `path/to/my/template/folder` folder into `path/to/my/service` and rename the service to `my-new-service`.

### Create service in new folder using a custom template

```bash
Expand Down
13 changes: 11 additions & 2 deletions docs/providers/spotinst/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ serverless create -t spotinst-nodejs -p myService
```

## Options
- `--template` or `-t` The name of one of the available templates. **Required if --template-url is not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template is not present**.
- `--template` or `-t` The name of one of the available templates. **Required if --template-url and --template-path are not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template and --template-path are not present**.
- `--template-path` The local path of your template. **Required if --template and --template-url are not present**.
- `--path` or `-p` The path where the service should be created.
- `--name` or `-n` the name of the service in `serverless.yml`.

Expand Down Expand Up @@ -70,3 +71,11 @@ serverless create -t spotinst-nodejs -p my-new-service
This example will generate scaffolding for a service with `Spotinst` as a provider and `ruby` as runtime. The scaffolding
will be generated in the `my-new-service` directory. This directory will be created if not present. Otherwise Serverless
will use the already present directory.

### Creating a new service using a local template

```bash
serverless create --template-path path/to/my/template/folder --path path/to/my/service --name my-new-service
```

This will copy the `path/to/my/template/folder` folder into `path/to/my/service` and rename the service to `my-new-service`.
13 changes: 11 additions & 2 deletions docs/providers/webtasks/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ serverless create --template webtasks-nodejs --path my-service

## Options

- `--template` or `-t` The name of one of the available templates. **Required if --template-url is not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template is not present**.
- `--template` or `-t` The name of one of the available templates. **Required if --template-url and --template-path are not present**.
- `--template-url` or `-u` The name of one of the available templates. **Required if --template and --template-path are not present**.
- `--template-path` The local path of your template. **Required if --template and --template-url are not present**.
- `--path` or `-p` The path where the service should be created.
- `--name` or `-n` the name of the service in `serverless.yml`.

Expand Down Expand Up @@ -60,3 +61,11 @@ serverless create --template webtasks-nodejs --path my-new-service
This example will generate scaffolding for a service with `webtasks` as a provider. The scaffolding will be generated in the `my-new-service` directory. This directory will be created if not present. Otherwise Serverless will use the already present directory.

Additionally Serverless will rename the service according to the path you provide. In this example the service will be renamed to `my-new-service`.

### Creating a new service using a local template

```bash
serverless create --template-path path/to/my/template/folder --path path/to/my/service --name my-new-service
```

This will copy the `path/to/my/template/folder` folder into `path/to/my/service` and rename the service to `my-new-service`.

0 comments on commit 86e13bb

Please sign in to comment.