Coolify 中文文档

中文

English

中文

English

Appearance

Coolify 文档贡献指南 ​

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

1. 仓库工作流 ​

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

  • 分支指南：

    • 不要向 main 分支创建拉取请求（PR）。
    • 所有贡献应提交到 next 分支。
    • 从 next 分支克隆仓库到你的 GitHub 账户，然后开始处理你的更改。

2. 入门指南 ​

步骤 1：复刻并克隆仓库 ​

  • 首先将文档仓库复刻到你的 github 账户，然后使用以下命令将你的复刻克隆到本地系统：
    sh

git clone https://github.com/你的用户名/你的仓库名称.git

- 导航到克隆的仓库：
  ```sh
cd 你的仓库名称

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

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

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

bash
bun install && bun run dev

开发服务器将在 localhost 的 5173 端口启动。你可以通过导航到以下地址查看文档：

bash
http://localhost:5173/docs/

3. 图像指南 ​

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

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

  • 使用： 在文档上使用可缩放的图像组件来附加你的图像

    vue
    <ZoomableImage src="path-to-the-image.webp" />

4. 编写和组织内容 ​

文档最佳实践： ​

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

  • 对初学者友好的指南： 将说明分解为小而易于遵循的步骤。尽可能包含屏幕截图以帮助可视化流程，尤其是对于自托管或 Coolify 新手用户。

  • 内容组织： 使用清晰的标题、项目符号和编号步骤来组织你的内容（如适用）。这使读者更容易跟随。

5. 提交你的贡献 ​

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

  2. 创建拉取请求：

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

6. 问题和支持 ​

如果你在贡献过程中有任何问题或遇到困难：

  • **创建问题：**在仓库上打开一个问题，详细描述你的问题。
  • **Discord：**在 Coolify Discord 社区 的 contribute 频道联系我们。

7. 重要说明 ​

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

  • PR 批准： 你的 PR 的合并需经维护者审查。请耐心等待他们完成流程。

我们感谢你为使 Coolify 文档对每个人都更好而做出的贡献和努力。