Skip to content

Fix quickstart docs: broken links, missing prereqs, troubleshooting #877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nthmost-orkes wants to merge 1 commit into from
Closed

Fix quickstart docs: broken links, missing prereqs, troubleshooting #877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

<details>
<summary><strong>Prefer Docker?</strong></summary>
Expand All @@ -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.
</details>

---
Expand Down
7 changes: 6 additions & 1 deletion docs/quickstart/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:
Expand Down
Loading