From 3e4fc12d3059a442a2498d64136cb5556b143b9d Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:21:29 +0800 Subject: [PATCH] Updated instructions on upgrading to RAGFlow dev (#3175) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docker/README.md | 1 + docs/guides/upgrade_ragflow.md | 8 +++++++- docs/references/http_api_reference.md | 4 ++-- docs/references/python_api_reference.md | 4 ++-- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docker/README.md b/docker/README.md index 256fd3a7..6ead9a28 100644 --- a/docker/README.md +++ b/docker/README.md @@ -4,6 +4,7 @@ Look into [.env](./.env), there're some important variables. ## MYSQL_PASSWORD + The mysql password could be changed by this variable. But you need to change *mysql.password* in [service_conf.yaml](./service_conf.yaml) at the same time. diff --git a/docs/guides/upgrade_ragflow.md b/docs/guides/upgrade_ragflow.md index 4843c5b7..18139093 100644 --- a/docs/guides/upgrade_ragflow.md +++ b/docs/guides/upgrade_ragflow.md @@ -18,7 +18,13 @@ You can upgrade RAGFlow to dev version or the latest version: RAGFLOW_IMAGE=infiniflow/ragflow:dev ``` -2. Update RAGFlow image and restart RAGFlow: +2. Pull the latest code from inside Docker: + + ```bash + git pull + ``` + +3. Update RAGFlow image and restart RAGFlow: ```bash docker compose -f docker/docker-compose.yml pull diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index f7f8f7cd..fe623d24 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -1,5 +1,5 @@ +--- sidebar_position: 0 - slug: /http_api_reference --- @@ -70,7 +70,7 @@ curl --request POST \ - `"language"`: (*Body parameter*), `string` The language setting of the dataset to create. Available options: - - `"English"` (Default) + - `"English"` (default) - `"Chinese"` - `"embedding_model"`: (*Body parameter*), `string` diff --git a/docs/references/python_api_reference.md b/docs/references/python_api_reference.md index 2ba820c3..33cf36fa 100644 --- a/docs/references/python_api_reference.md +++ b/docs/references/python_api_reference.md @@ -1,5 +1,5 @@ +--- sidebar_position: 1 - slug: /python_api_reference --- @@ -58,7 +58,7 @@ A brief description of the dataset to create. Defaults to `""`. The language setting of the dataset to create. Available options: -- `"English"` (Default) +- `"English"` (default) - `"Chinese"` #### permission