如何为文档做出贡献

简介

本文档介绍了如何轻松地为文档做出贡献。我将尝试让每个人都能轻松地帮助撰写 Tomcat 文档,特别是连接器文档。本文档是从 Windows 用户的角度编写的,因为我相信他们将从中受益匪浅。对于使用 Unix 的人来说,他们应该可以轻松地应用这些步骤。只需在需要时替换 Unix 语法即可。

文档使用带有 xsl 样式表的 xml 制作。这有效地将文档内容与样式分离开来,因此所有贡献者只需要关注内容即可。它比 html 更容易使用。

这一切都非常简单。以下是您需要的内容

  • 最新版本的 Ant
  • 来自 Subversion 的连接器源代码
  • 任何 ascii 文本编辑器

逐步入门

获取这些工具后,设置起来很简单。

步骤 1. 获取 Ant

安装 Ant。我唯一的建议是选择一个简单的安装路径。现在为 ANT_HOME 设置一个环境变量,然后将 Ant/bin 目录的位置添加到您的 PATH 变量中。有关如何执行此操作的信息,请查阅您的操作系统文档。完成后,验证您是否可以从命令行运行 ant。

Ant 用于构建文档(除其他事项外),并且它必须能够看到名为 build.xml 的文件。此文件位于 xdocs 目录中。在 build.xml 文件中,有一个名为 all 的目标,该目标将用于构建文档。

步骤 2. 获取源代码

从 git 存储库获取 tomcat-connectors 的源代码。您将需要一个 git 客户端。如果您还没有,请安装您选择的客户端。

现在您可以下载源代码了。将目录更改为希望将存储库所在的位置。为了简单起见,我们将称之为您的GIT_HOME。我的位于 C:\build 中。

运行以下命令以首次克隆源代码。您只需执行此操作一次。

C:\build\>git clone https://github.com/apache/tomcat-connectors tomcat-connectors

现在您应该会看到所有下载内容都已下载。现在您已在计算机上拥有了源代码,最困难的部分已经结束。从现在起,要更新源代码,您只需在存储库中的任何目录中输入 cd 并运行git pull命令即可。

步骤 3. 测试您的构建环境

打开命令提示符窗口,并将 cd 输入到下载源代码的目录中。现在将 cd 输入到 xdocs 目录中,以便Ant可以看到build.xml文件。然后从命令提示符中运行以下内容

C:\build\tomcat-connectors> cd xdocs
C:\build\tomcat-connectors\xdocs> ant all

.

您应该会看到 ant 编译器消息快速滚动,然后停止,并显示以下内容

[style] Transforming into C:\build\tomcat-connectors\build\docs\news\printer>
[style] Processing C:\build\tomcat-connectors\xdocs\news\20041100.xml 
to
C:\build\tomcat-connectors\build\docs\news/20041100.html
[style] Loading stylesheet C:\build\tomcat-connectors\xdocs\style.xsl
[style] Processing C:\build\tomcat-connectors\xdocs\news\20050101.xml 
to
C:\build\tomcat-connectors\build\docs\news/20050101.html
[style] Processing C:\build\tomcat-connectors\xdocs\news\20060101.xml 
to
C:\build\tomcat-connectors\build\docs\news/20060101.html
[style] Transforming into C:\build\tomcat-connectors\build\docs>
[style] Processing C:\build\tomcat-connectors\xdocs\index.xml 
to
C:\build\tomcat-connectors\build\docs\index.html
[style] Loading stylesheet C:\build\tomcat-connectors\xdocs\style.xsl
 
BUILD SUCCESSFUL
Total time: 10 seconds
C:\build\tomcat-connectors>

xdocs 目录结构中存在的所有 xml 文件都已转换为 html,并复制到GIT_HOME\tomcat-connectors\build\docs目录中。在浏览器中打开其中一个 html 文件,看看它是什么样子。

步骤 4. 编辑过程。

在执行更新时,我发现使用两个窗口会更容易。我将其中一个称为我的build窗口。我将此窗口保留在GIT_HOME\tomcat-connectors\xdocs目录中,并且只在此窗口中运行两个命令:首先我运行

ant clean
然后我运行
ant all

我将第二个窗口称为我的edit窗口,并将此窗口保留在GIT_HOME\tomcat-connectors\xdocs目录中,在此目录中执行编辑、差异和 git 拉取操作。

在开始编辑之前,您应始终更新本地存储库以防止冲突。

C:\build\tomcat-connectors> git pull

现在您的存储库已是最新的,您可以开始编辑了。在文档中找到要编辑的内容。找到内容后,记住文件名。在您的edit窗口中,找到并编辑具有相同名称的 xml 源文件。完成后,返回到build窗口,并在GIT_HOME\tomcat-connectors\xdocs目录中运行

C:\build\tomcat-connectors\xdocs> ant clean

这将删除所有以前的 html 文件,并使该区域准备好更新资料。现在,要制作包含您更改的新文档,请运行

C:\build\tomcat-connectors\xdocs> ant all

使用浏览器查看您刚刚进行的编辑,它们将位于GIT_HOME\tomcat-connectors\build\docs子树中。如果看起来不错并且已准备就绪,那么剩下的就是创建补丁并提交它。

步骤 5. 创建补丁并提交它。

从您的edit窗口 cd 进入包含您正在处理的 xml 文件的目录,并运行git pull命令。例如,要生成 index.xml 文件的差异并将其称为 patch.txt,您需要 cd 进入包含 index.xml 文件的目录,然后

C:\build\tomcat-connectors\xdocs\>git diff index.xml >  
patch.txt.

现在您已拥有补丁,可以准备发送它了。

文档补丁的处理方式与错误报告相同。您应将补丁提交至 http://issues.apache.org/bugzilla/,并附上简洁的一行主题。如果您是首次使用错误数据库,则应阅读 http://issues.apach e.org/bugzilla/bugwritinghelp.html. 您需要创建一个用户帐户。在网站上,将补丁粘贴到网络表单中,不要忘记描述补丁的用途。迟早,具有提交权限的人员会审阅您的建议。

更新网站

只有提交者才能更新网站 (https://tomcat.ac.cn/connectors-doc/)。要执行此操作,请

  • 连接到 people.apache.org。
  • umask 002
  • 将已更改的文件复制到 /www/tomcat.apache.org/connectors-doc/。
  • 或从检出 tomcat/jk/trunk/xdocs 存储库中使用 ant
    ant -Dbuild.dir=/www/tomcat.apache.org -Ddist.name=connectors-doc
  • 这些更改应在几秒钟内同步到 tomcat.apache.org。

指南和资源