From 016fb89444d34f5944de98ddeb6cb7a554c937c5 Mon Sep 17 00:00:00 2001
From: Adw8 <adwaitgharpure@gmail.com>
Date: Wed, 23 Oct 2024 18:46:12 +0530
Subject: [PATCH] Update README with testing details

---
 service-provider-setup/README.md   |  3 +++
 stack-orchestrator-setup/README.md | 26 +++++++++++++-------------
 user-setup/README.md               |  3 ++-
 3 files changed, 18 insertions(+), 14 deletions(-)

diff --git a/service-provider-setup/README.md b/service-provider-setup/README.md
index b46e161..9c6bf28 100644
--- a/service-provider-setup/README.md
+++ b/service-provider-setup/README.md
@@ -1,5 +1,7 @@
 # service-provider-setup
 
+This setup has been tested on digitalocean droplets running ubuntu 22.04 LTS
+
 ## Prerequisites
 
 - Setup Ansible: follow the [installation](../README.md#installation) guide to setup ansible on your machine
@@ -106,6 +108,7 @@
   - Deploy the webapp-deployer API and webapp-deployer UI
 
   ```bash
+  # TODO: Check if `--user` can be removed
   LANG=en_US.utf8 ansible-playbook service-provider-setup.yml -i hosts.ini --extra-vars='{ target_host: "deployment_host" }' --user $USER
   ```
 
diff --git a/stack-orchestrator-setup/README.md b/stack-orchestrator-setup/README.md
index 6789e98..cc65966 100644
--- a/stack-orchestrator-setup/README.md
+++ b/stack-orchestrator-setup/README.md
@@ -62,23 +62,23 @@ Run the following commands on your target machine:
   ```
   If the command outputs `"$HOME/bin is not in PATH"`, you'll need to add it to your `PATH`.
 
-- To add `$HOME/bin` to your `PATH`, run the following command:
+  - To add `$HOME/bin` to your `PATH`, run the following command:
 
-  ```bash
-  export PATH="$HOME/bin:$PATH"
-  ```
+    ```bash
+    export PATH="$HOME/bin:$PATH"
+    ```
 
-- To make this change permanent, add the following line to your shell configuration file (`~/.bashrc` or `~/.zshrc`, depending on your shell):
+  - To make this change permanent, add the following line to your shell configuration file (`~/.bashrc` or `~/.zshrc`, depending on your shell):
 
-  ```bash
-  # For bash users
-  echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc
-  source ~/.bashrc
+    ```bash
+    # For bash users
+    echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc
+    source ~/.bashrc
 
-  # For zsh users
-  echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
-  source ~/.zshrc
-  ```
+    # For zsh users
+    echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
+    source ~/.zshrc
+    ```
 
 - Once the PATH is set, verify the installation by running the following commands:
 
diff --git a/user-setup/README.md b/user-setup/README.md
index 3954c81..56e6e39 100644
--- a/user-setup/README.md
+++ b/user-setup/README.md
@@ -14,10 +14,11 @@
 
 ## Setup a user
 
+Execute the following commands in the `user-setup` directory
+
 - Create a new `hosts.ini` file:
 
    ```bash
-   cd user-setup/
    cp ../hosts.example.ini hosts.ini
    ```