Skip to content

Commit a4306d4

Browse files
cpitkinalexellis
authored andcommitted
Added $ to all commands, Removed extra cli page and swarm install page
1 parent f355358 commit a4306d4

File tree

8 files changed

+16
-110
lines changed

8 files changed

+16
-110
lines changed

docs/cli/install.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,7 @@ $version = (Invoke-WebRequest "https://api.github.com/repos/openfaas/faas-cli/re
3434

3535
## Build from source
3636

37-
The [contributing guide](../contributing) has instructions for building from source and for configuring a Golang development environment.
37+
The [contributing guide](../contributing) has instructions for building from source and for configuring a Golang development environment.
38+
## Learn about the CLI
39+
40+
[Morning coffee with the OpenFaaS CLI](https://blog.alexellis.io/quickstart-openfaas-cli/)

docs/cli/manage.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/cli/options.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/deployment/docker-swarm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can create a single-host Docker Swarm on your laptop with a single command.
77
This is how you initialize your master node:
88

99
```bash
10-
docker swarm init
10+
$ docker swarm init
1111
```
1212

1313
If you have more than one IP address you may need to pass a string like `--advertise-addr eth0` to this command.
@@ -28,7 +28,7 @@ It's also important to pass the `--advertise-addr` string to any hosts which hav
2828
Clone OpenFaaS and then checkout the latest stable release:
2929

3030
```bash
31-
git clone https://github.com/openfaas/faas && \
31+
$ git clone https://github.com/openfaas/faas && \
3232
cd faas && \
3333
git checkout 0.7.7 && \
3434
./deploy_stack.sh

docs/deployment/kubernetes.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ We have a special guide for minikube here:
2525
Are you using Google Kubernetes Engine (GKE)? You'll need to create an RBAC role with the following command:
2626

2727
```bash
28-
# kubectl create clusterrolebinding "cluster-admin-$(whoami)" \
28+
$ kubectl create clusterrolebinding "cluster-admin-$(whoami)" \
2929
--clusterrole=cluster-admin \
3030
--user="$(gcloud config get-value core/account)"
3131
```
@@ -47,7 +47,7 @@ This step assumes you are running `kubectl` on a master host.
4747
* Clone the code
4848

4949
```bash
50-
git clone https://github.com/openfaas/faas-netes
50+
$ git clone https://github.com/openfaas/faas-netes
5151
```
5252

5353
Deploy a stack with asynchronous functionality provided by NATS Streaming.
@@ -60,7 +60,7 @@ This step assumes you are running `kubectl` on a master host.
6060
* openfaas-fn - for functions
6161

6262
```bash
63-
cd faas-netes && \
63+
$ cd faas-netes && \
6464
kubectl apply -f ./namespaces.yml,./yaml
6565
```
6666

@@ -100,15 +100,15 @@ There are currently no sample functions built into this stack, but we can deploy
100100
* Install the CLI
101101
102102
```bash
103-
curl -sL https://cli.openfaas.com | sudo sh
103+
$ curl -sL https://cli.openfaas.com | sudo sh
104104
```
105105
106106
If you like you can also run the script via a non-root user. Then the faas-cli binary is downloaded to the current working directory instead.
107107
108108
* Then clone some samples to deploy on your cluster.
109109
110110
```bash
111-
git clone https://github.com/openfaas/faas-cli
111+
$ git clone https://github.com/openfaas/faas-cli
112112
```
113113
114114
Edit samples.yml and change your gateway URL from `localhost:8080` to `kubernetes-node-ip:31112` or pass the `--gateway` / `-g` flag to commands.
@@ -124,7 +124,7 @@ There are currently no sample functions built into this stack, but we can deploy
124124
Now deploy the samples:
125125
126126
```bash
127-
faas-cli deploy -f samples.yml
127+
$ faas-cli deploy -f samples.yml
128128
```
129129
130130
!!! info
@@ -137,7 +137,7 @@ There are currently no sample functions built into this stack, but we can deploy
137137
#### List the functions
138138
139139
```bash
140-
faas-cli list -f samples.yml
140+
$ faas-cli list -f samples.yml
141141
142142
or
143143
@@ -181,8 +181,8 @@ Your function will appear after a few seconds and you can click "Invoke"
181181
The function can also be invoked through the CLI:
182182
183183
```bash
184-
echo -n "" | faas-cli invoke --gateway http://kubernetes-ip:31112 nodeinfo
185-
echo -n "verbose" | faas-cli invoke --gateway http://kubernetes-ip:31112 nodeinfo
184+
$ echo -n "" | faas-cli invoke --gateway http://kubernetes-ip:31112 nodeinfo
185+
$ echo -n "verbose" | faas-cli invoke --gateway http://kubernetes-ip:31112 nodeinfo
186186
```
187187
188188

docs/installation/swarm.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

docs/overview/presentations.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ pages:
110110
- Deployment: deployment.md
111111
- Kubernetes: ./deployment/kubernetes.md
112112
- Docker Swarm: ./deployment/docker-swarm.md
113+
- CLI: ./cli/install.md
113114
- Tutorials:
114115
- Workshop: ./tutorials/workshop.md
115116
- Design & Architecture:

0 commit comments

Comments
 (0)