From 6cd0eadadeabfee3773415ceb856d4a6ed3e86d6 Mon Sep 17 00:00:00 2001 From: Sam Al-Sapti Date: Mon, 28 Nov 2022 19:31:31 +0100 Subject: [PATCH] Apply valberg's suggestions --- README.md | 51 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 35 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index d27ba9fd..97e3b760 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,18 @@ only can also be specified. By default, the script deploys everything. Here is a summary of the options that can be used with the script: -```console -$ ./deploy.sh # deploy everything -$ ./deploy.sh base # deploy the ubuntu_base role only -$ ./deploy.sh services # deploy the docker role only -$ ./deploy.sh services SINGLE_SERVICE # deploy SINGLE_SERVICE Docker service only +```sh +# deploy everything +./deploy.sh + +# deploy the ubuntu_base role only +./deploy.sh base + +# deploy the docker role only +./deploy.sh services + +# deploy SINGLE_SERVICE Docker service only +./deploy.sh services SINGLE_SERVICE ``` `SINGLE_SERVICE` should match one of the service names in the `services` @@ -46,12 +53,21 @@ this to work properly. Here is a summary of the commands that are available with the `vagrant` command-line tool: -```console -$ vagrant up # Create and provision the VM -$ vagrant provision # Re-provision the VM -$ vagrant ssh # SSH into the VM -$ vagrant halt # Power down the VM -$ vagrant destroy # Power down and delete the VM +```sh +# Create and provision the VM +vagrant up + +# Re-provision the VM +vagrant provision + +# SSH into the VM +vagrant ssh + +# Power down the VM +vagrant halt + +# Power down and delete the VM +vagrant destroy ``` The `vagrant` command-line tool does not support supplying extra @@ -59,9 +75,12 @@ variables to Ansible on runtime, so to be able to deploy only parts of the Ansible playbook to Vagrant, the `deploy.sh` script can be used with the `--vagrant` flag. Here are some examples: -```console -$ ./deploy.sh --vagrant base # deploy the ubuntu_base role only in the Vagrant VM -$ ./deploy.sh --vagrant services SINGLE_SERVICE # deploy SINGLE_SERVICE Docker service only in the Vagrant VM +```sh +# deploy the ubuntu_base role only in the Vagrant VM +./deploy.sh --vagrant base + +# deploy SINGLE_SERVICE Docker service only in the Vagrant VM +./deploy.sh --vagrant services SINGLE_SERVICE ``` Note that the `--vagrant` flag should be the first argument when using @@ -75,8 +94,8 @@ every commit, so please use that. To initialize pre-commit, you need to have Python and GNU make installed. Then, just run the following shell command: -```console -$ make init +```sh +make init ``` ## Nice tools