AUTO: Sync ScalarDL docs in Japanese to docs site repo

scalar-labs · Feb 20, 2025 · 5ce74c4 · 5ce74c4
1 parent 0b539e3
commit 5ce74c4
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 40 deletions.
diff --git a/.../versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/authentication.mdx b/.../versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/authentication.mdx
@@ -53,7 +53,7 @@ ScalarDL は、電子署名と HMAC という2つの認証方法をサポート
 
 ## 構成、設定
 
-このセクションでは、ScalarDL 認証を適切に使用するために設定する必要がある変数について説明します。各変数の詳細については、[Javadoc](https://scalar-labs.github.io/scalardl/javadoc/latest/) を参照してください。
+このセクションでは、ScalarDL 認証を適切に使用するために設定する必要がある変数について説明します。各変数の詳細については、[Javadoc](javadoc/index.mdx) を参照してください。
 
 ### 電子署名
 

diff --git a/.../versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/configurations.mdx b/.../versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/configurations.mdx
@@ -4,6 +4,7 @@ displayed_sidebar: docsJapanese
 
 # ScalarDL の設定
 
+import JavadocLink from '/src/theme/JavadocLink.js';
 import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
 
 <TranslationBanner />
@@ -14,16 +15,16 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
 
 Ledger サーバーでは、サービスポート設定、認証設定、TLS 設定など、いくつかの設定を行うことができます。
 
-利用可能なすべての設定の詳細については、使用している ScalarDL のバージョンの [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardl-common/latest/index.html) で`LedgerConfig`ページの Fields セクションを参照してください。
+利用可能なすべての設定の詳細については、Javadoc の <JavadocLink packageName="scalardl-common" path="com/scalar/dl/ledger/config" className="LedgerConfig" /> ページのフィールドセクションを参照してください。
 
 ## Auditor の設定
 
 Auditor サーバーでは、サービスポート設定、認証設定、TLS 設定など、いくつかの設定を行うことができます。
 
-利用可能なすべての設定の詳細については、使用している ScalarDL のバージョンの [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardl-common/latest/index.html) で`AuditorConfig`ページの Fields セクションを参照してください。
+利用可能なすべての設定の詳細については、Javadoc の <JavadocLink packageName="scalardl-common" path="com/scalar/dl/auditor/config" className="AuditorConfig" /> ページのフィールドセクションを参照してください。
 
 ## クライアントの設定
 
 クライアントでは、Ledger および Auditor サーバーの設定、認証設定、TLS 設定など、いくつかの設定を行うことができます。
 
-利用可能なすべての設定の詳細については、使用している ScalarDL のバージョンの [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardl-java-client-sdk/latest/index.html) で`ClientConfig`ページの Fields セクションを参照してください。
+利用可能なすべての設定の詳細については、Javadoc の <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/client/config" className="ClientConfig" /> ページのフィールドセクションを参照してください。
diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/data-modeling.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/data-modeling.mdx
@@ -4,6 +4,7 @@ displayed_sidebar: docsJapanese
 
 # データをモデル化する
 
+import JavadocLink from '/src/theme/JavadocLink.js';
 import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
 
 <TranslationBanner />
@@ -66,7 +67,7 @@ ScalarDL の台帳は、アセットの集合として抽象化されます。
 
 #### アセットのアセットレコードをスキャンする
 
-アセット ID と世代を指定すると、アセットの複数のレコード (つまり、アセットの履歴) をスキャンできます。具体的には、アセット ID と世代は `AssetFilter` クラスで指定できます。仕様の詳細については、使用している ScalarDL バージョンの [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardl-java-client-sdk/latest/index.html) の `AssetFilter` ページを参照してください。
+アセット ID と世代を指定すると、アセットの複数のレコード (つまり、アセットの履歴) をスキャンできます。具体的には、アセット ID と世代は `AssetFilter` クラスで指定できます。仕様の詳細については、Javadoc の <JavadocLink packageName="scalardl-common" path="com/scalar/dl/ledger/database" className="AssetFilter" /> ページを参照してください。
 
 ### 可変レコードの検索方法
 

diff --git a/...ned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-write-contract.mdx b/...ned_docs/ja-jp/docusaurus-plugin-content-docs/current/how-to-write-contract.mdx
@@ -4,6 +4,7 @@ displayed_sidebar: docsJapanese
 
 # ScalarDL の適切なコントラクトを作成する方法に関するガイド
 
+import JavadocLink from '/src/theme/JavadocLink.js';
 import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
 
 <TranslationBanner />
@@ -12,7 +13,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
 
 ## ScalarDL のコントラクトとは何ですか?
 
-ScalarDL のコントラクト (別名スマートコントラクト) は、単一のビジネスロジックを実装するために記述された、事前定義済みの基本コントラクト (基本コントラクトは [ContractBase](https://scalar-labs.github.io/scalardl/javadoc/latest/ledger/com/scalar/dl/ledger/contract/ContractBase.html) クラスも拡張する) を拡張する Java プログラムです 。コントラクトとその引数は、コントラクト所有者の秘密鍵で電子署名され、ScalarDL に渡されます。この仕組みにより、コントラクトは所有者のみが実行できるようになり、データ改ざんなどの悪意のある行為をシステムが検出できるようになります。
+ScalarDL のコントラクト (別名スマートコントラクト) は、単一のビジネスロジックを実装するために記述された、事前定義済みの基本コントラクトを拡張する Java プログラムです。コントラクトとその引数は、コントラクト所有者の秘密鍵で電子署名され、ScalarDL に渡されます。この仕組みにより、コントラクトは所有者のみが実行できるようになり、データ改ざんなどの悪意のある行為をシステムが検出できるようになります。
 
 このドキュメントを参照する前に、[ScalarDL 入門](getting-started.mdx)を参照して、ScalarDL とは何か、およびその基本用語を理解してください。
 
@@ -56,16 +57,16 @@ Ledger データと Contract 引数の内部表現は String です。ただし
 
 | 基本コントラクトクラス                                                                                                                                                | コントラクト引数のタイプ、コントラクトプロパティ、コントラクト出力、およびLedger データ                                                                  | ライブラリ                                        |
 | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
-| [JacksonBasedContract](https://scalar-labs.github.io/scalardl/javadoc/latest/ledger/com/scalar/dl/ledger/contract/JacksonBasedContract.html) (おすすめ)      | [JsonNode](https://fasterxml.github.io/jackson-databind/javadoc/2.13/com/fasterxml/jackson/databind/JsonNode.html) | [Jackson](https://github.com/FasterXML/jackson) |
-| [JsonpBasedContract](https://scalar-labs.github.io/scalardl/javadoc/latest/ledger/com/scalar/dl/ledger/contract/JsonpBasedContract.html)                   | [JsonObject](https://javadoc.io/static/javax.json/javax.json-api/1.1.4/javax/json/JsonObject.html)                  | [JSONP](https://javaee.github.io/jsonp/)        |
-| [StringBasedContract](https://scalar-labs.github.io/scalardl/javadoc/latest/ledger/com/scalar/dl/ledger/contract/StringBasedContract.html)                 | [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)                                           | Java標準ライブラリ                                |
-| [Contract](https://scalar-labs.github.io/scalardl/javadoc/latest/ledger/com/scalar/dl/ledger/contract/Contract.html) (廃止された)                            | [JsonObject](https://javadoc.io/static/javax.json/javax.json-api/1.1.4/javax/json/JsonObject.html)                 | [JSONP](https://javaee.github.io/jsonp/)         |
+| <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/ledger/contract" className="JacksonBasedContract" /> (おすすめ)      | [JsonNode](https://fasterxml.github.io/jackson-databind/javadoc/2.13/com/fasterxml/jackson/databind/JsonNode.html) | [Jackson](https://github.com/FasterXML/jackson) |
+| <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/ledger/contract" className="JsonpBasedContract" />                   | [JsonObject](https://javadoc.io/static/javax.json/javax.json-api/1.1.4/javax/json/JsonObject.html)                  | [JSONP](https://javaee.github.io/jsonp/)        |
+| <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/ledger/contract" className="StringBasedContract" />                 | [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)                                           | Java標準ライブラリ                                |
+| <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/ledger/contract" className="Contract" /> (廃止された)                            | [JsonObject](https://javadoc.io/static/javax.json/javax.json-api/1.1.4/javax/json/JsonObject.html)                 | [JSONP](https://javaee.github.io/jsonp/)         |
 
-古い [Contract](https://scalar-labs.github.io/scalardl/javadoc/ledger/com/scalar/dl/ledger/contract/Contract.html) はまだ利用可能ですが、現在は非推奨となっており、今後のメジャーバージョンで削除される予定です。したがって、上記の新しい (非推奨ではない) コントラクトを基本コントラクトとして使用することを強くお勧めします。
+古い <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/ledger/contract" className="Contract" /> はまだ利用可能ですが、現在は非推奨となっており、今後のメジャーバージョンで削除される予定です。したがって、上記の新しい (非推奨ではない) コントラクトを基本コントラクトとして使用することを強くお勧めします。
 
 ### `invoke` 引数について
 
-上に示したように、オーバーライドされた `invoke` メソッドは、基礎となるデータベースと対話するための [Ledger](https://scalar-labs.github.io/scalardl/javadoc/latest/ledger/com/scalar/dl/ledger/statemachine/Ledger.html)、コントラクト引数の [JsonNode](https://fasterxml.github.io/jackson-databind/javadoc/2.13/com/fasterxml/jackson/databind/JsonNode.html)、およびコントラクトプロパティ用のオプションである [JsonNode](https://fasterxml.github.io/jackson-databind/javadoc/2.13/com/fasterxml/jackson/databind/JsonNode.html) を受け取ります。
+上に示したように、オーバーライドされた `invoke` メソッドは、基礎となるデータベースと対話するための <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/ledger/statemachine" className="Ledger" />、コントラクト引数の [JsonNode](https://fasterxml.github.io/jackson-databind/javadoc/2.13/com/fasterxml/jackson/databind/JsonNode.html)、およびコントラクトプロパティ用のオプションである [JsonNode](https://fasterxml.github.io/jackson-databind/javadoc/2.13/com/fasterxml/jackson/databind/JsonNode.html) を受け取ります。
 
  `Ledger` は一連のアセットを管理するデータベース抽象化であり、各アセットは `asset_id` と呼ばれるキーと `age` と呼ばれる履歴バージョン番号によって識別されるレコードの履歴で構成されます。`get`、`put`、および `scan` API を使用して `Ledger` と対話できます。`get` API は、指定されたアセットの最新のアセットレコードを取得するために使用されます。`put` API は、指定されたアセットに新しいアセットレコードを追加するために使用されます。`scan` API は、指定されたアセットを走査するために使用されます。この抽象化では Ledger にアセットレコードを追加できるだけであることに注意してください。したがって、ScalarDL のコントラクトを作成する前に、抽象化を使用してデータを設計することを常に推奨します。
 
@@ -163,7 +164,7 @@ public class StateUpdaterReader extends JacksonBasedContract {
 
 `getClientIdentityKey()` を呼び出すと、コントラクト内でコントラクトを実行しているユーザーを示す ID 情報を取得できます。この機能は、特定のアセットにアクセスできるユーザーを制御するのに役立ちます。次の例は、state-xxx (xxx は証明書またはシークレットのホルダーのエンティティ ID) という名前の制限付きアセットのみを更新できるように変更された `StateUpdater` を示しています。
 
-詳細については、使用している ScalarDL バージョンの [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardl-java-client-sdk/latest/index.html) のベースコントラクトのページと `ClientIdentityKey ` ページを参照してください。
+詳細については、Javadoc の[基本コントラクト](#基本コントラクト)セクションと <JavadocLink packageName="scalardl-java-client-sdk" path="com/scalar/dl/ledger/crypto" className="ClientIdentityKey" /> ページを参照してください。
 
 ```java
 public class StateUpdater extends JacksonBasedContract {
@@ -210,4 +211,4 @@ ScalarDL の適切なコントラクトを作成するためのベストプラ
 
 * [ScalarDL 入門](getting-started.mdx)
 * [ScalarDL 設計ドキュメント](design.mdx)
-* [Javadoc](https://scalar-labs.github.io/scalardl/javadoc/)
+* [Javadoc](javadoc/index.mdx)