Skip to content

Commit 5e56c88

Browse files
author
Omer B
authored
Issue 3642 finishing up eventing sanity check (knative#3743)
* Update mkdocs.yml * Update mkdocs.yml * Update mkdocs.yml * bringing back the purple * Revert "bringing back the purple" This reverts commit a6af055. * Removing reference to GKE-specific docs * bash, resolving redirect warning for help * replace all shells with bash across the entire project * style guide conformance * index -> readme * serving link fixes while I'm at it * fix serving links and redirects * lint
1 parent b5bb374 commit 5e56c88

File tree

96 files changed

+669
-695
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+669
-695
lines changed

community/samples/serving/helloworld-clojure/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ folder) you're ready to build and deploy the sample app.
113113
Docker Hub, run these commands replacing `{username}` with your Docker Hub
114114
username:
115115

116-
```shell
116+
```bash
117117
# Build the container on your local machine
118118
docker build -t {username}/helloworld-clojure .
119119
@@ -126,7 +126,7 @@ folder) you're ready to build and deploy the sample app.
126126
in `service.yaml` matches the container you built in the previous step. Apply
127127
the configuration using `kubectl`:
128128

129-
```shell
129+
```bash
130130
kubectl apply --filename service.yaml
131131
```
132132

@@ -148,7 +148,7 @@ folder) you're ready to build and deploy the sample app.
148148
1. Now you can make a request to your app and see the result. Replace
149149
the URL below with the URL returned in the previous command.
150150
151-
```shell
151+
```bash
152152
curl http://helloworld-clojure.default.1.2.3.4.sslip.io
153153
Hello World!
154154
```
@@ -157,6 +157,6 @@ folder) you're ready to build and deploy the sample app.
157157

158158
To remove the sample app from your cluster, delete the service record:
159159

160-
```shell
160+
```bash
161161
kubectl delete --filename service.yaml
162162
```

community/samples/serving/helloworld-dart/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ be created using the following instructions.
4242
2. If you want to run locally, install dependencies. If you only want to run in
4343
Docker or Knative, you can skip this step.
4444
45-
```shell
45+
```bash
4646
> pub get
4747
```
4848

@@ -111,7 +111,7 @@ folder) you're ready to build and deploy the sample app.
111111
Docker Hub, run these commands replacing `{username}` with your Docker Hub
112112
username:
113113

114-
```shell
114+
```bash
115115
# Build the container on your local machine
116116
docker build -t {username}/helloworld-dart .
117117
@@ -124,7 +124,7 @@ folder) you're ready to build and deploy the sample app.
124124
in `service.yaml` matches the container you built in the previous step. Apply
125125
the configuration using `kubectl`:
126126

127-
```shell
127+
```bash
128128
kubectl apply --filename service.yaml
129129
```
130130

@@ -146,7 +146,7 @@ folder) you're ready to build and deploy the sample app.
146146
1. Now you can make a request to your app and see the result. Replace
147147
the URL below with the URL returned in the previous command.
148148
149-
```shell
149+
```bash
150150
curl http://helloworld-dart.default.1.2.3.4.sslip.io
151151
Hello Dart Sample v1
152152
```
@@ -155,6 +155,6 @@ folder) you're ready to build and deploy the sample app.
155155

156156
To remove the sample app from your cluster, delete the service record:
157157

158-
```shell
158+
```bash
159159
kubectl delete --filename service.yaml
160160
```

community/samples/serving/helloworld-deno/index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Follow the steps below to create the sample code and then deploy the app to your
1111
cluster. You can also download a working copy of the sample, by running the
1212
following commands:
1313

14-
```shell
14+
```bash
1515
git clone -b "{{< branch >}}" https://github.com/knative/docs knative-docs
1616
cd knative-docs/docs/serving/samples/hello-world/helloworld-deno
1717
```
@@ -87,7 +87,7 @@ folder) you're ready to build and deploy the sample app.
8787
Docker Hub, run these commands replacing `{username}` with your Docker Hub
8888
username:
8989

90-
```shell
90+
```bash
9191
# Build the container on your local machine
9292
docker build -t {username}/helloworld-deno .
9393
@@ -100,7 +100,7 @@ folder) you're ready to build and deploy the sample app.
100100
in `service.yaml` matches the container you built in the previous step. Apply
101101
the configuration using `kubectl`:
102102

103-
```shell
103+
```bash
104104
kubectl apply --filename service.yaml
105105
```
106106

@@ -113,27 +113,27 @@ folder) you're ready to build and deploy the sample app.
113113

114114
1. Run the following command to find the domain URL for your service:
115115

116-
```shell
116+
```bash
117117
kubectl get ksvc helloworld-deno --output=custom-columns=NAME:.metadata.name,URL:.status.url
118118
```
119119

120120
Example:
121121

122-
```shell
122+
```bash
123123
NAME URL
124124
helloworld-deno http://helloworld-deno.default.1.2.3.4.sslip.io
125125
```
126126

127127
1. Now you can make a request to your app and see the result. Replace
128128
the URL below with the URL returned in the previous command.
129129

130-
```shell
130+
```bash
131131
curl http://helloworld-deno.default.1.2.3.4.sslip.io
132132
```
133133

134134
Example:
135135

136-
```shell
136+
```bash
137137
curl http://helloworld-deno.default.1.2.3.4.sslip.io
138138
[1] "Hello R Sample v1!"
139139
```
@@ -144,6 +144,6 @@ folder) you're ready to build and deploy the sample app.
144144

145145
To remove the sample app from your cluster, delete the service record:
146146

147-
```shell
147+
```bash
148148
kubectl delete --filename service.yaml
149149
```

community/samples/serving/helloworld-elixir/index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
3030

3131
1. Generate a new project.
3232

33-
```shell
33+
```bash
3434
mix phoenix.new helloelixir
3535
```
3636

@@ -127,7 +127,7 @@ above.
127127
shell of an example on `config/prod.secret.exs.sample` and you can use the
128128
following command to generate a new prod secrets file.
129129

130-
```shell
130+
```bash
131131
SECRET_KEY_BASE=$(elixir -e ":crypto.strong_rand_bytes(48) |> Base.encode64 |> IO.puts")
132132
sed "s|SECRET+KEY+BASE|$SECRET_KEY_BASE|" config/prod.secret.exs.sample >config/prod.secret.exs
133133
```
@@ -136,7 +136,7 @@ above.
136136
Docker Hub, run these commands replacing `{username}` with your Docker Hub
137137
username:
138138

139-
```shell
139+
```bash
140140
# Build the container on your local machine
141141
docker build -t {username}/helloworld-elixir .
142142
@@ -149,7 +149,7 @@ above.
149149
in `service.yaml` matches the container you built in the previous step.
150150
Apply the configuration using `kubectl`:
151151

152-
```shell
152+
```bash
153153
kubectl apply --filename service.yaml
154154
```
155155

@@ -172,7 +172,7 @@ above.
172172
1. Now you can make a request to your app to see the results. Replace
173173
`{IP_ADDRESS}` with the address you see returned in the previous step.
174174

175-
```shell
175+
```bash
176176
curl http://helloworld-elixir.default.1.2.3.4.sslip.io
177177
178178
...
@@ -294,6 +294,6 @@ above.
294294

295295
To remove the sample app from your cluster, delete the service record:
296296

297-
```shell
297+
```bash
298298
kubectl delete --filename service.yaml
299299
```

community/samples/serving/helloworld-haskell/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ folder) you're ready to build and deploy the sample app.
139139
Docker Hub, enter these commands replacing `{username}` with your Docker Hub
140140
username:
141141

142-
```shell
142+
```bash
143143
# Build the container on your local machine
144144
docker build -t {username}/helloworld-haskell .
145145
@@ -152,7 +152,7 @@ folder) you're ready to build and deploy the sample app.
152152
in `service.yaml` matches the container you built in the previous step. Apply
153153
the configuration using `kubectl`:
154154

155-
```shell
155+
```bash
156156
kubectl apply --filename service.yaml
157157
```
158158

@@ -174,7 +174,7 @@ folder) you're ready to build and deploy the sample app.
174174
1. Now you can make a request to your app and see the result. Replace
175175
the URL below with the URL returned in the previous command.
176176

177-
```shell
177+
```bash
178178
curl http://helloworld-haskell.default.1.2.3.4.sslip.io
179179
Hello world: Haskell Sample v1
180180
```
@@ -183,6 +183,6 @@ folder) you're ready to build and deploy the sample app.
183183

184184
To remove the sample app from your cluster, delete the service record:
185185

186-
```shell
186+
```bash
187187
kubectl delete --filename service.yaml
188188
```

community/samples/serving/helloworld-java-micronaut/index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ your sample app to your cluster:
219219
Docker Hub registry. You must replace the `{username}` variables in the
220220
following commands with your Docker Hub username.
221221

222-
```shell
222+
```bash
223223
# Build the container on your local machine
224224
docker build -t {username}/helloworld-java-micronaut .
225225
@@ -230,7 +230,7 @@ your sample app to your cluster:
230230
1. Now that your container image is in the registry, you can deploy it to your
231231
Knative cluster by running the `kubectl apply` command:
232232

233-
```shell
233+
```bash
234234
kubectl apply --filename service.yaml
235235
```
236236

@@ -253,27 +253,27 @@ To verify that your sample app has been successfully deployed:
253253
1. Retrieve the URL for your service, by running the following `kubectl get`
254254
command:
255255

256-
```shell
256+
```bash
257257
kubectl get ksvc helloworld-java-micronaut --output=custom-columns=NAME:.metadata.name,URL:.status.url
258258
```
259259

260260
Example result:
261261

262-
```shell
262+
```bash
263263
NAME URL
264264
helloworld-java-micronaut http://helloworld-java-micronaut.default.1.2.3.4.sslip.io
265265
```
266266

267267
1. Now you can make a request to your app and see the result. Replace
268268
the URL below with the URL returned in the previous command.
269269

270-
```shell
270+
```bash
271271
curl http://helloworld-java-micronaut.default.1.2.3.4.sslip.io
272272
```
273273

274274
Example result:
275275

276-
```shell
276+
```bash
277277
Hello World: Micronaut Sample v1
278278
```
279279

@@ -284,6 +284,6 @@ Congratulations on deploying your sample Java app to Knative!
284284
To remove the sample app from your cluster, run the following `kubectl delete`
285285
command:
286286

287-
```shell
287+
```bash
288288
kubectl delete --filename service.yaml
289289
```

community/samples/serving/helloworld-java-quarkus/index.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ which you update and create the necessary build and configuration files:
5353
1. From the console, create a new empty web project using the Maven archetype
5454
commands:
5555

56-
```shell
56+
```bash
5757
mvn io.quarkus:quarkus-maven-plugin:0.13.3:create \
5858
-DprojectGroupId=com.redhat.developer.demos \
5959
-DprojectArtifactId=helloworld-java-quarkus \
@@ -129,13 +129,13 @@ which you update and create the necessary build and configuration files:
129129
1. Remove `src/main/resources/META-INF/resources/index.html` file since it's
130130
unncessary for this example.
131131

132-
```shell
132+
```bash
133133
rm src/main/resources/META-INF/resources/index.html
134134
```
135135

136136
1. Remove `.dockerignore` file since it's unncessary for this example.
137137

138-
```shell
138+
```bash
139139
rm .dockerignore
140140
```
141141

@@ -206,7 +206,7 @@ which you update and create the necessary build and configuration files:
206206
207207
1. Run the application locally:
208208
209-
```shell
209+
```bash
210210
./mvnw compile quarkus:dev
211211
```
212212

@@ -221,7 +221,7 @@ folder) you're ready to build and deploy the sample app.
221221
Docker Hub, run these commands replacing `{username}` with your Docker Hub
222222
username:
223223

224-
```shell
224+
```bash
225225
# Build the container on your local machine
226226
docker build -t {username}/helloworld-java-quarkus .
227227

@@ -238,7 +238,7 @@ folder) you're ready to build and deploy the sample app.
238238
in `service.yaml` matches the container you built in the previous step. Apply
239239
the configuration using `kubectl`:
240240

241-
```shell
241+
```bash
242242
kubectl apply --filename service.yaml
243243
```
244244

@@ -251,7 +251,7 @@ folder) you're ready to build and deploy the sample app.
251251

252252
1. To find the URL for your service, use
253253

254-
```shell
254+
```bash
255255
kubectl get ksvc helloworld-java-quarkus
256256

257257
NAME URL
@@ -261,7 +261,7 @@ folder) you're ready to build and deploy the sample app.
261261
1. Now you can make a request to your app and see the result. Replace
262262
the URL below with the URL returned in the previous command.
263263

264-
```shell
264+
```bash
265265
curl http://helloworld-java-quarkus.default.1.2.3.4.sslip.io
266266

267267
Namaste Knative World!
@@ -271,6 +271,6 @@ folder) you're ready to build and deploy the sample app.
271271

272272
To remove the sample app from your cluster, delete the service record:
273273

274-
```shell
274+
```bash
275275
kubectl delete --filename service.yaml
276276
```

0 commit comments

Comments
 (0)