From 6208626d27d451628ef6ab3068d54f777dfb9c9b Mon Sep 17 00:00:00 2001 From: nthmost-orkes Date: Mon, 16 Mar 2026 15:39:33 -0700 Subject: [PATCH] Fix quickstart documentation: broken links, missing prerequisites, and troubleshooting - Fix two broken quickstart links in README.md (conductor-oss.org/quickstart -> docs.conductor-oss.org/quickstart/) - Add Node.js v16+ and Java 21+ to prerequisites in README.md - Add Java 21+ prerequisite to docs/quickstart/index.md - Add troubleshooting callout box for common issues (Java not found, port conflicts, Docker alternative) --- README.md | 6 ++++-- docs/quickstart/index.md | 7 ++++++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b94b7c7b8..e92a1cc6e 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ Conductor is an open-source, durable workflow engine built at [Netflix](https:// # Get Running in 60 Seconds +**Prerequisites:** [Node.js](https://nodejs.org/) v16+ and [Java](https://adoptium.net/) 21+ must be installed. + ```shell npm install -g @conductor-oss/conductor-cli conductor server start @@ -42,7 +44,7 @@ conductor workflow create workflow.json conductor workflow start -w hello_workflow --sync ``` -See the [Quickstart guide](https://conductor-oss.org/quickstart) for the full walkthrough, including writing workers and replaying workflows. +See the [Quickstart guide](https://docs.conductor-oss.org/quickstart/) for the full walkthrough, including writing workers and replaying workflows.
Prefer Docker? @@ -51,7 +53,7 @@ See the [Quickstart guide](https://conductor-oss.org/quickstart) for the full wa docker run -p 8080:8080 conductoross/conductor:latest ``` -All CLI commands have equivalent cURL/API calls. See the [Quickstart](https://conductor-oss.org/quickstart) for details. +All CLI commands have equivalent cURL/API calls. See the [Quickstart](https://docs.conductor-oss.org/quickstart/) for details.
--- diff --git a/docs/quickstart/index.md b/docs/quickstart/index.md index 24d2cfed0..bcc61b8ab 100644 --- a/docs/quickstart/index.md +++ b/docs/quickstart/index.md @@ -6,7 +6,7 @@ description: Run your first Conductor workflow in 2 minutes. Call an API, parse **See a workflow execute in 2 minutes. Build your own in 5.** -You need [Node.js](https://nodejs.org/) (v16+) installed. That's it. +You need [Node.js](https://nodejs.org/) (v16+) and [Java](https://adoptium.net/) (21+) installed. That's it. ## Phase 1: See it work @@ -19,6 +19,11 @@ conductor server start Wait for the server to start, then open the UI at [http://localhost:8080](http://localhost:8080). +!!! note "Troubleshooting" + - **"Java not found" or server won't start?** Install Java 21+ from [Adoptium](https://adoptium.net/) and make sure `java -version` shows 21 or higher. + - **Port 8080 already in use?** Start on a different port: `conductor server start --port 9090` + - **Prefer Docker?** Skip the CLI server and run: `docker run -p 8080:8080 conductoross/conductor:latest` + ### Define the workflow Save `workflow.json` — a two-task workflow that calls an API and parses the response, all server-side: