fix: Bumping version to 0.5.13 and making a note about version deprec…

…ations (#37)
amikos-tech · Oct 14, 2024 · af90c17 · af90c17
1 parent 1295d9f
commit af90c17
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 11 deletions.
diff --git a/docs/core/advanced/wal.md b/docs/core/advanced/wal.md
@@ -6,7 +6,7 @@ request (aka transaction) is safely stored before acknowledging back to the user
 after writing to the WAL, the data is also written to the index. This enables Chroma to serve as real-time search
 engine, where the data is available for querying immediately after it is written to the WAL.
 
-Below is a diagram that illustrates the WAL in ChromaDB (ca. v0.4.22):
+Below is a diagram that illustrates the WAL in ChromaDB (ca. v0.5.1322):
 
 ![WAL](../../assets/images/WAL.png){: style="width:100%"}
 

diff --git a/docs/index.md b/docs/index.md
@@ -2,7 +2,11 @@
 
 This is a collection of small guides and recipes to help you get started with ChromaDB.
 
-Latest ChromaDB version: [0.5.11](https://github.com/chroma-core/chroma/releases/tag/0.5.11)
+!!! warning "Critical Fixes"
+
+  If you are using Chroma `>=0.5.7` and `<=0.5.13` please upgrade to `0.5.13` as there is a critical bug that can cause data loss. Read more on the [GH Issue](https://github.com/chroma-core/chroma/issues/2922).
+
+Latest ChromaDB version: [0.5.13](https://github.com/chroma-core/chroma/releases/tag/0.5.13)
 
 
 ## New and Noteworthy

diff --git a/docs/running/running-chroma.md b/docs/running/running-chroma.md
@@ -40,7 +40,7 @@ Prerequisites:
 - Docker - [Overview of Docker Desktop | Docker Docs](https://docs.docker.com/desktop/)
 
 ```shell
-docker run -d --rm --name chromadb -v ./chroma:/chroma/chroma -e IS_PERSISTENT=TRUE -e ANONYMIZED_TELEMETRY=TRUE chromadb/chroma:0.5.11
+docker run -d --rm --name chromadb -v ./chroma:/chroma/chroma -e IS_PERSISTENT=TRUE -e ANONYMIZED_TELEMETRY=TRUE chromadb/chroma:0.5.13
 ```
 
 Options:
@@ -72,7 +72,7 @@ docker compose up -d --build
 If you want to run a specific version of Chroma you can checkout the version tag you need:
 
 ```shell
-git checkout release/0.5.11
+git checkout release/0.5.13
 ```
 
 ### Docker Compose (Without Cloning the Repo)
@@ -93,7 +93,7 @@ networks:
     driver: bridge
 services:
   chromadb:
-    image: chromadb/chroma:0.5.11
+    image: chromadb/chroma:0.5.13
     volumes:
       - ./chromadb:/chroma/chroma
     environment:
@@ -106,7 +106,7 @@ services:
       - net
 ```
 
-The above will create a container with the latest Chroma (`chromadb/chroma:0.5.11`), will expose it to port `8000` on
+The above will create a container with the latest Chroma (`chromadb/chroma:0.5.13`), will expose it to port `8000` on
 the local machine and will persist data in `./chromadb` relative path from where the `docker-compose.yaml` has been ran.
 
 !!! tip "Versioning"
@@ -148,7 +148,7 @@ Get and install the chart:
 ```bash
 helm repo add chroma https://amikos-tech.github.io/chromadb-chart/
 helm repo update
-helm install chroma chroma/chromadb --set chromadb.apiVersion="0.5.11"
+helm install chroma chroma/chromadb --set chromadb.apiVersion="0.5.13"
 ```
 
 By default the chart will enable authentication in Chroma. To get the token run the following:

diff --git a/docs/security/chroma-ssl-cert.md b/docs/security/chroma-ssl-cert.md
@@ -111,7 +111,7 @@ You can run Chroma with the SSL/TLS certificate generate above or any other cert
 
     services:
       server:
-        image: chromadb/chroma:0.5.11
+        image: chromadb/chroma:0.5.13
         volumes:
           # Be aware that indexed data are located in "/chroma/chroma/"
           # Default configuration for persist_directory in chromadb/config.py

diff --git a/docs/security/ssl-proxies.md b/docs/security/ssl-proxies.md
@@ -104,7 +104,7 @@ services:
       sh -c "/usr/local/bin/wait-for-certs.sh && \
       /opt/bitnami/envoy/bin/envoy -c /opt/bitnami/envoy/conf/envoy.yaml"
   chromadb:
-    image: chromadb/chroma:0.5.11
+    image: chromadb/chroma:0.5.13
     volumes:
       - ./chromadb:/chroma/chroma
     environment:
@@ -166,7 +166,7 @@ services:
     environment:
       - CHROMA_DOMAIN=${CHROMA_DOMAIN:-localhost}
   chromadb:
-    image: chromadb/chroma:0.5.11
+    image: chromadb/chroma:0.5.13
     volumes:
       - ./chromadb:/chroma/chroma
     environment:

diff --git a/docs/strategies/memory-management.md b/docs/strategies/memory-management.md
@@ -34,7 +34,7 @@ To enable the LRU cache the following two settings parameters or environment var
 
     The below code snippets assume you are working with a `PersistentClient` or an `EphemeralClient` instance.
 
-At the time of writing (Chroma v0.4.22), Chroma does not allow you to manually unloading of collections from memory.
+At the time of writing (Chroma v0.5.1322), Chroma does not allow you to manually unloading of collections from memory.
 
 Here we provide a simple utility function to help users unload collections from memory.