Skip to content

Fix Codespaces setup steps in tutorial docs #2

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

Merged
danielgerlag merged 1 commit into from
Aug 3, 2026
Merged

Fix Codespaces setup steps in tutorial docs #2

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
18 changes: 15 additions & 3 deletions tutorials/building-comfort/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,21 @@ The easiest way to follow this tutorial is the **dev container**, which installs

### Option A: Dev Container or GitHub Codespaces (recommended)

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code and run **Reopen in Container** (or create a **Codespace** from the repo's **Code** menu).
2. When prompted for a configuration, choose **Building Comfort Tutorial (Python)**.
3. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies (`drasi-lib`, `streamlit`, `psycopg`) and the Docker tooling for PostgreSQL.
**VS Code (local dev container)**

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code.
2. Run **Dev Containers: Reopen in Container**.
3. When prompted for a configuration, choose **Building Comfort Tutorial (Python)**.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies (`drasi-lib`, `streamlit`, `psycopg`) and the Docker tooling for PostgreSQL.

**GitHub Codespaces**

The default **Create codespace** button does not ask which configuration to use. Pick the tutorial config explicitly:

1. On the [`drasi-python`](https://github.com/drasi-project/drasi-python) repo page, open the green **Code** menu and select the **Codespaces** tab.
2. Open the `...` menu next to **Create codespace on ...** and choose **New with options…**.
3. Under **Dev container configuration**, select **Building Comfort Tutorial (Python)**, then create the codespace.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies (`drasi-lib`, `streamlit`, `psycopg`) and the Docker tooling for PostgreSQL.

That's it — skip ahead to [Step 2](#step-2-of-4-run-the-demo).

Expand Down
18 changes: 15 additions & 3 deletions tutorials/building-comfort/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,21 @@ The easiest way to follow this tutorial is the **dev container**, which installs

### Option A: Dev Container or GitHub Codespaces (recommended)

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code and run **Reopen in Container** (or create a **Codespace** from the repo's **Code** menu).
2. When prompted for a configuration, choose **Building Comfort Tutorial (Python)**.
3. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies (`drasi-lib`, `streamlit`, `psycopg`) and the Docker tooling for PostgreSQL.
**VS Code (local dev container)**

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code.
2. Run **Dev Containers: Reopen in Container**.
3. When prompted for a configuration, choose **Building Comfort Tutorial (Python)**.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies (`drasi-lib`, `streamlit`, `psycopg`) and the Docker tooling for PostgreSQL.

**GitHub Codespaces**

The default **Create codespace** button does not ask which configuration to use. Pick the tutorial config explicitly:

1. On the [`drasi-python`](https://github.com/drasi-project/drasi-python) repo page, open the green **Code** menu and select the **Codespaces** tab.
2. Open the `...` menu next to **Create codespace on ...** and choose **New with options…**.
3. Under **Dev container configuration**, select **Building Comfort Tutorial (Python)**, then create the codespace.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies (`drasi-lib`, `streamlit`, `psycopg`) and the Docker tooling for PostgreSQL.

That's it — skip ahead to [Step 2](#run).

Expand Down
18 changes: 15 additions & 3 deletions tutorials/curbside-pickup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,21 @@ This tutorial needs **Docker** (it runs PostgreSQL and MySQL) and **Python 3.10+

### Option A: Dev Container or GitHub Codespaces (recommended)

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code and run **Reopen in Container** (or create a **Codespace** from the repo's **Code** menu).
2. When prompted for a configuration, choose **Curbside Pickup Tutorial (Python)**.
3. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies and the Docker tooling for the two databases.
**VS Code (local dev container)**

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code.
2. Run **Dev Containers: Reopen in Container**.
3. When prompted for a configuration, choose **Curbside Pickup Tutorial (Python)**.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies and the Docker tooling for the two databases.

**GitHub Codespaces**

The default **Create codespace** button does not ask which configuration to use. Pick the tutorial config explicitly:

1. On the [`drasi-python`](https://github.com/drasi-project/drasi-python) repo page, open the green **Code** menu and select the **Codespaces** tab.
2. Open the `...` menu next to **Create codespace on ...** and choose **New with options…**.
3. Under **Dev container configuration**, select **Curbside Pickup Tutorial (Python)**, then create the codespace.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies and the Docker tooling for the two databases.

That's it. Skip ahead to [Step 2](#step-2-of-4-run-the-demo).

Expand Down
18 changes: 15 additions & 3 deletions tutorials/curbside-pickup/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,21 @@ This tutorial needs **Docker** (it runs PostgreSQL and MySQL) and **Python 3.10+

### Option A: Dev Container or GitHub Codespaces (recommended)

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code and run **Reopen in Container** (or create a **Codespace** from the repo's **Code** menu).
2. When prompted for a configuration, choose **Curbside Pickup Tutorial (Python)**.
3. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies and the Docker tooling for the two databases.
**VS Code (local dev container)**

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code.
2. Run **Dev Containers: Reopen in Container**.
3. When prompted for a configuration, choose **Curbside Pickup Tutorial (Python)**.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies and the Docker tooling for the two databases.

**GitHub Codespaces**

The default **Create codespace** button does not ask which configuration to use. Pick the tutorial config explicitly:

1. On the [`drasi-python`](https://github.com/drasi-project/drasi-python) repo page, open the green **Code** menu and select the **Codespaces** tab.
2. Open the `...` menu next to **Create codespace on ...** and choose **New with options…**.
3. Under **Dev container configuration**, select **Curbside Pickup Tutorial (Python)**, then create the codespace.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependencies and the Docker tooling for the two databases.

That's it. Skip ahead to [Step 2](#run).

Expand Down
18 changes: 15 additions & 3 deletions tutorials/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,21 @@ This tutorial needs **Python 3.10+** and **Docker** (for PostgreSQL). The easies

### Option A: Dev Container or GitHub Codespaces (recommended)

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code and run **Reopen in Container** (or create a **Codespace** from the repo's **Code** menu).
2. When prompted for a configuration, choose **Getting Started Tutorial (Python)**.
3. Wait for the container to finish. Its setup script installs the tutorial's Python dependency (`drasi-lib`) and the Docker tooling for PostgreSQL.
**VS Code (local dev container)**

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code.
2. Run **Dev Containers: Reopen in Container**.
3. When prompted for a configuration, choose **Getting Started Tutorial (Python)**.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependency (`drasi-lib`) and the Docker tooling for PostgreSQL.

**GitHub Codespaces**

The default **Create codespace** button does not ask which configuration to use. Pick the tutorial config explicitly:

1. On the [`drasi-python`](https://github.com/drasi-project/drasi-python) repo page, open the green **Code** menu and select the **Codespaces** tab.
2. Open the `...` menu next to **Create codespace on ...** and choose **New with options…**.
3. Under **Dev container configuration**, select **Getting Started Tutorial (Python)**, then create the codespace.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependency (`drasi-lib`) and the Docker tooling for PostgreSQL.

That's it. Skip ahead to [Step 2](#step-2-of-4-run-the-demo).

Expand Down
18 changes: 15 additions & 3 deletions tutorials/getting-started/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,21 @@ This tutorial needs **Python 3.10+** and **Docker** (for PostgreSQL). The easies

### Option A: Dev Container or GitHub Codespaces (recommended)

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code and run **Reopen in Container** (or create a **Codespace** from the repo's **Code** menu).
2. When prompted for a configuration, choose **Getting Started Tutorial (Python)**.
3. Wait for the container to finish. Its setup script installs the tutorial's Python dependency (`drasi-lib`) and the Docker tooling for PostgreSQL.
**VS Code (local dev container)**

1. Open the [`drasi-python`](https://github.com/drasi-project/drasi-python) repository in VS Code.
2. Run **Dev Containers: Reopen in Container**.
3. When prompted for a configuration, choose **Getting Started Tutorial (Python)**.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependency (`drasi-lib`) and the Docker tooling for PostgreSQL.

**GitHub Codespaces**

The default **Create codespace** button does not ask which configuration to use. Pick the tutorial config explicitly:

1. On the [`drasi-python`](https://github.com/drasi-project/drasi-python) repo page, open the green **Code** menu and select the **Codespaces** tab.
2. Open the `...` menu next to **Create codespace on ...** and choose **New with options…**.
3. Under **Dev container configuration**, select **Getting Started Tutorial (Python)**, then create the codespace.
4. Wait for the container to finish. Its setup script installs the tutorial's Python dependency (`drasi-lib`) and the Docker tooling for PostgreSQL.

That's it. Skip ahead to [Step 2](#run).

Expand Down
Loading