You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+102-3Lines changed: 102 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,6 @@ This VS Code extension provides an interactive, hands-on learning experience for
7
7
</div>
8
8
9
9
10
-
11
-
12
10
## ✨ What You'll Learn
13
11
14
12
-**Pipeline Fundamentals** - Create your first ZenML pipeline
@@ -37,7 +35,42 @@ The fastest way to get started - no local setup required.
37
35
2. Wait ~2 min for setup (container, dependencies, extension)
38
36
3. The extension will launch automatically
39
37
40
-
### 💻 Alternative: Local Setup
38
+
### Local Setup with Extension from Marketplace
39
+
40
+
**Prerequisites:**
41
+
- Python 3.8 or higher
42
+
- VS Code
43
+
44
+
**Steps:**
45
+
46
+
1.**Set up Python virtual environment:**
47
+
```bash
48
+
python -m venv zenml-tutorial-env
49
+
source zenml-tutorial-env/bin/activate # On Windows: zenml-tutorial-env\Scripts\activate
50
+
```
51
+
52
+
2.**Install ZenML:**
53
+
```bash
54
+
pip install zenml
55
+
```
56
+
57
+
4.**Initialize ZenML:**
58
+
```bash
59
+
zenml init
60
+
```
61
+
62
+
5.**Start the ZenML server locally:**
63
+
```bash
64
+
zenml login --local
65
+
```
66
+
67
+
6.**Install the extension:**
68
+
- Install from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=zenml-io.zenml-tutorial) or search for "ZenML Tutorial" in the Extensions Marketplace
69
+
70
+
7.**Launch the tutorial:**
71
+
- Open VS Code and the extension will launch automatically
72
+
73
+
### 💻 Alternative: Local Setup with Dev Containers
41
74
42
75
**Requirements:**
43
76
@@ -73,6 +106,72 @@ The fastest way to get started - no local setup required.
73
106
-**Inspect** output in the terminal and Dashboard link
74
107
-**Experiment** by editing any example code
75
108
109
+
## ⚙️ Extension Configuration
110
+
111
+
### Auto-Open Tutorial
112
+
113
+
The tutorial homepage opens automatically when you start VS Code in the following scenarios:
114
+
-**On first install** (always opens the first time you install the extension)
-**When tutorial is enabled** (when `ZENML_ENABLE_TUTORIAL=true`)
117
+
-**When user setting is enabled** (see configuration options below)
118
+
119
+
You can control the user preference behavior:
120
+
121
+
#### 🔧 Quick Disable
122
+
When the welcome message appears, click **"Don't Show Again"** to disable auto-opening.
123
+
124
+
#### 🔧 Settings UI
125
+
1. Open VS Code Settings (`Ctrl+,` or `Cmd+,`)
126
+
2. Search for "zenml"
127
+
3. Toggle **"Auto Open Tutorial"** on/off
128
+
129
+
#### 🔧 Settings JSON
130
+
Add to your VS Code settings to enable auto-open (disabled by default):
131
+
```json
132
+
{
133
+
"zenml.autoOpenTutorial": true
134
+
}
135
+
```
136
+
137
+
**Note**: You can always access the tutorial manually via the ZenML sidebar (book icon) or Command Palette (`Ctrl+Shift+P` → "ZenML: Open ZenML Tutorial Homepage").
138
+
139
+
#### 📖 Manual Tutorial Access
140
+
141
+
If the tutorial doesn't open automatically, you can easily access it manually:
142
+
143
+
**Method 1: Using the ZenML Tutorial Sidebar**
144
+
1. Look for the ZenML Tutorial icon (📖) in the Activity Bar (left side of VS Code)
145
+
2. Click on it to open the tutorial panel
146
+
3. Click "Open Homepage" to start the tutorial
147
+
148
+

149
+
150
+
**Method 2: Using the Main Sidebar**
151
+
1. Open the main VS Code sidebar (Explorer view)
152
+
2. Scroll down to find "ZenML Tutorial" in the extensions list
0 commit comments