Skip to content

Commit 4f3f59a

Browse files
committed
Update create_driver contrib guide details
1 parent 4049bf8 commit 4f3f59a

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

CONTRIB.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ To create a new driver scaffold, you can use the `create_driver.sh` script in th
1414

1515
From the root directory of the project, run the following command:
1616
```shell
17-
$ ./contrib/__templates__/create_driver.sh shell Shell "Miguel Angel Ajo" [email protected]
17+
$ ./__templates__/create_driver.sh yepkit Ykush "Miguel Angel Ajo" "[email protected]"
1818

19-
Creating: contrib/drivers/shell/jumpstarter_driver_shell/__init__.py
20-
Creating: contrib/drivers/shell/jumpstarter_driver_shell/client.py
21-
Creating: contrib/drivers/shell/jumpstarter_driver_shell/driver_test.py
22-
Creating: contrib/drivers/shell/jumpstarter_driver_shell/driver.py
23-
Creating: contrib/drivers/shell/.gitignore
24-
Creating: contrib/drivers/shell/pyproject.toml
25-
Creating: contrib/drivers/shell/README.md
26-
Creating: contrib/drivers/shell/examples/exporter.yaml
19+
Creating: packages/jumpstarter_driver_yepkit/jumpstarter_driver_yepkit/__init__.py
20+
Creating: packages/jumpstarter_driver_yepkit/jumpstarter_driver_yepkit/client.py
21+
Creating: packages/jumpstarter_driver_yepkit/jumpstarter_driver_yepkit/driver_test.py
22+
Creating: packages/jumpstarter_driver_yepkit/jumpstarter_driver_yepkit/driver.py
23+
Creating: packages/jumpstarter_driver_yepkit/.gitignore
24+
Creating: packages/jumpstarter_driver_yepkit/pyproject.toml
25+
Creating: packages/jumpstarter_driver_yepkit/README.md
26+
Creating: packages/jumpstarter_driver_yepkit/examples/exporter.yaml
2727

2828
$ make sync
2929
uv sync --all-packages --all-extras

__templates__/create_driver.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export AUTHOR_NAME=$3
2121
export AUTHOR_EMAIL=$4
2222

2323
# create the driver directory
24-
DRIVER_DIRECTORY=packages/jumpstarter_driver_${DRIVER_NAME}
24+
DRIVER_DIRECTORY=packages/jumpstarter-driver-${DRIVER_NAME}
2525
MODULE_DIRECTORY=${DRIVER_DIRECTORY}/jumpstarter_driver_${DRIVER_NAME}
2626
# create the module directories
2727
mkdir -p ${MODULE_DIRECTORY}
@@ -30,10 +30,10 @@ mkdir -p ${DRIVER_DIRECTORY}/examples
3030

3131
for f in __init__.py client.py driver_test.py driver.py; do
3232
echo "Creating: ${MODULE_DIRECTORY}/${f}"
33-
envsubst < contrib/__templates__/driver/jumpstarter_driver/${f}.tmpl > ${MODULE_DIRECTORY}/${f}
33+
envsubst < __templates__/driver/jumpstarter_driver/${f}.tmpl > ${MODULE_DIRECTORY}/${f}
3434
done
3535

3636
for f in .gitignore pyproject.toml README.md examples/exporter.yaml; do
3737
echo "Creating: ${DRIVER_DIRECTORY}/${f}"
38-
envsubst < packages/__templates__/driver/${f}.tmpl > ${DRIVER_DIRECTORY}/${f}
38+
envsubst < __templates__/driver/${f}.tmpl > ${DRIVER_DIRECTORY}/${f}
3939
done

0 commit comments

Comments
 (0)