Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta Adatta ai principianti
  • Qualcosa non va?
#290 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker-compose, markdown, shell
Ambito
documentation

Direzione di ricerca

Leggi documentation/develop/quick-start.md, in particolare le righe 20–89, e segui i comandi di clonazione, creazione dei file e avvio dalla stessa directory padre. Fai in modo che i percorsi documentati di issuer e verifier vengano risolti senza un cambio di directory non indicato, quindi verifica entrambe le sequenze nelle varianti di shell supportate; il lavoro è completo quando entrambi gli script di avvio e i file di ambiente vengono risolti come indicato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug documentation ready-for-agent

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.
Lingua principale
TypeScript
Stelle
15
Fork
8
Merge medio
3g 14h
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hyperledger-identus/docs

Tutte le issue di hyperledger-identus/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.