ローカルでのウェブサイトのビルドと提供

3分で読めます

ウェブサイトへの貢献を行った後、変更が期待どおりにレンダリングされることを確認してください。変更をローカルでプレビューできるように、簡単にビルドして表示できるツールを用意しています。私たちはすべての貢献の品質をチェックするために自動化されたテストを使用しています。プルリクエスト（PR）で変更を送信する前に、ローカルでもテストを実行する必要があります。

始める前に

ローカルで実行するテストがIstio継続的インテグレーション（CI）で実行されるテストと同じバージョンを使用することを保証するために、サイトジェネレーターであるHugoを含む、必要なすべてのツールを含むDockerイメージを提供しています。

サイトをローカルでビルド、テスト、およびプレビューするには、システムにDockerをインストールする必要があります。

変更のプレビュー

サイトへの変更をプレビューするには、istio/istio.ioのフォークのルートに移動し、次のコマンドを実行します。

$ make serve

変更にビルドエラーがない場合、コマンドはサイトをビルドし、それをホストするローカルウェブサーバーを起動します。サイトのローカルビルドを表示するには、ウェブブラウザでhttps://#:1313にアクセスしてください。

リモートサーバーからサイトを作成して提供する必要がある場合は、ISTIO_SERVE_DOMAINを使用してサーバーのIPアドレスまたはDNSドメインを指定できます。例:

$ make ISTIO_SERVE_DOMAIN=192.168.7.105 serve

この例では、サイトをビルドし、192.168.7.105 IPアドレスのリモートサーバーでサイトをホストするウェブサーバーを起動します。前と同様に、http://192.168.7.105:1313でウェブサーバーに接続できます。

変更のテスト

私たちは、自動チェックを通じてサイトのコンテンツの品質基準を保証するために、リンターとテストを使用しています。これらのチェックは、お客様の貢献を承認するために、失敗なくパスする必要があります。PRを通じて変更をリポジトリに提出する前に、ローカルでチェックを実行してください。私たちは、以下の自動チェックを実行します。

HTMLプルーフ：他のチェックとともに、すべてのリンクが有効であることを保証します。
スペルチェック：コンテンツのスペルが正しいことを保証します。
Markdownスタイルチェック：使用されているマークアップが、当社のMarkdownスタイルルールに準拠していることを保証します。

これらのチェックをローカルで実行するには、次のコマンドを使用します

$ make lint

スペルチェッカーがエラーを報告する場合、最も可能性の高い原因は次のとおりです。

実際のタイプミス：Markdownファイルでタイプミスを修正してください。
エラーがコマンド、フィールド、またはシンボル名に対して報告された場合：エラーのあるコンテンツを`バッククォート`で囲みます。
エラーがツールの辞書にない正しい単語または固有名詞に対して報告された場合：`istio/istio.io`リポジトリのルートにある.spellingファイルに単語を追加してください。

インターネット接続が悪いと、リンクチェッカーで問題が発生する可能性があります。良好な接続が得られない場合は、外部リンクのチェックを防ぐようにチェッカーを設定できます。リンターを実行するときに、INTERNAL_ONLY環境変数をTrueに設定します。例：

$ make INTERNAL_ONLY=True lint

コンテンツがすべてのチェックに合格したら、PRを通じてリポジトリに送信してください。詳細については、GitHubの操作をご覧ください。