如何貢獻文件

簡介

本文件說明如何輕鬆貢獻文件。我將盡力讓所有人都能輕鬆協助編寫 Tomcat 文件,特別是 Connectors 文件。本文從 Windows 使用者的角度撰寫,因為我相信他們將受益最多。對於使用 Unix 的人來說,他們應該可以輕鬆套用這些步驟。只需在需要時替換 Unix 語法即可。

文件使用 xml 搭配 xsl 樣式表製作。這有效地將文件的內容與樣式分開,因此貢獻者只需要擔心內容即可。它比 html 容易使用許多。

其實一切都很簡單。以下是您需要的內容

  • 最新版本的 Ant
  • 從 Subversion 取得的 Connectors 原始碼
  • 任何 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

現在您應該會看到所有下載進度。現在您已在電腦上取得原始碼,困難的部分已經結束。從現在開始,要更新原始碼,您只需要在儲存庫中的任何目錄執行 git pull 指令。

步驟 3. 測試您的建置環境

開啟一個命令提示字元視窗,並將目錄變更為您下載原始碼的目錄。現在將目錄變更為 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. 編輯程序

在進行更新時,我發現使用兩個視窗比較容易。一個視窗我稱為我的建置視窗。我將此視窗保留在 GIT_HOME\tomcat-connectors\xdocs 目錄中,而且我只在此視窗中執行兩個指令:首先執行

ant clean
然後執行
ant all

我的第二個視窗我稱為我的編輯視窗,我將此視窗保留在 GIT_HOME\tomcat-connectors\xdocs 目錄中,我在此執行編輯、比對和 git pull。

在開始編輯之前,您應該始終更新您的本機儲存庫,以防止衝突。

C:\build\tomcat-connectors> git pull

現在您的儲存庫已更新,您可以開始編輯。在文件中找到要編輯的內容。找到內容後,記住檔案名稱。在您的編輯視窗中,找到並編輯具有相同名稱的 xml 原始碼檔案。完成後,返回到建置視窗,並在 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. 建立修補程式並提交

從您的編輯視窗將目錄變更為包含您正在處理的 xml 檔案的目錄,並執行 git pull 指令。例如,要產生 index.xml 檔案的比對,並將其稱為 patch.txt,您會將目錄變更為包含 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.dev.org.tw/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。

指南和資源