Coolify 文档贡献指南

本指南概述了为文档贡献更新和修复的流程。请按照以下步骤确保流畅高效的工作流程。

1. 仓库工作流

• 发布流程：
  我们遵循每周生产发布周期。main 分支代表生产环境，而 next 分支用作我们的开发分支。

• 分支指南：

  • 不要向 main 分支创建拉取请求（PR）。
  • 所有贡献都应针对 next 分支进行。
  • 从 next 分支克隆仓库 到您的 GitHub 账户，然后开始进行更改。

2. 入门指南

步骤 1：Fork 并克隆仓库

• 首先将文档仓库 fork 到您的 GitHub 账户，然后使用以下命令将 fork 后的仓库克隆到本地系统：

  git clone https://github.com/your-username/your-repo-name.git

• 进入克隆的仓库目录：

  cd your-repo-name

步骤 2：安装依赖并运行开发服务器

我们使用 bun 作为本地开发的首选包管理器。如果您选择使用其他包管理器，请不要在提交中包含其配置文件。

要设置您的环境，请运行：

bun install && bun run dev

开发服务器将在 localhost 的 5173 端口启动。您可以通过访问以下地址查看文档：

http://localhost:5173/docs/

3. 图片指南

• 格式：
  文档中使用的所有图片必须为 .webp 格式。

• 位置：
  将所有图片文件放置在 /docs/public 目录中。

• 用法：
  在文档中使用可缩放图片组件来添加您的图片

  <ZoomableImage src="path-to-the-image.webp" alt="Path To The Image" />

4. 编写和结构化内容

文档最佳实践：

• 清晰简洁的语言：
  使用简单易懂的英语。请记住，并非所有读者都是英语母语者。

• 面向初学者的指南：
  将说明分解为小而易于遵循的步骤。尽可能包含截图以帮助可视化流程，特别是对于刚开始使用自托管或 Coolify 的用户。

• 内容组织：
  使用清晰的标题、项目符号和编号步骤来组织内容。这有助于读者更好地跟随。

5. 提交您的贡献

1. 将您的更改提交到仓库

2. 创建拉取请求：

   • 打开一个拉取请求（PR），将您的更改合并到文档仓库的 next 分支。
   • 提供详细的更新描述，以帮助维护者有效审查您的贡献。

6. 问题与支持

如果您在贡献过程中有任何疑问或遇到问题：

• 创建 Issue： 在仓库中打开一个 Issue，详细说明您的问题。
• Discord： 在 Coolify Discord 社区 的贡献频道联系我们。

7. 重要提示

• 文档更新：
  当前文档有些过时且缺少一些信息。在添加新内容之前，文档维护者正在积极重写部分文档以改进结构和清晰度。

• PR 审批：
  您的 PR 合并需经维护者审查。请耐心等待，因为他们正在处理流程。

我们感谢您为让 Coolify 文档对所有人更好所做出的贡献和努力。