[このドキュメントの単一ページ版もご覧いただけます。]

ウェブサイトの変更

はじめに

Subversionプロジェクトは、ウェブサイトの改善を歓迎します。ただし、ブラウザで「名前を付けて保存」をクリックして編集し、変更を送信するほど単純ではありません。 実際、多くのページは3つ以上のファイルで構成されているため、ブラウザは正しくレンダリングされたコピーを保存しません。

このため、大幅な変更を送信する予定がある場合は、ソースのコピーを取得し、テストミラーを設定して変更を確認することをお勧めします。

もちろん、小さな変更の場合は、パッチを視覚的に検査するだけで十分な場合がよくあります。

ウェブサイトのソースを取得する

ウェブサイトのソースは、Subversionリポジトリから入手できます。ソースを参照するには、 https://svn.apache.org/repos/asf/subversion/site/ にアクセスしてください。

このページの残りの部分で使用される場所である~/projects/svnにコピーをダウンロードするには、次のコマンドを使用します

  mkdir -p ~/projects/svn
  cd ~/projects/svn
  svn co https://svn.apache.org/repos/asf/subversion/site/ site

別の場所にダウンロードする場合は、Webサーバーの設定でパスを調整して、そこを指すようにする必要があります。

テスト用のミラーを設定する

Subversion Webサイトは、*サーバーサイドインクルード(SSI)*を使用してWebサーバー内でページを組み立てます。 つまり、加えたい変更を検証するには、システムにインストールされているサーバー(Apache 2.2 または Apache 2.4)に接続されたWebブラウザで関連ページを表示する必要があります。

次の手順では、UnixタイプのシステムでSubversion Webサイトのローカルコピーを正しくレンダリングする* Apache仮想ホスト*を提供する必要があります。 これは、システムに応じて、/etc/apache2、/etc/httpd、または類似のディレクトリにある可能性があります。 これらの手順は、Apache 2.2およびApache 2.4でテストされています。

  1. 上記のセクションで説明されているように、Webサイトのソースを取得します。
    以下の説明では、これらがディレクトリ/home/user/projects/svn/siteにあると想定します
  2. 上記の作業コピー内の`site/publish`ディレクトリを、メインサーバーまたはVirtualHostのDocumentRootとして使用するようにApacheサーバーを構成します。
  3. Apacheサーバーに`mod_include.so`が含まれていることを確認してください
  4. 関連するDocumentRootのサーバーサイドインクルードを有効にします. 関連するApacheディレクティブは次のとおりです
    Options +Includes
    
  5. 関連するDocumentRootのhtmlファイルのSSI解析をオンにします。 関連するApacheディレクティブは次のとおりです
    AddOutputFilter INCLUDES .html
    

すべてをまとめると、VirtualHost構成の例は次のとおりです

<VirtualHost *:8080>
        ServerAdmin webmaster@localhost

        DocumentRoot /home/user/projects/svn/site/publish
        <Directory /home/user/projects/svn/site/publish/>
                Options +Includes
                AddOutputFilter INCLUDES .html
        </Directory>

        ErrorLog ${APACHE_LOG_DIR}/error.log

        # Possible values include: debug, info, notice, warn, error, crit,
        # alert, emerg.
        LogLevel debug

        CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

サーバーを再起動またはリロードした後、次のリンクを使用すると、* SubversionコミュニティガイドのWeb変更*ページのコピーが表示されます:

http://127.0.0.1:8080/docs/community-guide/web.html#web_mirror

変更の検証

ウェブサイトに大幅な変更を加えるすべてのパッチを検証してください.

このページのアドバイスに従ってWebサイトのミラーを設定した場合は、コマンドラインを使用して、変更したページの正しくレンダリングされたコピーを次のように取得します

wget http://127.0.0.1:8080/docs/community-guide/YOUR_CHANGED_PAGE.html

次に、結果のファイルをHTMLバリデーター(たとえば、W3Cバリデーターサービス)にアップロードします。

パッチとログメッセージの作成

プロジェクトのWebページに関するパッチのログメッセージを作成する場合、たとえば

https://subversion.dokyumento.jp/docs/community-guide/some_page.html#section-name

ログメッセージのパッチで変更されたファイルの名前を`site/`ディレクトリからの相対パスでリストし、追加または変更されたセクションのアンカーを次のようにリストします

 * docs/community-guide/some_page.html
   (section-name): fixed issue xyz

Subversionパッチ要件の詳細については、プロジェクトの一般的なパッチガイドラインログメッセージガイドラインに従ってください。