diff --git a/content/ja/docs/demo/forking.md b/content/ja/docs/demo/forking.md new file mode 100644 index 000000000000..252c035e74ff --- /dev/null +++ b/content/ja/docs/demo/forking.md @@ -0,0 +1,25 @@ +--- +title: デモリポジトリをフォークする +linkTitle: フォーク +default_lang_commit: 99b15da7137cde4a6352576768f4c9203170d569 +--- + +[demo repository][]は、OpenTelemetryを使用した実装例を紹介するためのツールとして、フォークして使用できるように設計されています。 + +フォークやデモの環境構築は、通常いくつかの環境変数の上書きと、場合によってはコンテナイメージの置き換えのみで済みます。 + +実際のデモは[README](https://github.com/open-telemetry/opentelemetry-demo/blob/main/README.md?plain=1)に追加することができます。 + +## フォークメンテナーへの提案 {#suggestions-for-fork-maintainers} + +- デモによって発信または収集されるテレメトリーデータを強化したい場合は、変更内容をこのリポジトリにバックポートすることを強く推奨します。 + ベンダーや実装固有の変更については、コードの根本的な変更よりも、設定によってパイプライン内でテレメトリーを変更する方針が望ましいです。 +- 置き換えるのではなく、拡張してください。 + 既存のAPIと連携する全く新しいサービスを追加することは、テレメトリーの変更では実現できないベンダー固有またはツール固有の機能を追加する優れた方法です。 +- 拡張性をサポートするため、キュー、データベース、キャッシュなどのリソースにはリポジトリパターンまたはファサードパターンを使用してください。 + そうすることで、異なるプラットフォームに対してこれらのサービスの異なる実装を組み込むことができます。 +- ベンダーやツール固有の拡張機能をこのリポジトリにバックポートしないでください。 + +フォークメンテナーとしての作業をより容易にする方法についての質問や提案がありましたら、イシューを作成してください。 + +[demo repository]: {{% param repo %}} diff --git a/content/ja/docs/demo/tests.md b/content/ja/docs/demo/tests.md new file mode 100644 index 000000000000..60a3c2f94141 --- /dev/null +++ b/content/ja/docs/demo/tests.md @@ -0,0 +1,22 @@ +--- +title: テスト +default_lang_commit: 99b15da7137cde4a6352576768f4c9203170d569 +cSpell:ignore: Tracetest +--- + +現在、このリポジトリにはフロントエンドとバックエンドの両サービスのE2Eテストが含まれています。 +フロントエンドでは、[Cypress](https://www.cypress.io/)を使用しており、Webストアの各フローを実行します。 +一方、バックエンドサービスでは、統合テストのメインテストフレームワークとして[AVA](https://avajs.dev)を使用しており、トレースベースのテストには[Tracetest](https://tracetest.io/)を使用しています。 + +すべてのテストを実行する場合は、ルートディレクトリから `make run-tests` を実行します。 + +特定のテストスイートのみを実行したい場合は、テストの種類ごとに各種テストのコマンドを実行します[^1]: + +- **フロントエンドのテスト**: `docker compose run frontendTests` +- **バックエンドのテスト**: + - 統合テスト: `docker compose run integrationTests` + - トレースベーステスト: `docker compose run traceBasedTests` + +詳細な情報については、[Service Testing](https://github.com/open-telemetry/opentelemetry-demo/tree/main/test)を参照してください。 + +[^1]: `docker-compose` は非推奨です。詳細については、[Compose V2 への移行](https://docs.docker.com/compose/migrate/) を参照してください。