ドキュメントへの貢献方法

はじめに

このドキュメントでは、ドキュメントに簡単に貢献する方法について説明します。Tomcat、特にコネクタのドキュメントの作成を誰でも簡単に行えるようにしたいと思います。これは、Windows ユーザーの視点から書かれています。Unix を使用している人は、これらの手順を簡単に適用できるはずです。必要に応じて Unix の構文を置き換えてください。

ドキュメントは、xsl スタイルシート付きの xml を使用して作成されています。これにより、ドキュメントのコンテンツがスタイルから効果的に分離されるため、貢献者はコンテンツだけを気にする必要があります。HTML よりもはるかに使いやすいです。

すべては非常に簡単です。必要なものは次のとおりです。

  • 最近のバージョンの Ant
  • サブバージョンからのコネクタのソースコード
  • 任意の ASCII テキストエディタ

ステップバイステップの開始

これらのツールを入手したら、簡単にセットアップできます。

ステップ 1. Ant を入手する

Ant をインストールします。私からのアドバイスは、シンプルなインストールパスを選択することです。次に、ANT_HOME の環境変数を設定し、Ant/bin ディレクトリの場所を PATH 変数に追加します。この方法については、オペレーティングシステムのドキュメントを参照してください。終了したら、コマンドラインから ant を実行できることを確認します。

Ant は、とりわけドキュメントをビルドするために使用され、build.xml というファイルを確認できる必要があります。このファイルは xdocs ディレクトリにあります。build.xml ファイルには、ドキュメントをビルドするために使用される all という名前のターゲットがあります。

ステップ 2. ソースを入手する

tomcat-connectors のソースを git リポジトリから取得します。git クライアントが必要です。まだクライアントをお持ちでない場合は、お好みのクライアントをインストールしてください。

これで、ソースをダウンロードする準備ができました。リポジトリを置きたい場所にディレクトリを変更します。簡単にするために、これを GIT_HOME と呼びます。私の場合は C:\build にあります。

初めてソースを クローン するには、次のコマンドを実行します。これは一度だけ行う必要があります。

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

これで、すべてのダウンロードが表示されるはずです。これでソースがマシンにダウンロードされたので、難しい部分は終わりです。今後、ソースを更新するには、リポジトリ内の任意のディレクトリに cd し、git pull コマンドを実行するだけです。

ステップ 3. ビルド環境をテストする

コマンドプロンプトウィンドウを開き、ソースをダウンロードしたディレクトリに cd します。次に、Antbuild.xml ファイルを確認できるように、xdocs ディレクトリに cd します。次に、コマンドプロンプトから、次のコマンドを実行します。

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 ファイルの 1 つを開き、どのように表示されるかを確認してください。

ステップ 4. 編集プロセス

更新中は、2 つのウィンドウを使用する方が簡単だと思います。1 つは build ウィンドウと呼びます。これは GIT_HOME\tomcat-connectors\xdocs ディレクトリに保持し、このウィンドウでは 2 つのコマンドのみを実行します。まず、次を実行します。

ant clean
次に、次を実行します。
ant all

2 つ目のウィンドウは edit ウィンドウと呼び、編集、差分、git pull を行う GIT_HOME\tomcat-connectors\xdocs ディレクトリに保持します。

編集を開始する前に、競合を避けるために常にローカルリポジトリを更新する必要があります。

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 ウィンドウから、作業中の xml ファイルが含まれているディレクトリに cd し、git pull コマンドを実行します。たとえば、index.xml ファイルの差分を作成して patch.txt と呼ぶには、index.xml ファイルが含まれているディレクトリに cd し、次のようにします。

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

これで、パッチが作成され、送信する準備ができました。

ドキュメントへのパッチは、バグレポートと同じように処理されます。http://issues.apache.org/bugzilla/ にパッチを送信し、適切な 1 行の件名を含める必要があります。バグデータベースを初めて使用する場合は、http://issues.apach e.org/bugzilla/bugwritinghelp.html. を参照してください。ユーザーアカウントを作成する必要があります。Web サイトで、パッチを Web フォームに貼り付け、パッチの目的を説明することを忘れないでください。遅かれ早かれ、コミット権限を持つ誰かがあなたの提案を確認します。

Web サイトの更新

コミッターのみが Web サイト (https://tomcat.dokyumento.jp/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 に同期されます。

ガイドとリソース

必要に応じて、開始するための少しのヘルプを提供します。