@@ -13,7 +13,7 @@ $description
1313
1414We recommend using the provided Docker container.
1515
16- A pre-built version is available at [ docker hub ] ( https://hub.docker.com/repository/docker/ghga/$name ) :
16+ A pre-built version is available on [ Docker Hub ] ( https://hub.docker.com/repository/docker/ghga/$name ) :
1717``` bash
1818docker pull ghga/$name :$version
1919```
@@ -24,11 +24,11 @@ Or you can build the container yourself from the [`./Dockerfile`](./Dockerfile):
2424docker build -t ghga/$name :$version .
2525```
2626
27- For production-ready deployment, we recommend using Kubernetes, however,
28- for simple use cases, you could execute the service using docker
27+ For production-ready deployment, we recommend using Kubernetes.
28+ However for simple use cases, you could execute the service using docker
2929on a single server:
3030``` bash
31- # The entrypoint is preconfigured :
31+ # The entrypoint is pre-configured :
3232docker run -p 8080:8080 ghga/$name :$version --help
3333```
3434
@@ -50,18 +50,18 @@ $config_description
5050
5151### Usage:
5252
53- A template YAML for configuring the service can be found at
53+ A template YAML file for configuring the service can be found at
5454[ ` ./example_config.yaml ` ] ( ./example_config.yaml ) .
5555Please adapt it, rename it to ` .$shortname.yaml ` , and place it in one of the following locations:
5656- in the current working directory where you execute the service (on Linux: ` ./.$shortname.yaml ` )
5757- in your home directory (on Linux: ` ~/.$shortname.yaml ` )
5858
59- The config yaml will be automatically parsed by the service.
59+ The config YAML file will be automatically parsed by the service.
6060
6161** Important: If you are using containers, the locations refer to paths within the container.**
6262
6363All parameters mentioned in the [ ` ./example_config.yaml ` ] ( ./example_config.yaml )
64- could also be set using environment variables or file secrets.
64+ can also be set using environment variables or file secrets.
6565
6666For naming the environment variables, just prefix the parameter name with ` ${shortname}_ ` ,
6767e.g. for the ` host ` set an environment variable named ` ${shortname}_host `
@@ -95,12 +95,12 @@ This will give you a full-fledged, pre-configured development environment includ
9595- a pre-configured debugger
9696- automatic license-header insertion
9797
98- Moreover, inside the devcontainer, a command ` dev_install ` is available for convenience.
98+ Inside the devcontainer, a command ` dev_install ` is available for convenience.
9999It installs the service with all development dependencies, and it installs pre-commit.
100100
101101The installation is performed automatically when you build the devcontainer. However,
102102if you update dependencies in the [ ` ./pyproject.toml ` ] ( ./pyproject.toml ) or the
103- [ ` lock/requirements-dev.txt ` ] ( ./lock/requirements-dev.txt ) , please run it again.
103+ [ ` lock/requirements-dev.txt ` ] ( ./lock/requirements-dev.txt ) , run it again.
104104
105105## License
106106
0 commit comments