diff --git a/{{cookiecutter.project_slug}}/HOWTO.md b/{{cookiecutter.project_slug}}/HOWTO.md index c36213c..a83b5be 100644 --- a/{{cookiecutter.project_slug}}/HOWTO.md +++ b/{{cookiecutter.project_slug}}/HOWTO.md @@ -3,25 +3,25 @@ ## Next steps You may open your favorite IDE and start working with your project, please note that this project runs using docker. -You may modify at any time the credentials used to authenticate to connect modifying the file: +You may modify at any time the credentials used to authenticate to connect by modifying the file: *{{ cookiecutter.project_slug }}/.{{ cookiecutter.project_slug }}_dev.env* -In order to start your extension as standalone docker container you can access the project folder and run: +In order to start your extension as a standalone Docker container you can access the project folder and run: **$ docker compose up {{ cookiecutter.project_slug }}_dev** please note that in this way you will run the docker container and if you do changes on the code you will need to stop it and start it again. -If you would like to develop and test at same time, we recommend you to run your project using the command +If you would like to develop and test at the same time, we recommend you to run your project using the command **$ docker compose run {{ cookiecutter.project_slug }}_bash** -Once you get the interactive shell, you can run your extension using the command `cextrun`, stopping the process (using ctrl+c) and starting it back will reload the changes. +Once you get the interactive shell, you can run your extension using the command `cextrun`, stopping the process (using ctrl+c) and start it back will reload the changes. -Additionally, a basic boilerplate for writing unit tests has been created, you can run the tests using +Additionally, a basic boilerplate for writing unit tests have been created, you can run the tests using **$ docker compose run {{ cookiecutter.project_slug }}_test** @@ -37,14 +37,14 @@ In *{{ cookiecutter.project_slug }}/extension.json* file you can find the follow } ], ``` -Please modify this section to add methods which you need to be executed periodically, i.e. you need to perform monthly usage collection etc. +Please modify this section to add methods that you need to be executed periodically, i.e. you need to perform monthly usage collection, etc. If you do not have any scheduled methods, please remove this section. The method name specified in `method` property must be defined in your Extension class. The method definition is the following: ``` def execute_scheduled_processing(self, schedule): ... ``` -Details of a scheduled method above is just an example, you set your own name, description and method names. +Details of a scheduled method above is just an example, you set your own name, description, and method names. ## Environment variables @@ -69,7 +69,7 @@ They are standard ones, not storing sensible data. ## Community Resources -Please take note about this links in order to get additional information: +Please take note of these links in order to get additional information: * https://connect.cloudblue.com/ * https://connect.cloudblue.com/community/modules/devops/