Skip to content

Commit

Permalink
docs: Japanese translation of configuration page (#129)
Browse files Browse the repository at this point in the history 
* Translate index.md via GitLocalize

* fix broken structure

* fix translation of key/value
  • Loading branch information
@tk3fftk @tkyi
tk3fftk authored and tkyi committed Dec 20, 2017
1 parent d5904b3 commit 44def7b
Showing 1 changed file with 73 additions and 58 deletions.
131 changes: 73 additions & 58 deletions docs/ja/user-guide/configuration/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,88 +15,103 @@ toc:

各プロパティ名にマウスカーソルを乗せるとそれらの説明が表示されます。


<div class="yaml-docs">

<pre class="example">
<a href="#workflow"><span class="key">workflow</span>:
- <span class="value">publish</span>
- <span class="key">parallel</span>:
- <span class="key">series</span>:
- <span class="value">deploy-east</span>
- <span class="value">validate-east</span>
- <span class="key">series</span>:
- <span class="value">deploy-west</span>
- <span class="value">validate-west</span></a>
<a href="#shared"><span class="key">shared</span>:</a>
<a href="#environment"><span class="key">environment</span>:
<span class="key">NODE_ENV</span>: <span class="value">test</span></a>
<a href="#settings"><span class="key">settings</span>:</a>
<a href="#email"><span class="key">email</span>:
<span class="key">addresses</span>: <span class="value">[[email protected], [email protected]]</span>
<span class="key">statuses</span>: <span class="value">[SUCCESS, FAILURE]</span></a>
<a href="#annotations"><span class="key">annotations</span>:
<span class="key">beta.screwdriver.cd/my-cluster-annotation</span>: <span class="value">my-data</span></a>
<a href="#executor"><span class="key">beta.screwdriver.cd/executor</span>: <span class="value">k8s-vm</span></a>
<a href="#cpu"><span class="key">beta.screwdriver.cd/cpu</span>: <span class="value">HIGH</span></a>
<a href="#ram"><span class="key">beta.screwdriver.cd/ram</span>: <span class="value">LOW</span></a>
<a href="#jobs"><span class="key">jobs</span>:</a>
<a href="#main-job"><span class="key">main</span>:</a>
<a href="#image"><span class="key">image</span>: <span class="value">node:{{NODE_VERSION}}</span></a>
<a href="#matrix"><span class="key">matrix</span>:
<span class="key">NODE_VERSION</span>: <span class="value">[4,5,6]</span></a>
<span class="key">main</span>:
<a href="#requires"><span class="key">requires</span>: <span class="value">[~pr, ~commit, ~sd@123:main]</span></a>
<a href="#image"><span class="key">image</span>: <span class="value">node:6</span></a>
<a href="#steps"><span class="key">steps</span>:
- <span class="key">init</span>: <span class="value">npm install</span>
- <span class="key">test</span>: <span class="value">npm test</span></a>
<a href="#jobs"><span class="key">publish</span>:
<span class="key">requires</span>: <span class="value">main</span>
<span class="key">image</span>: <span class="value">node:6</span>
<span class="key">steps</span>:
- <span class="key">publish</span>: <span class="value">npm publish</span></a>
<a href="#jobs"><span class="key">deploy-west</span>:
<span class="key">requires</span>: <span class="value">publish</span>
<span class="key">image</span>: <span class="value">node:6</span>
<span class="key">environment</span>:
<span class="key">DEPLOY_ENV</span>: <span class="value">west</span>
<span class="key">steps</span>:
- <span class="key">init</span>: <span class="value">npm install</span>
- <span class="key">publish</span>: <span class="value">npm deploy</span></a>
- <span class="key">deploy</span>: <span class="value">npm deploy</span></a>
<a href="#jobs"><span class="key">deploy-east</span>:
<span class="key">requires</span>: <span class="value">publish</span>
<span class="key">image</span>: <span class="value">node:6</span>
<span class="key">environment</span>:
<span class="key">DEPLOY_ENV</span>: <span class="value">east</span>
<span class="key">steps</span>:
- <span class="key">init</span>: <span class="value">npm install</span>
- <span class="key">deploy</span>: <span class="value">npm deploy</span></a>
<a href="#jobs"><span class="key">finished</span>:
<span class="key">requires</span>: <span class="value">[deploy-west, deploy-east]</span>
<span class="key">image</span>: <span class="value">node:6</span>
<span class="key">steps</span>:
- <span class="key">echo</span>: <span class="value">echo done</span></a>
<a href="#jobs">...</a>
</pre>
<div class="yaml-side">
<div id="workflow" class="hidden">
<h4>Workflow</h4>
<p>パイプラインで実行されるジョブの順番を定義します。workflowで参照される全てのジョブはjosセクションに定義されている必要があります。</p>
<p>ジョブの実行は並列、順次、またはこの例のように両者の組み合わせも可能です。特別なキーワード <strong><em>parallel</em></strong> と <strong><em>series</em></strong> によりジョブのフローを定義できます。 デフォルトではworkflow内のジョブは<em>main</em>ジョブの成功後に順次実行されます。</p>
</div>
<div id="shared" class="hidden">
<h4>Shared</h4>
<p>全てのジョブの適用されるグローバル設定を定義します。Sharedの設定は各ジョブにマージされますが、それぞれのジョブで更に設定が行われている場合はその設定により上書きされます。</p>
</div>
<div id="environment" class="hidden">
<h4>Environment</h4>
<p>ビルドに必要な環境変数のキーと値の組み合わせです。ジョブに設定できる全ての設定はSharedにも設定できますが、ジョブの設定により上書きされます。</p>
</div>
<div id="settings" class="hidden">
<h4>Settings</h4>
<p>Configurable settings for any additional build plugins added to Screwdriver.cd.</p>
</div>
<div id="email" class="hidden">
<h4>Email</h4>
<p>Emails addresses to send notifications to and statuses to send notifications for.</p>
</div>
<div id="jobs" class="hidden">
<h4>Jobs</h4>
<p>ビルドの挙動を定義するジョブのリストです。</p>
</div>
<div id="main-job" class="hidden">
<h4>Main</h4>
<p>唯一の必須ジョブです。このジョブはコードに変更が行われた際に自動的に実行されます。</p>
</div>
<div id="image" class="hidden">
<h4>Image</h4>
<p>ビルドで利用されるDockerイメージを指定します。この例ではテンプレートを使用しており、{{NODE_VERSION}}のように波括弧で囲まれた変数が展開されます。 この変数はmatrixで指定されている値に変更され、それら複数のイメージを利用したビルドが並列に実行されます。</p>
</div>
<div id="matrix" class="hidden">
<h4>Matrix</h4>
<p>image設定にテンプレートが利用されている場合、そのジョブのビルドが複数のイメージを利用して並列に実行されます。</p>
</div>
<div id="steps" class="hidden">
<h4>Steps</h4>
<p>コマンドラインで入力するように、ビルドで実行されるコマンドのリストを定義します。同じジョブ内では、環境変数はステップ間で受け渡されます。ステップの定義は全てのジョブに必須です。Screwdriverのステップとして予約語になっているため、ステップ名を'sd-'で始めることはできません。Screwdriverは'/bin/sh'をステップ実行のために使用するため、異なるターミナルやシェルを使用すると予期せぬ振る舞いをするかもしれません。</p>
</div>
<div class="yaml-side">
<div id="requires" class="hidden">
<h4>Requires</h4>
<p>ジョブ実行のトリガーとなる1つまたは複数のジョブの配列を設定します。"requires: ~pr"が設定されたジョブはプルリクエストイベントにより実行されます。"requires: ~commit"が設定されたジョブはプッシュイベントにより実行されます。"requires: ~sd@123:main"が設定されたジョブはパイプライン"123"の"main"ジョブの完了により実行されます。"requires: [deploy-west, deploy-east]"が設定されたジョブは"deploy-west"と"deploy-east"の両方のジョブの成功後に実行されます。"注意: ~ のジョブはOR条件で、~ なしのジョブはジョインの働きをします。"</p>
</div>
<div id="shared" class="hidden">
<h4>Shared</h4>
<p>全てのジョブの適用されるグローバル設定を定義します。Sharedの設定は各ジョブにマージされますが、それぞれのジョブで更に設定が行われている場合はその設定により上書きされます。</p>
</div>
<div id="environment" class="hidden">
<h4>Environment</h4>
<p>ビルドに必要な環境変数のキーと値の組み合わせです。ジョブに設定できる全ての設定はSharedにも設定できますが、個別のジョブの設定により上書きされます。</p>
</div>
<div id="settings" class="hidden">
<h4>Settings</h4>
<p>Screwdriver.cdに追加されたビルドプラグインの設定です。</p>
</div>
<div id="annotations" class="hidden">
<h4>Annotations</h4>
<p>アノテーションはキーと値の組み合わせです。パイプラインまたはジョブ単位で設定することができます。アノテーションのキーと値は任意に設定することができ、例えば、ビルドの実行方法を変更することができます。Screwdriverのクラスタ管理者にビルドの実行方法を変更するために、どのようなアノテーションがサポートされているか確認してください。</p>
</div>
<div id="executor" class="hidden">
<h4>Executor annotation</h4>
<p>デフォルト以外のExecutorでのビルドを実行したい場合に設定します。`jenkins`, `k8s-vm`が設定可能です。</p>
</div>
<div id="cpu" class="hidden">
<h4>CPU annotation</h4>
<p>`k8s-vm` Executor を利用する場合にVMに割り当てられるCPUを設定します。`LOW`はデフォルトで設定され、2CPUが割り当てられ、`HIGH`は6CPU割り当てられます。</p>
</div>
<div id="ram" class="hidden">
<h4>RAM annotation</h4>
<p>`k8s-vm` Executor を利用する場合にVMに割り当てられるRAMを設定します。`LOW`はデフォルトで設定され、2GBのメモリが割り当てられ、`HIGH`は12GBのメモリが割り当てられます。</p>
</div>
<div id="email" class="hidden">
<h4>Email</h4>
<p>通知を送信するEmailアドレスと、通知を送信するステータスを設定します。</p>
</div>
<div id="jobs" class="hidden">
<h4>Jobs</h4>
<p>ビルドの挙動を定義するジョブのリストです。</p>
</div>
<div id="image" class="hidden">
<h4>Image</h4>
<p>ビルドで利用されるDockerイメージを指定します。ここでの設定は"docker pull"コマンドを利用する場合と同じものです。</p>
</div>
<div id="steps" class="hidden">
<h4>Steps</h4>
<p>コマンドラインで入力するように、ビルドで実行されるコマンドのリストを定義します。同じジョブ内では、環境変数はステップ間で受け渡されます。ステップの定義は全てのジョブに必須です。Screwdriverのステップとして予約語になっているため、ステップ名を'sd-'で始めることはできません。Screwdriverは'/bin/sh'をステップ実行のために使用するため、異なるターミナルやシェルを使用すると予期せぬ振る舞いをするかもしれません。</p>
</div>
</div>
</div>

0 comments on commit 44def7b

Please sign in to comment.