Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Quick Start: Cloud Agent startup paths do not resolve after cloning

オープン 初心者向け
  • 何か問題がありますか？
#290 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
docker-compose, markdown, shell
領域
documentation

調査の方向性

documentation/develop/quick-start.md、特に20～89行目を読み、同じ親ディレクトリからクローン、ファイル作成、起動の各コマンドをたどってください。明記されていないディレクトリ変更なしで、文書に記載されたissuerとverifierのパスが解決されるようにし、サポート対象のshellの各バリアントで両方の手順を検証してください。両方の起動スクリプトと環境ファイルが記載どおりに解決されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

User impact

New developers following the Agent Deployment steps cannot start either Cloud Agent without inferring an undocumented working-directory change.

Affected documentation and ownership

  • Quick Start Guide, observed 2026-10-28 18:49 UTC, HTTP 200. The deployed startup examples match the source below.
  • Editable, portal-local Markdown: documentation/develop/quick-start.md, lines 20–89, revision fa985dfa33caefa45bf1e9009e1f6f5a445344fb. Not generated/imported component documentation.
  • Intended version: page sets AGENT_VERSION=2.0.0. Directory resolution itself is version-independent; no version upgrade is requested.

Observed versus expected

The guide first runs:

git clone https://github.com/hyperledger/identus-cloud-agent

It then tells readers to create files at ./identus-cloud-agent/infrastructure/local/.env-issuer and .env-verifier, consistent with remaining in the clone's parent directory.

The next executable examples instead start with ./infrastructure/local/run.sh and pass ./infrastructure/local/.env-issuer or .env-verifier. No step establishes the checkout root as the working directory. Git clone does not change the calling shell's directory.

Expected: both the startup script and environment-file paths resolve when the documented steps are followed literally.

Evidence and reproduction

Static comparison, Python 3.13.15/pathlib, 2026-10-28:

  1. Start in a fresh parent directory and follow the listed clone/file-creation sequence.
  2. Resolve the startup command's ./infrastructure/local/run.sh from that same directory: it is outside the newly created identus-cloud-agent checkout.
  3. The actual script is inside the matching Agent v2.0.0 checkout. Its explicit environment-file argument is passed to Docker Compose.

This is a source/path-resolution defect, not a claim of a tested Docker failure. No tutorial commands, Docker deployment or service requests were executed. A reader who independently changes directory can work around it. Deployment commit is not exposed; source/deployed example text was compared, not assumed from timestamps.

Existing work checked

Searched open/closed issues and PRs, including discussion, in docs, cloud-agent and sdk-ts by Quick Start/path, run.sh, and startup root cause; fully paginated repository inventories were also checked. docs #222/#223 update versions/flow, not this directory transition. cloud-agent #1171 concerns image/version configuration after the script is already running. No existing repair for this omission was found.

Acceptance criteria

  • From a fresh clone parent, the guide explicitly establishes working-directory context in which its startup script and environment-file paths resolve.
  • Verify the documented issuer and verifier sequences on both supported shell variants without an unmentioned directory change.
主要言語
TypeScript
スター
15
フォーク
8
平均マージ
7日 19時間
マージ済み PR（30日）
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

hyperledger-identus/docs のほかの issue

hyperledger-identus/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。