### What problem does this PR solve? ### Type of change - [x] Documentation Updatetags/v0.19.0
| - RAM >= 16 GB | - RAM >= 16 GB | ||||
| - Disk >= 50 GB | - Disk >= 50 GB | ||||
| - Docker >= 24.0.0 & Docker Compose >= v2.26.1 | - 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 | ### 🚀 Start up the server | ||||
| ## 🙌 Contributing | ## 🙌 Contributing | ||||
| RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community. | 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. |
| - RAM >= 16 GB | - RAM >= 16 GB | ||||
| - Disk >= 50 GB | - Disk >= 50 GB | ||||
| - Docker >= 24.0.0 & Docker Compose >= v2.26.1 | - 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 | ### 🚀 Menjalankan Server | ||||
| ## 🙌 Kontribusi | ## 🙌 Kontribusi | ||||
| RAGFlow berkembang melalui kolaborasi open-source. Dalam semangat ini, kami menerima kontribusi dari komunitas. | 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). |
| - RAM >= 16 GB | - RAM >= 16 GB | ||||
| - Disk >= 50 GB | - Disk >= 50 GB | ||||
| - Docker >= 24.0.0 & Docker Compose >= v2.26.1 | - 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/) を参照してください。 | |||||
| ### 🚀 サーバーを起動 | ### 🚀 サーバーを起動 | ||||
| ## 🙌 コントリビュート | ## 🙌 コントリビュート | ||||
| RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず [コントリビューションガイド](./CONTRIBUTING.md)をご覧ください。 | |||||
| RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず [コントリビューションガイド](https://ragflow.io/docs/dev/contributing)をご覧ください。 |
| - RAM >= 16 GB | - RAM >= 16 GB | ||||
| - Disk >= 50 GB | - Disk >= 50 GB | ||||
| - Docker >= 24.0.0 & Docker Compose >= v2.26.1 | - 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/)>)를 참조하세요. | |||||
| ### 🚀 서버 시작하기 | ### 🚀 서버 시작하기 | ||||
| ## 🙌 컨트리뷰션 | ## 🙌 컨트리뷰션 | ||||
| RAGFlow는 오픈소스 협업을 통해 발전합니다. 이러한 정신을 바탕으로, 우리는 커뮤니티의 다양한 기여를 환영합니다. 참여하고 싶으시다면, 먼저 [가이드라인](./CONTRIBUTING.md)을 검토해 주세요. | |||||
| RAGFlow는 오픈소스 협업을 통해 발전합니다. 이러한 정신을 바탕으로, 우리는 커뮤니티의 다양한 기여를 환영합니다. 참여하고 싶으시다면, 먼저 [가이드라인](https://ragflow.io/docs/dev/contributing)을 검토해 주세요. |
| - RAM >= 16 GB | - RAM >= 16 GB | ||||
| - Disco >= 50 GB | - Disco >= 50 GB | ||||
| - Docker >= 24.0.0 & Docker Compose >= v2.26.1 | - 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 | ### 🚀 Iniciar o servidor | ||||
| ## 🙌 Contribuindo | ## 🙌 Contribuindo | ||||
| O RAGFlow prospera por meio da colaboração de código aberto. Com esse espírito, abraçamos contribuições diversas da comunidade. | 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). |
| - RAM >= 16 GB | - RAM >= 16 GB | ||||
| - Disk >= 50 GB | - Disk >= 50 GB | ||||
| - Docker >= 24.0.0 & Docker Compose >= v2.26.1 | - 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/) 自行安裝。 | |||||
| ### 🚀 啟動伺服器 | ### 🚀 啟動伺服器 | ||||
| ## 🙌 貢獻指南 | ## 🙌 貢獻指南 | ||||
| RAGFlow 只有透過開源協作才能蓬勃發展。秉持這項精神,我們歡迎來自社區的各種貢獻。如果您有意參與其中,請查閱我們的 [貢獻者指南](./CONTRIBUTING.md) 。 | |||||
| RAGFlow 只有透過開源協作才能蓬勃發展。秉持這項精神,我們歡迎來自社區的各種貢獻。如果您有意參與其中,請查閱我們的 [貢獻者指南](https://ragflow.io/docs/dev/contributing) 。 | |||||
| ## 🤝 商務合作 | ## 🤝 商務合作 | ||||
| - RAM >= 16 GB | - RAM >= 16 GB | ||||
| - Disk >= 50 GB | - Disk >= 50 GB | ||||
| - Docker >= 24.0.0 & Docker Compose >= v2.26.1 | - 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/) 自行安装。 | |||||
| ### 🚀 启动服务器 | ### 🚀 启动服务器 | ||||
| ## 🙌 贡献指南 | ## 🙌 贡献指南 | ||||
| RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的 [贡献者指南](./CONTRIBUTING.md) 。 | |||||
| RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的 [贡献者指南](https://ragflow.io/docs/dev/contributing) 。 | |||||
| ## 🤝 商务合作 | ## 🤝 商务合作 | ||||
| { | |||||
| "label": "Contribution", | |||||
| "position": 8, | |||||
| "link": { | |||||
| "type": "generated-index", | |||||
| "description": "Miscellaneous contribution guides." | |||||
| } | |||||
| } |
| --- | |||||
| sidebar_position: 1 | |||||
| slug: /contributing | |||||
| --- | |||||
| # Contribution guidelines | # Contribution guidelines | ||||
| General guidelines for RAGFlow's community contributors. | |||||
| --- | |||||
| This document offers guidelines and major considerations for submitting your contributions to RAGFlow. | 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. | - To report a bug, file a [GitHub issue](https://github.com/infiniflow/ragflow/issues/new/choose) with us. |
| - RAM ≥ 16 GB; | - RAM ≥ 16 GB; | ||||
| - Disk ≥ 50 GB; | - Disk ≥ 50 GB; | ||||
| - Docker ≥ 24.0.0 & Docker Compose ≥ v2.26.1. | - 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 | ## Start up the server | ||||