Skip to content

Commit 45a9576

Browse files
rcastleyrcastley
committed
Markdown linting
1 parent c0db558 commit 45a9576

File tree

21 files changed

+527
-80
lines changed

21 files changed

+527
-80
lines changed

‎content/en/imt/dashboards/signalflow.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Also, you can copy the SignalFlow and use it when interacting with the API or wi
3535
![Code](../../images/show-signalflow.png)
3636

3737
{{< tabs >}}
38-
{{% tab name="SignalFlow" lang="python" %}}
38+
{{% tab name="SignalFlow" %}}
3939
```python
4040
A = data('demo.trans.latency', filter=filter('demo_datacenter', 'Paris')).percentile(pct=95).publish(label='A', enable=False)
4141
B = data('demo.trans.latency', filter=filter('demo_datacenter', 'Paris')).percentile(pct=95).timeshift('1w').publish(label='B', enable=False)

‎content/en/imt/gdi/_index.md‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,21 @@ Create the `ACCESS_TOKEN` and `REALM` environment variables to use in the procee
3434

3535
{{< tabs >}}
3636
{{% tab name="Export ACCESS TOKEN" %}}
37+
3738
```bash
3839
export ACCESS_TOKEN="<replace_with_O11y-Workshop-ACCESS_TOKEN>"
3940
```
41+
4042
{{% /tab %}}
4143
{{< /tabs >}}
4244

4345
{{< tabs >}}
4446
{{% tab name="Export REALM" %}}
47+
4548
```bash
4649
export REALM="<replace_with_REALM>"
4750
```
51+
4852
{{% /tab %}}
4953
{{< /tabs >}}
5054

@@ -58,7 +62,7 @@ helm repo add splunk-otel-collector-chart https://signalfx.github.io/splunk-otel
5862
```
5963

6064
{{% /tab %}}
61-
{{% tab name="Helm Repo Add Output" lang="text" %}}
65+
{{% tab name="Helm Repo Add Output" %}}
6266
Using ACCESS_TOKEN={REDACTED}
6367
Using REALM=eu0
6468
"splunk-otel-collector-chart" has been added to your repositories
@@ -74,6 +78,7 @@ Install the OpenTelemetry Collector Helm chart with the following commands, do *
7478

7579
{{< tabs >}}
7680
{{% tab name="Helm Install" %}}
81+
7782
```bash
7883
helm install splunk-otel-collector \
7984
--set="splunkObservability.realm=$REALM" \
@@ -86,8 +91,11 @@ helm install splunk-otel-collector \
8691
splunk-otel-collector-chart/splunk-otel-collector \
8792
-f ~/workshop/k3s/otel-collector.yaml
8893
```
94+
8995
{{% /tab %}}
90-
{{% tab name="Helm Install Output" lang="text" %}}
96+
{{% tab name="Helm Install Output" %}}
97+
98+
``` text
9199
Using ACCESS_TOKEN={REDACTED}
92100
Using REALM=eu0
93101
NAME: splunk-otel-collector
@@ -96,8 +104,11 @@ NAMESPACE: default
96104
STATUS: deployed
97105
REVISION: 1
98106
TEST SUITE: None
107+
```
108+
99109
{{% /tab %}}
100-
{{% tab name="Install Network Explorer" lang="zsh" %}}
110+
{{% tab name="Install Network Explorer" %}}
111+
101112
```bash
102113
helm install splunk-otel-collector \
103114
--set="splunkObservability.realm=$REALM" \
@@ -116,6 +127,7 @@ helm install splunk-otel-collector \
116127
splunk-otel-collector-chart/splunk-otel-collector \
117128
-f ~/workshop/k3s/otel-collector.yaml
118129
```
130+
119131
{{% /tab %}}
120132
{{< /tabs >}}
121133

@@ -131,10 +143,14 @@ kubectl get pods
131143
```
132144

133145
{{% /tab %}}
134-
{{% tab name="Kubectl Get Pods Output" lang="text" %}}
146+
{{% tab name="Kubectl Get Pods Output" %}}
147+
148+
``` text
135149
NAME READY STATUS RESTARTS AGE
136150
splunk-otel-collector-agent-2sk6k 0/1 Running 0 10s
137151
splunk-otel-collector-k8s-cluster-receiver-6956d4446f-gwnd7 0/1 Running 0 10s
152+
```
153+
138154
{{% /tab %}}
139155
{{< /tabs >}}
140156

@@ -150,7 +166,7 @@ kubectl logs -l app=splunk-otel-collector -f --container otel-collector
150166
```
151167

152168
{{% /tab %}}
153-
{{% tab name="Kubectl Logs Output" lang="text" %}}
169+
{{% tab name="Kubectl Logs Output" %}}
154170
2021-03-21T16:11:10.900Z INFO service/service.go:364 Starting receivers...
155171
2021-03-21T16:11:10.900Z INFO builder/receivers_builder.go:70 Receiver is starting... {"component_kind": "receiver", "component_type": "prometheus", "component_name": "prometheus"}
156172
2021-03-21T16:11:11.009Z INFO builder/receivers_builder.go:75 Receiver started. {"component_kind": "receiver", "component_type": "prometheus", "component_name": "prometheus"}
@@ -187,9 +203,11 @@ Validate that your cluster is discovered and reporting by finding your cluster (
187203

188204
{{< tabs >}}
189205
{{% tab name="Echo Cluster Name" %}}
206+
190207
```bash
191208
echo $(hostname)-k3s-cluster
192209
```
210+
193211
{{% /tab %}}
194212
{{< /tabs >}}
195213

‎content/en/imt/gdi/nginx.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Now switch back to the default cluster node view by selecting the **MAP** tab an
2222
In your AWS/EC2 or Multipass shell session change into the `nginx` directory:
2323

2424
{{< tabs >}}
25-
{{% tab name="Change Directory" lang="bash" %}}
25+
{{% tab name="Change Directory" %}}
2626
```bash
2727
cd ~/workshop/k3s/nginx
2828
```
@@ -36,25 +36,25 @@ cd ~/workshop/k3s/nginx
3636
Create the NGINX ConfigMap[^1] using the `nginx.conf` file:
3737

3838
{{< tabs >}}
39-
{{% tab name="Kubectl Configmap Create" lang="bash" %}}
39+
{{% tab name="Kubectl Configmap Create" %}}
4040
```bash
4141
kubectl create configmap nginxconfig --from-file=nginx.conf
4242
```
4343
{{% /tab %}}
44-
{{% tab name="Kubectl Create Configmap Output" lang="text" %}}
44+
{{% tab name="Kubectl Create Configmap Output" %}}
4545
configmap/nginxconfig created
4646
{{% /tab %}}
4747
{{< /tabs >}}
4848

4949
Then create the deployment:
5050

5151
{{< tabs >}}
52-
{{% tab name="Kubectl Create Deployment" lang="bash" %}}
52+
{{% tab name="Kubectl Create Deployment" %}}
5353
```bash
5454
kubectl create -f nginx-deployment.yaml
5555
```
5656
{{% /tab %}}
57-
{{% tab name="Kubectl Create Deployment Output" lang="text" %}}
57+
{{% tab name="Kubectl Create Deployment Output" %}}
5858
deployment.apps/nginx created
5959
service/nginx created
6060
{{% /tab %}}
@@ -63,12 +63,12 @@ service/nginx created
6363
Next we will deploy Locust[^2] which is an open source tool used for creating a load test against NGINX:
6464

6565
{{< tabs >}}
66-
{{% tab name="Kubectl Create Deployment" lang="bash" %}}
66+
{{% tab name="Kubectl Create Deployment" %}}
6767
```bash
6868
kubectl create -f locust-deployment.yaml
6969
```
7070
{{% /tab %}}
71-
{{% tab name="Kubectl Create Deployment Output" lang="text" %}}
71+
{{% tab name="Kubectl Create Deployment Output" %}}
7272
deployment.apps/nginx-loadgenerator created
7373
service/nginx-loadgenerator created
7474
{{% /tab %}}
@@ -91,12 +91,12 @@ If you select the **WORKLOADS** tab again you will now see that there is a new R
9191
Let's validate this in your shell as well:
9292

9393
{{< tabs >}}
94-
{{% tab name="Kubectl Get Pods" lang="bash" %}}
94+
{{% tab name="Kubectl Get Pods" %}}
9595
```bash
9696
kubectl get pods
9797
```
9898
{{% /tab %}}
99-
{{% tab name="Kubectl Get Pods Output" lang="text" %}}
99+
{{% tab name="Kubectl Get Pods Output" %}}
100100
NAME READY STATUS RESTARTS AGE
101101
splunk-otel-collector-k8s-cluster-receiver-77784c659c-ttmpk 1/1 Running 0 9m19s
102102
splunk-otel-collector-agent-249rd 1/1 Running 0 9m19s

‎content/en/imt/monitoring-as-code/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ terraform plan -var="access_token=$ACCESS_TOKEN" -var="realm=$REALM" -var="o11y_
133133
```
134134

135135
{{% /tab %}}
136-
{{% tab name="Execution Plan Output" lang="text" %}}
136+
{{% tab name="Execution Plan Output" %}}
137137

138138
``` text
139139
Plan: 146 to add, 0 to change, 0 to destroy.
@@ -162,7 +162,7 @@ terraform apply -var="access_token=$ACCESS_TOKEN" -var="realm=$REALM" -var="o11y
162162
```
163163

164164
{{% /tab %}}
165-
{{% tab name="Apply Plan Output" lang="text" %}}
165+
{{% tab name="Apply Plan Output" %}}
166166

167167
``` text
168168
Apply complete! Resources: 146 added, 0 changed, 0 destroyed.
@@ -197,7 +197,7 @@ terraform destroy -var="access_token=$ACCESS_TOKEN" -var="realm=$REALM"
197197
```
198198

199199
{{% /tab %}}
200-
{{% tab name="Destroy Output" lang="text" %}}
200+
{{% tab name="Destroy Output" %}}
201201

202202
``` text
203203
Destroy complete! Resources: 146 destroyed.

‎content/en/other/bootcamp/_index.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The task is to write a python app to count words in a text file.
2929
Here is how to get to the milestone that completes this step:
3030

3131
{{< tabs >}}
32-
{{% tab name="Shell Command" lang="text" %}}
32+
{{% tab name="Shell Command" %}}
3333
git checkout 01service{{% /tab %}}
3434
{{< /tabs >}}
3535

@@ -38,7 +38,7 @@ This will put you on the first milestone.
3838
In case you have already worked on a milestone, you might see an error like:
3939

4040
{{< tabs >}}
41-
{{% tab name="Example Output" lang="bash" %}}
41+
{{% tab name="Example Output" %}}
4242
error: Your local changes to the following files would be overwritten by checkout:
4343
app.py
4444
Please commit your changes or stash them before you switch branches.
@@ -49,7 +49,7 @@ This is because your work conflicts with changes on the milestone. You have the
4949

5050
1. If you have worked on a task and want to progress to the next one *and DROP all your changes*:
5151
{{< tabs >}}
52-
{{% tab name="Shell Command: Git Reset" lang="text" %}}
52+
{{% tab name="Shell Command: Git Reset" %}}
5353
git reset --hard && git clean -fdx && git checkout service{{% /tab %}}
5454
{{< /tabs >}}
5555

@@ -58,14 +58,14 @@ This is because your work conflicts with changes on the milestone. You have the
5858
1. To preserve your work but move it out of the way, you can use
5959

6060
{{< tabs >}}
61-
{{% tab name="Shell Command: Git Stash" lang="text" %}}
61+
{{% tab name="Shell Command: Git Stash" %}}
6262
git stash && git checkout service{{% /tab %}}
6363
{{< /tabs >}}
6464

6565
To restore your work, switch to the previous milestone (`main` in this case) and retrieve the stashed changes:
6666

6767
{{< tabs >}}
68-
{{% tab name="Shell Command: Git Checkout" lang="text" %}}
68+
{{% tab name="Shell Command: Git Checkout" %}}
6969
git checkout main && git stash pop{{% /tab %}}
7070
{{< /tabs >}}
7171
Sometimes you run into conflicting changes with this approach. We recommend you use the first option in this case.
@@ -77,14 +77,14 @@ Use the first option and proceed.
7777
To compare two milestones, use
7878

7979
{{< tabs >}}
80-
{{% tab name="Shell Command: Git Checkout" lang="text" %}}
80+
{{% tab name="Shell Command: Git Checkout" %}}
8181
git diff main..01service{{% /tab %}}
8282
{{< /tabs >}}
8383

8484
To compare what you have with a milestone, , e.g. the milestone `service` use
8585

8686
{{< tabs >}}
87-
{{% tab name="Shell Command: Git Checkout" lang="text" %}}
87+
{{% tab name="Shell Command: Git Checkout" %}}
8888
git diff ..01service{{% /tab %}}
8989
{{% tab name="Example Output (excerpt)" %}}
9090
...

‎content/en/other/bootcamp/docs/apm/api.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,35 +29,35 @@ Note 2: Make sure to import modules.
2929
Rebuild the container images for the private registry:
3030

3131
{{< tabs >}}
32-
{{% tab name="Shell Command" lang="bash" %}}
32+
{{% tab name="Shell Command" %}}
3333
docker-compose build{{% /tab %}}
3434
{{< /tabs >}}
3535

3636
Push the images to the private registry:
3737

3838
{{< tabs >}}
39-
{{% tab name="Shell Command" lang="bash" %}}
39+
{{% tab name="Shell Command" %}}
4040
docker-compose push{{% /tab %}}
4141
{{< /tabs >}}
4242

4343
Delete the `public-api` deployment:
4444

4545
{{< tabs >}}
46-
{{% tab name="Shell Command" lang="bash" %}}
46+
{{% tab name="Shell Command" %}}
4747
kubectl delete deploy public-api{{% /tab %}}
4848
{{< /tabs >}}
4949

5050
Redeploy to the cluster with
5151

5252
{{< tabs >}}
53-
{{% tab name="Shell Command" lang="bash" %}}
53+
{{% tab name="Shell Command" %}}
5454
kubectl apply -f k8s{{% /tab %}}
5555
{{< /tabs >}}
5656

5757
Test the service with
5858

5959
{{< tabs >}}
60-
{{% tab name="Shell Command" lang="bash" %}}
60+
{{% tab name="Shell Command" %}}
6161

6262
``` bash
6363
ENDPOINT=$(kubectl get service/public-api -o jsonpath='{.spec.clusterIP}')

‎content/en/other/bootcamp/docs/apm/autoi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The development team has broken up the monolithic service into microservices bae
77
Test the service with:
88

99
{{< tabs >}}
10-
{{% tab name="Shell Command" lang="bash" %}}
10+
{{% tab name="Shell Command" %}}
1111

1212
``` bash
1313
curl -X POST http://127.0.0.1:8000/api -F [email protected]

‎content/en/other/bootcamp/docs/apm/k8s.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ helm install my-splunk-otel-collector --set="splunkObservability.realm=${SPLUNK_
2727
Rebuild the container images for the private registry:
2828

2929
{{< tabs >}}
30-
{{% tab name="Shell Command" lang="bash" %}}
30+
{{% tab name="Shell Command" %}}
3131
docker-compose build{{% /tab %}}
3232
{{< /tabs >}}
3333

3434
Push the images to the private registry:
3535

3636
{{< tabs >}}
37-
{{% tab name="Shell Command" lang="bash" %}}
37+
{{% tab name="Shell Command" %}}
3838
docker-compose push{{% /tab %}}
3939
{{< /tabs >}}
4040

‎content/en/other/bootcamp/docs/gdi/docker-compose.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ services:
2525
Build the service:
2626

2727
{{< tabs >}}
28-
{{% tab name="Shell Command" lang="bash" %}}
28+
{{% tab name="Shell Command" %}}
2929
docker-compose build{{% /tab %}}
3030
{{< /tabs >}}
3131

3232
Then run the whole stack:
3333

3434
{{< tabs >}}
35-
{{% tab name="Shell Command" lang="bash" %}}
35+
{{% tab name="Shell Command" %}}
3636
docker-compose up{{% /tab %}}
3737
{{< /tabs >}}
3838

‎content/en/other/bootcamp/docs/gdi/docker.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Stop other instances of the app if you had any running.
2929
Then build and run the image:
3030

3131
{{< tabs >}}
32-
{{% tab name="Shell Command" lang="bash" %}}
32+
{{% tab name="Shell Command" %}}
3333
docker build . -t wordcount
3434
docker run -p 5000:5000 wordcount:latest
3535
{{% /tab %}}

0 commit comments

Comments
 (0)