docs: Japanese translation 2024-10 (#617)

Co-authored-by: Yuta Kaneda <[email protected]>

docs/ja/user-guide/api.md

@@ -27,6 +27,8 @@ toc:
   url: "#バッジ"
 - title: 設計思想
   url: "#設計思想"
+- title: ペイロードサイズの制限
+  url: "#ペイロードサイズの制限"
 - title: 自作する
   url: "#自作する"
 ---
@@ -59,11 +61,13 @@ Swaggerモデル:
 ![Swagger model](../../user-guide/assets/swagger-model.png)
 
 ### Bearer Tokenの取得
+
 1. Screwdriver UIにログインした後、[https://api.screwdriver.cd/v4/auth/token](https://api.screwdriver.cd/v4/auth/token)またはあなたの`<API URL>/v4/auth/token`にアクセスしてBearer Tokenを取得します。
 ![Swagger Get Bearer Token](../../user-guide/assets/swagger-get-bearer-token.jpg)
 
 2. 次に、[API documentation](https://api.screwdriver.cd/v4/documentation)またはあなたの `<API URL>/v4/documentation` に戻り、🔒アイコンをクリックして、以下のようにBearer Tokenを入力します。
 ![Swagger Use bearer token](../../user-guide/assets/swagger-use-bearer-token.png)
+
 ### RESTクライアント経由で実行する
 
 [Postman](https://www.getpostman.com/)のようなRESTクライアントをAPIリクエストに使用します。その際、認証トークンが必要です。認証トークンを取得するためには、`/v4/auth/login`からログインし、リダイレクト先の`/v4/auth/token`からトークンをコピーしてください。詳しくは[認証と認可](#認証と認可)をご覧ください。
@@ -110,15 +114,16 @@ start_request = post('https://api.screwdriver.cd/v4/builds', headers=headers, da
 ## 認証と認可
 
 認証のために、[JSON Web Tokens (JWT)](http://jwt.io) を使用しています。JWTは`Authorization`ヘッダを必要とします。
-* Oauthを利用してJWTを生成するには、`/v4/auth/login` にアクセスします。こちらのエンドポイントにアクセスすると、`/v4/auth/token` に自動でリダイレクトされます。
-* ScrewdriverのAPIトークンを利用してJWTを生成するには、APIトークンをクエリパラメータの`api_token`に設定して`/v4/auth/token`へ`GET`リクエストを送信します。
+
+- Oauthを利用してJWTを生成するには、`/v4/auth/login` にアクセスします。こちらのエンドポイントにアクセスすると、`/v4/auth/token` に自動でリダイレクトされます。
+- ScrewdriverのAPIトークンを利用してJWTを生成するには、APIトークンをクエリパラメータの`api_token`に設定して`/v4/auth/token`へ`GET`リクエストを送信します。
 
 [認可](./authentication-authorization)はSCMにより行われます。ScrewdriverはSCMトークンで以下を識別します。
 
 - レポジトリへのread, write, adminアクセスを識別します。
-    - read権限でpipelineを見ることができます。
-    - write権限でjobの開始と停止ができます。
-    - admin権限でpipelineの作成、編集、削除ができます。
+  - read権限でpipelineを見ることができます。
+  - write権限でjobの開始と停止ができます。
+  - admin権限でpipelineの作成、編集、削除ができます。
 - リポジトリの`screwdriver.yaml`の読み込み
 - リポジトリに対するオープン中のpull-requestのリストを取得
 - ビルドの成功・失敗情報でpull-requestを更新
@@ -151,6 +156,10 @@ ScrewdriverのAPIは次の三原則を念頭に設計されました。
 2. 意図がわかりやすく、人間が読みやすくするため、リソースはREST-fulであるべきで、操作は小さく区切るべき
 3. クライアントのコード自動生成を可能にするため、APIにはバージョンがあり自己文書化されているべき
 
+## ペイロードサイズの制限
+
+APIでは、リクエストごとのペイロードサイズが最大1MBに制限されています。これは、APIサーバーが基づいている[Hapiフレームワーク](https://hapi.dev/)の制約によるものです。このサイズを超えるリクエストは受け付けられませんので、APIの利用設計を適切に行ってください。
+
 ## 自作する
 
 Swaggerドキュメントを作成したい場合は、次のJSONを参考にしてください:

docs/ja/user-guide/configuration/workflow.md

@@ -23,6 +23,8 @@ toc:
   url: "#他のパイプラインからのトリガー"
 - title: リモートジョイン
   url: "#リモートジョイン"
+- title: 注意
+  url: "#注意"
 - title: Blocked By
   url: "#blocked-by"
 - title: ジョブの凍結
@@ -40,12 +42,12 @@ Screwdriver は全てのパイプラインに対し、SCM のイベントに対
 `~pr`イベントはプルリクエストがオープン・再オープン・更新された場合に、`~commit`イベントはパイプラインのブランチに対してコミットが行われた場合に発生します。
 パイプラインを手動で開始した場合、`~commit`トリガーを持つ全てのジョブのビルドが開始します。
 
-|keyword|description|
-|:--|:--|
-| ~pr | プルリクエストがオープン・再オープン・更新された場合にイベントが発生します。|
-| ~commit | パイプラインのブランチに対してコミットが行われた場合にイベントが発生します。パイプラインを手動で開始した場合、`~commit`トリガーを持つ全てのジョブのビルドが発生します。|
-| ~tag | タグが作成された際にイベントが発生します。scmとしてGitHubを利用している場合のみこのトリガーを使うことができます。|
-| ~release | リリースされたときにイベントが発生します。scmとしてGitHubを利用している場合のみこのトリガーを使うことができます。|
+| Keyword  | Description                                                                                                                                  |
+| :------- | :------------------------------------------------------------------------------------------------------------------------------------------- |
+| ~pr      | プルリクエストがオープン・再オープン・更新された場合にイベントが発生します。                                                                              |
+| ~commit  | パイプラインのブランチに対してコミットが行われた場合にイベントが発生します。パイプラインを手動で開始した場合、`~commit`トリガーを持つ全てのジョブのビルドが発生します。 |
+| ~tag     | タグが作成された際にイベントが発生します。scmとしてGitHubを利用している場合のみこのトリガーを使うことができます。                                              |
+| ~release | リリースされたときにイベントが発生します。scmとしてGitHubを利用している場合のみこのトリガーを使うことができます。                                              |
 
 [タグとリリーストリガーのサンプルリポジトリ](https://github.com/screwdriver-cd-test/tag-trigger-example)も参考にしてください。
 
@@ -57,7 +59,7 @@ Screwdriver は全てのパイプラインに対し、SCM のイベントに対
 
 以下の例では、`main` ジョブは SCM のプルリクエスト、*または*コミットイベントをトリガーに開始されます。`second` ジョブは `main` ジョブが成功した後に開始されます。
 
->プルリクエストによって開始されたジョブは、chainPRのアノテーションが使用されていないと後続のジョブをトリガーしないことに注意してください。たとえば、プルリクエストが開かれた結果として `main`が開始し成功した場合、` second`はその後に開始しません。
+> プルリクエストによって開始されたジョブは、chainPRのアノテーションが使用されていないと後続のジョブをトリガーしないことに注意してください。たとえば、プルリクエストが開かれた結果として `main`が開始し成功した場合、` second`はその後に開始しません。
 
 ```
 jobs:
@@ -78,7 +80,6 @@ jobs:
 
 サンプルリポジトリ: <https://github.com/screwdriver-cd-test/workflow-sequential-example>
 
-
 ## 並列実行と結合
 
 1つのジョブを複数のジョブの`require`に指定すると複数のジョブを並列に実行できます。1つのジョブの`require`に並列に実行されるジョブを指定すると並列に実行されるジョブを結合することができます。
@@ -113,9 +114,11 @@ jobs:
 サンプルリポジトリ: <https://github.com/screwdriver-cd-test/workflow-parallel-join-example>
 
 ### OR ワークフロー
+
 Joinに似ていますが、_OR_は`requires`のジョブのいずれかが成功すると開始します。これは、必要なジョブにチルダ (`~`) プレフィックスを追加することで実現されます。
 
 #### 例
+
 次の例では、`first` _OR_ `second` のいずれかが正常に完了した後、`last` のジョブが一度だけ起動します。
 
 ```
@@ -135,6 +138,7 @@ jobs:
 ```
 
 ## ブランチフィルター
+
 ブランチフィルターは、パイプラインの特定のブランチのイベントをトリガーにすることができます。特定のブランチに対してコミットされた後にパイプラインでジョブをトリガーするには、 `[ ~commit：branchName ]` を使用します。特定のブランチに対してプルリクエストが作成された後にパイプラインでジョブをトリガーするには、`[ ~pr：branchName] `を使用します。ブランチは([JavaScript仕様の](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions))正規表現を用いて指定することもできます（例: `~commit：/^feature-/`）。正規表現のフラグはサポートしていません。
 
 ### 例
@@ -170,9 +174,11 @@ _注意: ブランチに対するPRのワークフローは、そのブランチ
 [ブランチフィルターのサンプルリポジトリ](https://github.com/screwdriver-cd-test/branch-filtering-example)を参考にしてください。ブランチフィルターがプルリクエストに対してどう動作するのかを見るのなら、[プルリクエストの例](https://github.com/screwdriver-cd-test/branch-filtering-example/pull/2)を参考にしてください。
 
 ## タグフィルターとリリースフィルター
+
 タグフィルター/リリースフィルターを使用して、特定の名称の`~tag`/`~release`イベントをトリガーにすることができます。特定の名称のタグが作成された後にパイプラインでジョブをトリガーするには、`requires: [~tag:tagName]`を使用します。特定の名称のリリースがされた後にパイプラインでジョブをトリガーするには、`requires: [~release:releaseName]`を使用します。`tagName`と`releaseName`は([JavaScript仕様の](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions))正規表現を用いて指定することもできます（例: `~release：/^feature-/`）。正規表現のフラグはサポートしていません。
 
 ### 例
+
 以下の例では、`stable`という名称のリリースがされると、`all-tag-and-release`と `stable-release`がトリガーされます。また、`v1.0`という名称のタグが作成されると、`all-tag-and-release`と `v1-tag`がトリガーされます。`v2.0`という名称のタグが作成されると、`all-tag-and-release`がトリガーされます。
 
 ```
@@ -261,7 +267,10 @@ jobs:
     requires: [~sd@3:main]
 ```
 
-#### 注意
+### 注意
+
+_リモートトリガーやリモートジョインをワークフローで使用する際の制限事項や特別な考慮点_
+
 - 下流のジョブ（e.g.: 例えば、上記の pipeline 2 や pipeline 4）では、現在外部トリガーのスタート node に対する `AND` 条件 (e.g.: `requires: [sd@3:main]` や `requires: [sd@3:main, sd@1:main]`) をサポートしていません。これらの node に対しては `OR` 条件 (e.g.: `requires: [~sd@3:main]` や `requires: [~sd@3:main, ~sd@1:main]`) を使用してください。
 - この機能は、1段の深さの外部依存だけに有効です。
 - この機能は、現在PR chain 機能とともには利用できません。
@@ -299,6 +308,7 @@ jobs:
 サンプルリポジトリ: <https://github.com/screwdriver-cd-test/workflow-blockedby-example>
 
 ## ジョブの凍結
+
 `freezeWindows`を使うことでジョブを凍結させ、特定の時間帯にそれらが実行されないようにすることができます。設定値としてcron式またはそれらのリストを取ります。タイムゾーンはUTCです。
 
 ジョブが開始される前に、設定されたcron式のいずれかに開始時刻が該当するかどうかがチェックされ、該当する場合はジョブが凍結されます。 現在のcron式が明けるとすぐに、ジョブは凍結が解除されて実行されます。
@@ -310,6 +320,7 @@ jobs:
 - デフォルトでは、ジョブの凍結中に複数のビルドが発生した場合、それらは1つのビルドにまとめられ、凍結が明けた際に凍結中に発生した内の最新のコミットで実行されます。この機能を無効にするには、[アノテーション](./annotations)の `screwdriver.cd/collapseBuilds` を `false` に設定してください。
 
 #### 例
+
 以下の例では、`job1` は3月中に凍結され、` job2` は週末に凍結され、`job3` は午後10時00分から午前10時59分まで凍結されます。
 
 ```
@@ -354,9 +365,11 @@ jobs:
 サンプルリポジトリ: <https://github.com/screwdriver-cd-test/workflow-detached-example>
 
 ## 購読しているSCMからの通知
+
 外部リポジトリを購読(Subscribe)することで、外部リポジトリに変更があったときにパイプラインのビルドが開始されるようにできます。`~pr`, `~commit`, `~tag`, `~release` などのイベントのwebhook通知を購読する設定が可能です。購読しているイベントで起動する各ジョブは独自で設定する必要があります。
 
 ### 例
+
 次の例では、 `subscribe` オブジェクトの `scmUrls` セクションに、購読するリポジトリを追加します。また購読するイベントを指定する必要があり、この例では `~commit` と `~pr` のイベントを指定しています。パイプラインを作成した際に、webhookが自動的にリポジトリに登録されることに注意してください。
 
 ```