Brooklyn 网站与文档项目技术文档

1. 安装指南

1.1 工作站设置

1. 克隆仓库：首先，克隆 brooklyn 仓库及其子项目，并按照 [提交者指南][COMMIT] 设置远程仓库。

2. 安装 Ruby 和 RVM：项目使用 Jekyll 处理网站内容，因此需要 Ruby 和 gem。推荐使用 RVM 来管理 Ruby 安装和 gem 集。

   curl -sSL https://get.rvm.io | bash -s stable --auto-dotfiles
   

   关闭并重新打开终端，进入项目目录。RVM 会根据 Gemfile 配置自动配置环境。如果提示缺少 Ruby 版本，按照提示安装相应版本。

3. 安装依赖 Gem：

   bundle install
   

   如果遇到问题，可以参考 [提交者指南][COMMIT] 中的常见问题解决方法。

1.2 构建 PDF 文档（可选）

如果需要构建 PDF 文档，需安装 wkhtmltopdf。可以通过以下命令安装：

sudo apt-get install wkhtmltopdf

2. 项目的使用说明

2.1 查看网站和文档

在项目目录下运行以下命令，启动本地服务器并查看文档：

jekyll serve

服务器启动后，Jekyll 会输出本地访问地址（如 http://localhost:4000/）。修改文件后，Jekyll 会自动重新生成内容。

2.2 项目结构

项目包含两个微型站点：

• /website：主网站内容，包括提交者指令、下载说明和“了解更多”页面。
• /guide：用户指南和特定版本的 Brooklyn 信息，包括代码结构和 API 文档。

其他重要目录：

• /style：包含 JS、CSS 和图像资源。
• /_build：包含构建脚本和配置文件。
• /_plugins：包含 Jekyll 插件，提供标签和生成逻辑。
• /_layouts：包含页面使用的 HTML 模板。
• /_includes：包含模板和页面使用的杂项内容。

2.3 分支管理

• /website 可以针对任何分支构建，通常从 master 分支发布。
• /guide 应针对特定分支更新和构建，例如 master 或 0.7.0-M2。

3. 项目 API 使用文档

API 文档通常在 /guide 目录中生成。可以通过以下命令生成 API 文档：

_build/build.sh guide-version

生成的文档将位于 _site/v/<version>/ 目录下。

4. 项目安装方式

项目的安装主要依赖于 Ruby 和 Jekyll。按照 安装指南 中的步骤配置环境后，即可通过 jekyll serve 命令启动本地服务器，或通过 _build/build.sh 脚本进行更复杂的构建和发布操作。

4.1 构建脚本

_build/build.sh 脚本提供了多种构建选项，可以通过以下命令查看帮助：

_build/build.sh help

常用的构建选项包括：

• website-root：仅构建网站。
• guide-latest：构建最新版本的指南。
• guide-version：构建特定版本的指南。

4.2 发布网站和指南

发布到 Apache 网站需要将生成的 HTML 文件提交到 Apache Subversion 仓库。具体步骤请参考 [提交者指南][COMMIT]。

---

通过以上文档，您应该能够顺利安装、使用和了解 Brooklyn 网站与文档项目。如有任何问题，请参考项目 Wiki 或联系项目维护者。