From 4fe8da536a512a261d60d6dfc7f6c2d01f77f87c Mon Sep 17 00:00:00 2001
From: Victor Jouffrey <37411285+vatj@users.noreply.github.com>
Date: Mon, 22 Apr 2024 10:37:59 +0200
Subject: [PATCH] Update documentation instructions (#377) (#378)

---
 docs/user_guides/client_installation/index.md | 42 ++++---------------
 1 file changed, 8 insertions(+), 34 deletions(-)

diff --git a/docs/user_guides/client_installation/index.md b/docs/user_guides/client_installation/index.md
index 51b2d557d..9a2d296dc 100644
--- a/docs/user_guides/client_installation/index.md
+++ b/docs/user_guides/client_installation/index.md
@@ -9,68 +9,42 @@ The Hopsworks client library is required to connect to the Hopsworks Feature Sto
 !!! note "Virtual environment"
     It is recommended to use a virtual python environment instead of the system environment used by your operating system, in order to avoid any side effects regarding interfering dependencies.
 
-```
+```bash
 pip install hopsworks
 ```
 Supported versions of Python: 3.8, 3.9, 3.10, 3.11, 3.12 ([PyPI ↗](https://pypi.org/project/hopsworks/))
 
 !!! attention "OSX Installation"
-
-    On OSX systems you might need to install librdkafka manually before installing hopsworks. You can verify if you have installed it previously using `brew info librdkafka`. Hopsworks requires `librdkafka` version to be lower than 2.0.0. If it is not installed yet, you can do so using `brew install`, however, you always need to set the `C_INCLUDE_PATH` and `LIBRARY_PATH`.
-
-    If not installed yet, install librdkafka:
-    ```
-    curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/f7d0f40bbc4075177ecf16812fd95951a723a996/Formula/librdkafka.rb
-    brew install --build-from-source librdkafka.rb
-    ```
-    If it is already installed, set the environment variables and proceed with installing the hopsworks client library:
-    ```
-    export C_INCLUDE_PATH=$(brew --prefix)/include
-    export LIBRARY_PATH=$(brew --prefix)/lib
-    pip install hopsworks
-    ```
+    Hopsworks latest version should work on OSX systems without any additional requirements. However if installing an older version of the Hopsworks SDK you might need to install `librdkafka` manually. Checkout the documentation for the specific version you are installing.
 
 !!! attention "Windows/Conda Installation"
 
     On Windows systems you might need to install twofish manually before installing hopsworks, if you don't have the Microsoft Visual C++ Build Tools installed. In that case, it is recommended to use a conda environment and run the following commands:
     
-    ```
+    ```bash
     conda install twofish
-    setx CONDA_DLL_SEARCH_MODIFICATION_ENABLE 1
     pip install hopsworks
     ```
 
 ## Feature Store only
 To only install the Hopsworks Feature Store client library, execute the following command:
 
-```
+```bash
 pip install hsfs[python]
+# or if using zsh
+pip install 'hsfs[python]'
 ```
 Supported versions of Python: 3.8, 3.9, 3.10, 3.11, 3.12 ([PyPI ↗](https://pypi.org/project/hsfs/))
 
 !!! attention "OSX Installation"
-
-    On OSX systems you might need to install librdkafka manually before installing hopsworks. You can verify if you have installed it previously using `brew info librdkafka`. Hopsworks requires `librdkafka` version to be lower than 2.0.0. If it is not installed yet, you can do so using `brew install`, however, you always need to set the `C_INCLUDE_PATH` and `LIBRARY_PATH`.
-
-    If not installed yet, install librdkafka:
-    ```
-    curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/f7d0f40bbc4075177ecf16812fd95951a723a996/Formula/librdkafka.rb
-    brew install --build-from-source librdkafka.rb
-    ```
-    If it is already installed, set the environment variables and proceed with installing the hopsworks client library:
-    ```
-    export C_INCLUDE_PATH=$(brew --prefix)/include
-    export LIBRARY_PATH=$(brew --prefix)/lib
-    pip install hsfs[python]
-    ```
+    Hopsworks latest version should work on OSX systems without any additional requirements. However if installing an older version of the Hopsworks SDK you might need to install `librdkafka` manually. Checkout the documentation for the specific version you are installing.
 
 !!! attention "Windows/Conda Installation"
 
     On Windows systems you might need to install twofish manually before installing hsfs, if you don't have the Microsoft Visual C++ Build Tools installed. In that case, it is recommended to use a conda environment and run the following commands:
     
-    ```
+    ```bash
     conda install twofish
-    setx CONDA_DLL_SEARCH_MODIFICATION_ENABLE 1
     pip install hsfs[python]
     ```