Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Commit e552632

Browse files
committed
enforce usage of shell instead of bash or console
1 parent d5d0579 commit e552632

37 files changed

Lines changed: 67 additions & 67 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Please be respectful and considerate of others when contributing to the project.
2929

3030
## Development Setup
3131

32-
```bash
32+
```shell
3333
# Install dependencies
3434
make sync
3535

@@ -71,13 +71,13 @@ If you are working on a driver or adapter library of general interest, please co
7171

7272
To create a new driver scaffold, you can use the `create_driver.sh` script:
7373

74-
```bash
74+
```shell
7575
./__templates__/create_driver.sh vendor_name driver_name "Your Name" "your.email@example.com"
7676
```
7777

7878
This will create the necessary files and structure for your driver in the `packages/` directory. For example:
7979

80-
```bash
80+
```shell
8181
./__templates__/create_driver.sh yepkit Ykush "Your Name" "your.email@example.com"
8282
```
8383

@@ -121,7 +121,7 @@ After creating your driver skeleton:
121121

122122
To test your driver during development:
123123

124-
```bash
124+
```shell
125125
# From the project root
126126
make sync # Synchronize dependencies
127127
cd packages/your_driver_package
@@ -156,7 +156,7 @@ To contribute to the documentation, you'll need to set up your development envir
156156

157157
To build and preview the documentation locally:
158158

159-
```bash
159+
```shell
160160
cd docs
161161
make html # Build HTML documentation
162162
make docs-serve # Serve documentation locally for preview

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ A free, open-source tool for automated testing on real and virtual hardware with
2020

2121
Install all the Jumpstarter Python components:
2222

23-
```console
23+
```shell
2424
pip install --extra-index-url https://jumpstarter.dev/packages/simple jumpstarter-all
2525
```
2626

2727
Or, just install the `jmp` CLI tool:
2828

29-
```console
29+
```shell
3030
pip install --extra-index-url https://jumpstarter.dev/packages/simple jumpstarter-cli
3131
```
3232

__templates__/create_driver.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ cat > "${README_FILE}" << 'EOF'
4141
4242
## Installation
4343
44-
```bash
44+
```shell
4545
pip install jumpstarter-driver-${DRIVER_NAME}
4646
```
4747

docs/source/api-reference/drivers/dbus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Installation
66

7-
```bash
7+
```shell
88
pip install jumpstarter-driver-dbus
99
```
1010

docs/source/api-reference/drivers/proxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Installation
66

7-
```bash
7+
```shell
88
pip install jumpstarter-driver-proxy
99
```
1010

docs/source/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ virtual devices.
115115

116116
#### Example: Running Local Tests
117117

118-
```bash
118+
```shell
119119
jmp shell --exporter my-hardware-exporter
120120
jmp shell --exporter my-virtual-exporter
121121

@@ -193,7 +193,7 @@ environments and prevents unauthorized access to hardware resources.
193193

194194
#### Example: Running Distributed Tests
195195

196-
```bash
196+
```shell
197197
# Configure client with server information
198198
jmp config client use my-client
199199

docs/source/cli/clients.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can also use the following options to specify the kubeconfig and context to
1818

1919
To create a new client and its associated config, run the following command:
2020

21-
```bash
21+
```shell
2222
$ jmp admin create client john --namespace jumpstarter-lab --unsafe -o john.yaml
2323
```
2424

@@ -69,13 +69,13 @@ system is using self-signed certificates.
6969
name: my-client
7070
```
7171

72-
```bash
72+
```shell
7373
$ kubectl apply -f my-client.yaml
7474
```
7575

7676
2. Retrieve the created client resource information:
7777

78-
```bash
78+
```shell
7979
$ kubectl get client my-client -o yaml
8080
$ kubectl get client my-client -o=jsonpath='{.status.endpoint}'
8181
$ kubectl get secret $(kubectl get client my-client -o=jsonpath='{.status.credential.name}') -o=jsonpath='{.data.token}' | base64 -d
@@ -86,7 +86,7 @@ system is using self-signed certificates.
8686
The end user can then configure their client using the
8787
[jmp](./reference/jmp.md#jmp-cli-reference) CLI:
8888

89-
```bash
89+
```shell
9090
$ jmp config client create my-client
9191
Enter a valid Service endpoint: devl.jumpstarter.dev
9292
Enter a Jumpstarter auth token (hidden): ***

docs/source/cli/exporters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ registered.
1717
Exporter creation must be done by an administrator user who has access to the
1818
Kubernetes cluster where the `jumpstarter-controller` service is hosted.
1919

20-
```bash
20+
```shell
2121
# Create the exporter instance
2222
$ jmp admin create exporter my-exporter --namespace jumpstarter-lab -o my-exporter.yaml
2323
```

docs/source/cli/run-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ to authenticate with the Service.
1414
Alternatively the client can receive the endpoint and token as environment
1515
variables:
1616

17-
```bash
17+
```shell
1818
export JMP_ENDPOINT=jumpstarter.my-lab.com:1443
1919
export JMP_TOKEN=dGhpc2lzYXRva2VuLTEyMzQxMjM0MTIzNEyMzQtc2Rxd3Jxd2VycXdlcnF3ZXJxd2VyLTEyMzQxMjM0MTIz
2020
```

docs/source/config/cli.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,14 @@ config file.
9494
To switch between different client configs, use the `jmp config client use
9595
<name>` command:
9696

97-
```bash
97+
```shell
9898
$ jmp config client use another
9999
Using client config '/home/jdoe/.config/jumpstarter/clients/another.yaml'
100100
```
101101

102102
All client configurations can be listed with `jmp config client list`:
103103

104-
```bash
104+
```shell
105105
$ jmp config client list
106106
CURRENT NAME ENDPOINT PATH
107107
* default jumpstarter1.my-lab.com:1443 /home/jdoe/.config/jumpstarter/clients/default.yaml
@@ -111,7 +111,7 @@ CURRENT NAME ENDPOINT PATH
111111

112112
Clients can also be removed using `jmp config client delete <name>`:
113113

114-
```bash
114+
```shell
115115
$ jmp config client delete myclient
116116
Deleted client config '/home/jdoe/.config/jumpstarter/clients/myclient.yaml'
117117
```
@@ -210,28 +210,28 @@ CLI](../cli/exporters.md).
210210
To create a new exporter configuration file from a know endpoint and token the
211211
`jmp config exporter create <name>` command can be used.
212212

213-
```bash
213+
```shell
214214
$ jmp config exporter create myexporter
215215
Endpoint: grpc.jumpstarter.my.domain.com
216216
Token: <<token>>
217217
```
218218

219219
To use a specific config when starting the exporter:
220220

221-
```bash
221+
```shell
222222
$ jmp run --exporter my-exporter
223223
Using exporter config '/etc/jumpstarter/exporters/another/exporter.yaml'
224224
```
225225

226226
The path to a config can also be provided:
227227

228-
```bash
228+
```shell
229229
jmp run --exporter-config /etc/jumpstarter/exporters/another/exporter.yaml
230230
```
231231

232232
All exporter configurations can be listed with `jmp config exporter list`:
233233

234-
```bash
234+
```shell
235235
$ jmp config exporter list
236236
ALIAS PATH
237237
test-exporter-2 /etc/jumpstarter/exporters/test-exporter-2.yaml
@@ -240,7 +240,7 @@ my-exporter /etc/jumpstarter/exporters/my-exporter.yaml
240240

241241
Exporters can also be removed using `jmp config exporter delete <name>`:
242242

243-
```bash
243+
```shell
244244
$ jmp config exporter delete myexporter
245245
Deleted exporter config '/etc/jumpstarter/exporters/myexporter.yaml'
246246
```
@@ -323,7 +323,7 @@ WantedBy=multi-user.target default.target
323323

324324
Then enable and start the service:
325325

326-
```bash
326+
```shell
327327
sudo systemctl daemon-reload
328328
sudo systemctl enable --now my-exporter
329329
```

0 commit comments

Comments
 (0)