diff --git a/README.md b/README.md index 867f90daf..15293cbc8 100644 --- a/README.md +++ b/README.md @@ -137,9 +137,10 @@ releases! 🌟 - RAM >= 16 GB - Disk >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 - > If you have not installed Docker on your local machine (Windows, Mac, or Linux), - > see [Install Docker Engine](https://docs.docker.com/engine/install/). - > The [gVisor](https://gvisor.dev/docs/user_guide/install/) is optional and only needed if you plan to use the code executor (sandbox) feature of RAGFlow. +- [gVisor](https://gvisor.dev/docs/user_guide/install/): Required only if you intend to use the code executor (sandbox) feature of RAGFlow. + +> [!TIP] +> If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/). ### 🚀 Start up the server @@ -392,4 +393,4 @@ See the [RAGFlow Roadmap 2025](https://github.com/infiniflow/ragflow/issues/4214 ## 🙌 Contributing RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community. -If you would like to be a part, review our [Contribution Guidelines](./CONTRIBUTING.md) first. +If you would like to be a part, review our [Contribution Guidelines](https://ragflow.io/docs/dev/contributing) first. diff --git a/README_id.md b/README_id.md index 39b526b9d..3ee4d6177 100644 --- a/README_id.md +++ b/README_id.md @@ -132,6 +132,10 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io). - RAM >= 16 GB - Disk >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 +- [gVisor](https://gvisor.dev/docs/user_guide/install/): Hanya diperlukan jika Anda ingin menggunakan fitur eksekutor kode (sandbox) dari RAGFlow. + +> [!TIP] +> Jika Anda belum menginstal Docker di komputer lokal Anda (Windows, Mac, atau Linux), lihat [Install Docker Engine](https://docs.docker.com/engine/install/). ### 🚀 Menjalankan Server @@ -358,4 +362,4 @@ Lihat [Roadmap RAGFlow 2025](https://github.com/infiniflow/ragflow/issues/4214) ## 🙌 Kontribusi RAGFlow berkembang melalui kolaborasi open-source. Dalam semangat ini, kami menerima kontribusi dari komunitas. -Jika Anda ingin berpartisipasi, tinjau terlebih dahulu [Panduan Kontribusi](./CONTRIBUTING.md). +Jika Anda ingin berpartisipasi, tinjau terlebih dahulu [Panduan Kontribusi](https://ragflow.io/docs/dev/contributing). diff --git a/README_ja.md b/README_ja.md index 1624c6163..734e707cc 100644 --- a/README_ja.md +++ b/README_ja.md @@ -112,7 +112,10 @@ - RAM >= 16 GB - Disk >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 - > ローカルマシン（Windows、Mac、または Linux）に Docker をインストールしていない場合は、[Docker Engine のインストール](https://docs.docker.com/engine/install/) を参照してください。 +- [gVisor](https://gvisor.dev/docs/user_guide/install/): RAGFlowのコード実行（サンドボックス）機能を利用する場合のみ必要です。 + +> [!TIP] +> ローカルマシン（Windows、Mac、または Linux）に Docker をインストールしていない場合は、[Docker Engine のインストール](https://docs.docker.com/engine/install/) を参照してください。 ### 🚀 サーバーを起動 @@ -352,4 +355,4 @@ docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly ## 🙌 コントリビュート -RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず [コントリビューションガイド](./CONTRIBUTING.md)をご覧ください。 +RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず [コントリビューションガイド](https://ragflow.io/docs/dev/contributing)をご覧ください。 diff --git a/README_ko.md b/README_ko.md index 60eee4fd3..efeb328c7 100644 --- a/README_ko.md +++ b/README_ko.md @@ -112,7 +112,10 @@ - RAM >= 16 GB - Disk >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 - > 로컬 머신(Windows, Mac, Linux)에 Docker가 설치되지 않은 경우, [Docker 엔진 설치](<(https://docs.docker.com/engine/install/)>)를 참조하세요. +- [gVisor](https://gvisor.dev/docs/user_guide/install/): RAGFlow의 코드 실행기(샌드박스) 기능을 사용하려는 경우에만 필요합니다. + +> [!TIP] +> 로컬 머신(Windows, Mac, Linux)에 Docker가 설치되지 않은 경우, [Docker 엔진 설치](<(https://docs.docker.com/engine/install/)>)를 참조하세요. ### 🚀 서버 시작하기 @@ -352,4 +355,4 @@ docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly ## 🙌 컨트리뷰션 -RAGFlow는 오픈소스 협업을 통해 발전합니다. 이러한 정신을 바탕으로, 우리는 커뮤니티의 다양한 기여를 환영합니다. 참여하고 싶으시다면, 먼저 [가이드라인](./CONTRIBUTING.md)을 검토해 주세요. +RAGFlow는 오픈소스 협업을 통해 발전합니다. 이러한 정신을 바탕으로, 우리는 커뮤니티의 다양한 기여를 환영합니다. 참여하고 싶으시다면, 먼저 [가이드라인](https://ragflow.io/docs/dev/contributing)을 검토해 주세요. diff --git a/README_pt_br.md b/README_pt_br.md index 2eb4167a0..f2f2ffc9a 100644 --- a/README_pt_br.md +++ b/README_pt_br.md @@ -132,7 +132,10 @@ Experimente nossa demo em [https://demo.ragflow.io](https://demo.ragflow.io). - RAM >= 16 GB - Disco >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 - > Se você não instalou o Docker na sua máquina local (Windows, Mac ou Linux), veja [Instalar Docker Engine](https://docs.docker.com/engine/install/). +- [gVisor](https://gvisor.dev/docs/user_guide/install/): Necessário apenas se você pretende usar o recurso de executor de código (sandbox) do RAGFlow. + +> [!TIP] +> Se você não instalou o Docker na sua máquina local (Windows, Mac ou Linux), veja [Instalar Docker Engine](https://docs.docker.com/engine/install/). ### 🚀 Iniciar o servidor @@ -376,4 +379,4 @@ Veja o [RAGFlow Roadmap 2025](https://github.com/infiniflow/ragflow/issues/4214) ## 🙌 Contribuindo O RAGFlow prospera por meio da colaboração de código aberto. Com esse espírito, abraçamos contribuições diversas da comunidade. -Se você deseja fazer parte, primeiro revise nossas [Diretrizes de Contribuição](./CONTRIBUTING.md). +Se você deseja fazer parte, primeiro revise nossas [Diretrizes de Contribuição](https://ragflow.io/docs/dev/contributing). diff --git a/README_tzh.md b/README_tzh.md index c52fb996a..5036dc8d4 100644 --- a/README_tzh.md +++ b/README_tzh.md @@ -111,7 +111,10 @@ - RAM >= 16 GB - Disk >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 - > 如果你並沒有在本機安裝 Docker（Windows、Mac，或 Linux）, 可以參考文件 [Install Docker Engine](https://docs.docker.com/engine/install/) 自行安裝。 +- [gVisor](https://gvisor.dev/docs/user_guide/install/): 僅在您打算使用 RAGFlow 的代碼執行器（沙箱）功能時才需要安裝。 + +> [!TIP] +> 如果你並沒有在本機安裝 Docker（Windows、Mac，或 Linux）, 可以參考文件 [Install Docker Engine](https://docs.docker.com/engine/install/) 自行安裝。 ### 🚀 啟動伺服器 @@ -365,7 +368,7 @@ docker build --platform linux/amd64 --build-arg NEED_MIRROR=1 -f Dockerfile -t i ## 🙌 貢獻指南 -RAGFlow 只有透過開源協作才能蓬勃發展。秉持這項精神,我們歡迎來自社區的各種貢獻。如果您有意參與其中,請查閱我們的 [貢獻者指南](./CONTRIBUTING.md) 。 +RAGFlow 只有透過開源協作才能蓬勃發展。秉持這項精神,我們歡迎來自社區的各種貢獻。如果您有意參與其中,請查閱我們的 [貢獻者指南](https://ragflow.io/docs/dev/contributing) 。 ## 🤝 商務合作 diff --git a/README_zh.md b/README_zh.md index 010884ea7..cdbe683c2 100644 --- a/README_zh.md +++ b/README_zh.md @@ -112,8 +112,10 @@ - RAM >= 16 GB - Disk >= 50 GB - Docker >= 24.0.0 & Docker Compose >= v2.26.1 - > 如果你并没有在本机安装 Docker（Windows、Mac，或者 Linux）, 可以参考文档 [Install Docker Engine](https://docs.docker.com/engine/install/) 自行安装。 - > [gVisor](https://gvisor.dev/docs/user_guide/install/) 是可选的，仅在你打算使用 RAGFlow 的代码执行器（沙箱）功能时才需要安装。 +- [gVisor](https://gvisor.dev/docs/user_guide/install/): 仅在你打算使用 RAGFlow 的代码执行器（沙箱）功能时才需要安装。 + +> [!TIP] +> 如果你并没有在本机安装 Docker（Windows、Mac，或者 Linux）, 可以参考文档 [Install Docker Engine](https://docs.docker.com/engine/install/) 自行安装。 ### 🚀 启动服务器 @@ -365,7 +367,7 @@ docker build --platform linux/amd64 --build-arg NEED_MIRROR=1 -f Dockerfile -t i ## 🙌 贡献指南 -RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的 [贡献者指南](./CONTRIBUTING.md) 。 +RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的 [贡献者指南](https://ragflow.io/docs/dev/contributing) 。 ## 🤝 商务合作 diff --git a/docs/contribution/_category_.json b/docs/contribution/_category_.json new file mode 100644 index 000000000..594fe200b --- /dev/null +++ b/docs/contribution/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Contribution", + "position": 8, + "link": { + "type": "generated-index", + "description": "Miscellaneous contribution guides." + } +} diff --git a/CONTRIBUTING.md b/docs/contribution/contributing.md similarity index 94% rename from CONTRIBUTING.md rename to docs/contribution/contributing.md index edd04e369..5d1ec19c1 100644 --- a/CONTRIBUTING.md +++ b/docs/contribution/contributing.md @@ -1,5 +1,14 @@ +--- +sidebar_position: 1 +slug: /contributing +--- + # Contribution guidelines +General guidelines for RAGFlow's community contributors. + +--- + This document offers guidelines and major considerations for submitting your contributions to RAGFlow. - To report a bug, file a [GitHub issue](https://github.com/infiniflow/ragflow/issues/new/choose) with us. diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 5764380bc..360761316 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -29,6 +29,11 @@ If you are on an ARM platform, follow [this guide](./develop/build_docker_image. - RAM ≥ 16 GB; - Disk ≥ 50 GB; - Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1. +- [gVisor](https://gvisor.dev/docs/user_guide/install/): Required only if you intend to use the code executor (sandbox) feature of RAGFlow. + +:::tip NOTE +If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/). +::: ## Start up the server