Update docs

comet-ml · Sep 16, 2024 · 107379a · 107379a
1 parent 938bd99
commit 107379a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/apps/opik-documentation/documentation/docs/self-host/local_deployment.md b/apps/opik-documentation/documentation/docs/self-host/local_deployment.md
@@ -24,8 +24,8 @@ To install Opik, you will need to clone the Opik repository and run the `docker-
 # Clone the Opik repository
 git clone https://github.com/comet-ml/opik.git
 
-# Navigate to the opik directory
-cd opik
+# Navigate to the opik/deployment/docker-compose directory
+cd opik/deployment/docker-compose
 
 # Start the Opik platform
 docker compose up --detach
@@ -50,6 +50,10 @@ All the data logged to the Opik platform will be stored in the `~/opik` director
 
 ## Starting, stopping and upgrading Opik
 
+:::note
+All the `docker compose` commands should be run from the `opik/deployment/docker-compose` directory.
+:::
+
 The `docker compose up` command can be used to install, start and upgrade Opik:
 
 ```bash

diff --git a/apps/opik-documentation/documentation/docs/self-host/overview.md b/apps/opik-documentation/documentation/docs/self-host/overview.md
@@ -21,7 +21,7 @@ If you would like to try out Opik locally, we recommend using our Local installa
 git clone https://github.com/comet-ml/opik.git
 
 # Run the Opik platform
-cd opik
+cd opik/deployment/docker-compose
 docker compose up --detach
 
 # Configure the Python SDK to point to the local Opik platform