Skip to content

Commit d9d82c2

Browse files
committed
Documentation update
1 parent 4eb6b23 commit d9d82c2

File tree

5 files changed

+15
-38
lines changed

5 files changed

+15
-38
lines changed

wiki-content/Installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ All connection strings and service references are injected automatically by Aspi
5454

5555
![Description](images/start-without-debugging.png)
5656

57-
Or open in Visual Studio or Visual Studio Code and select Debug/Start Without Debugging.
57+
Or open in **Visual Studio** or **Visual Studio Code** and Debug/Start Without Debugging.
5858

5959
---
6060

@@ -102,7 +102,7 @@ Blazor Data Orchestrator uses standard .NET configuration files. In development,
102102
```json
103103
{
104104
"ConnectionStrings": {
105-
"blazororchestratordb": "Server=localhost,1433;Database=blazororchestratordb;...",
105+
"blazororchestratordb": "Server=localhost,14330;Database=blazororchestratordb;...",
106106
"blobs": "UseDevelopmentStorage=true",
107107
"queues": "UseDevelopmentStorage=true",
108108
"tables": "UseDevelopmentStorage=true"
@@ -119,7 +119,7 @@ Blazor Data Orchestrator uses standard .NET configuration files. In development,
119119
| Problem | Solution |
120120
|---------|----------|
121121
| `aspire run` fails to start | Ensure Docker Desktop is running and the .NET 10 SDK is installed |
122-
| SQL Server container won't start | Check that port 1433 is not in use by another process |
122+
| SQL Server container won't start | Check that port 14330 is not in use by another process |
123123
| Azurite ports conflict | Check that ports 10000, 10001, 10002 are free |
124124
| Install Wizard doesn't appear | Clear the browser cache and navigate to the web app root URL |
125125
| Database connection fails | Verify the SQL Server container is healthy in the Aspire dashboard |

wiki-content/Operation.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,15 @@ This guide covers day-to-day usage of Blazor Data Orchestrator — managing jobs
66

77
## Job Lifecycle
88

9-
```mermaid
10-
stateDiagram-v2
11-
classDef clear fill:#f9f9f9,stroke:#333,stroke-width:1px;
12-
classDef green fill:#dff6dd,stroke:#107c10,stroke-width:2px;
13-
classDef blue fill:#deecf9,stroke:#0078d4,stroke-width:2px;
14-
classDef red fill:#fde7e9,stroke:#d13438,stroke-width:2px;
15-
16-
[*] --> Created:::clear : Create Job
17-
Created --> Enabled:::clear : Enable Job
18-
Enabled --> Queued:::blue : Schedule / Manual
19-
Queued --> InProcess:::blue : Agent Pickup
20-
InProcess --> Completed:::green : Success
21-
InProcess --> Error:::red : Failure
22-
Completed --> Enabled : Next Run
23-
Error --> Enabled : Retry
24-
Enabled --> Disabled:::clear : Disable
25-
Disabled --> Enabled : Re-enable
26-
```
9+
![job-lifecycle-overview](images/job-lifecycle-overview.png)
2710

2811
---
2912

3013
## Dashboard Overview
3114

32-
The **Home** page displays all jobs in a table with key status indicators:
15+
![Dashboard Main](images/darshboard-main.png)
16+
17+
The **Dashboard** page displays all jobs with key status indicators:
3318

3419
| Column | Description |
3520
|--------|-------------|

wiki-content/Requirements.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ This page lists all prerequisites and infrastructure requirements for running Bl
99
| Requirement | Version | Notes |
1010
|------------|---------|-------|
1111
| **.NET SDK** | 10.0+ | Required for building and running all projects |
12-
| **Docker Desktop** (or Podman) | Latest | Required for SQL Server and Azurite containers managed by Aspire |
13-
| **IDE** | Visual Studio 2022+ or Visual Studio Code | VS Code with C# Dev Kit recommended |
12+
| **Docker Desktop** or **Podman** | Latest | Required for SQL Server and Azurite containers managed by Aspire |
13+
| **IDE** | Visual Studio 2022+ or Visual Studio Code | If using VS Code use with C# Dev Kit recommended |
1414

1515
> **Important:** Do not install the legacy Aspire workload. Run `dotnet workload restore` from the solution root — this restores only the workloads declared by the solution.
1616
@@ -23,7 +23,7 @@ Aspire automatically provisions the following infrastructure as containers in de
2323
### SQL Server
2424

2525
- **Version:** SQL Server 2019+ or Azure SQL Database
26-
- **Port:** 1433 (default)
26+
- **Port:** 14330 (default for development)
2727
- **Database:** `blazororchestratordb`
2828
- **Purpose:** Stores all job definitions, schedules, instances, organizations, groups, queues, parameters, and user accounts.
2929

@@ -39,32 +39,24 @@ In development, Aspire starts an **Azurite** container that emulates all three A
3939

4040
---
4141

42-
## Optional: AI Features
42+
## Optional Reccomended: AI Features
4343

4444
To use the AI Code Assistant in the online editor, you need one of the following:
4545

4646
- **OpenAI API key** — Standard OpenAI endpoint
4747
- **Azure OpenAI endpoint** — Azure-hosted OpenAI service with a deployed model
48+
- **Anthopic** — Standard AI endpoint
49+
- **Google Gemini** — Standard AI endpoint
4850

4951
Configure these through the Administration settings in the web UI.
5052

5153
---
5254

53-
## Optional: Python Execution
54-
55-
To execute Python jobs, the Agent host must have:
56-
57-
- **Python 3.x** runtime installed and available on the system PATH
58-
59-
C# job execution does not require any additional runtime beyond the .NET SDK.
60-
61-
---
62-
6355
## Network Requirements
6456

6557
| Port | Service | Direction |
6658
|------|---------|-----------|
67-
| 1433 | SQL Server | Inbound (all app services → SQL) |
59+
| 14330 | SQL Server | Inbound (all app services → SQL) |
6860
| 10000 | Azurite Blob | Inbound (all app services → Blob) |
6961
| 10001 | Azurite Queue | Inbound (all app services → Queue) |
7062
| 10002 | Azurite Table | Inbound (all app services → Table) |
@@ -84,7 +76,7 @@ graph LR
8476
8577
subgraph "Developer Machine"
8678
SDK[TOOLS<br/>.NET 10 SDK]:::dev
87-
DOCKER[HOST<br/>Docker Desktop]:::dev
79+
DOCKER[HOST<br/>Docker/Podman]:::dev
8880
IDE[EDITOR<br/>VS / VS Code]:::dev
8981
end
9082
59 KB
Loading
462 KB
Loading

0 commit comments

Comments
 (0)