From dc8bb99167b383fd4decc26d3bd3ede36a5ffa09 Mon Sep 17 00:00:00 2001 From: Ratnesh Mishra Date: Tue, 10 Sep 2024 09:34:53 +0530 Subject: [PATCH] docs: Modify postman_setup.md and postman_setup.sh files --- docs/POSTMAN_SETUP.md | 2 +- docs/README.md | 2 +- src/postman_setup.sh | 9 ++++++++- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/POSTMAN_SETUP.md b/docs/POSTMAN_SETUP.md index 3541f4d..d784377 100644 --- a/docs/POSTMAN_SETUP.md +++ b/docs/POSTMAN_SETUP.md @@ -1,6 +1,6 @@ # SETTING UP POSTMAN COLLECTIONS -We have a bash script `postman_setup.sh` under the [scripts](../scripts/post_installation.sh) directory that you can run to skip through the steps 1 and 5. +We have a bash script `postman_setup.sh` under the [src](../src/) directory that you can run to skip through the steps 1 and 5. To run the script, you can do the following: Go to the directory where the script is located and run the following command: ```bash diff --git a/docs/README.md b/docs/README.md index e25400d..40cba5e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -79,7 +79,7 @@ Copyright © 2023 The Mifos Initiative ``` # RUNNING THE POSTMAN COLLECTIONS -Detailed instructions for configuring your deployment to execute Postman collections against the Mifos-Gazelle can be found [here](./) +Detailed instructions for configuring your deployment to execute Postman collections against the Mifos-Gazelle can be found at `POSTMAN_SETUP.md` [here](./) # USING THE DEPLOYED APPS diff --git a/src/postman_setup.sh b/src/postman_setup.sh index 0369f6d..2d2700a 100755 --- a/src/postman_setup.sh +++ b/src/postman_setup.sh @@ -5,7 +5,12 @@ echo "RUN_DIR is $RUN_DIR" BASE_DIR="$( cd $(dirname "$RUN_DIR") ; pwd )" echo "BASE_DIR is $BASE_DIR" -exit +function welcome { + echo -e "\e[33mWARNING: In case you start getting service unavailable errors, please follow the Step 5 from the POSTMAN_SETPUP.md file.\e[0m" + echo -e "\e[33mWARNING: This script will only work if you have run the deployment atleast once successfully.\e[0m" + echo -e "\e[33mWARNING: This script uses the directory repos/phlabs/orchestration/feel/ to upload the BPMN diagrams to zeebe operations service.\e[0m" +} + # Check if the script is run with root privileges if [ "$(id -u)" -ne 0 ]; then echo "This script must be run as root" >&2 @@ -19,6 +24,8 @@ if [ $# -lt 1 ]; then exit 1 fi +welcome + # Initialize variables ip_address=$1 override=false