Skip to content

Commit e628e6d

Browse files
committed
Documentation update
1 parent 1af5d44 commit e628e6d

File tree

3 files changed

+41
-59
lines changed

3 files changed

+41
-59
lines changed

wiki-content/Deployment.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -160,40 +160,4 @@ You can scale agents horizontally by deploying multiple replicas or multiple Con
160160

161161
---
162162

163-
## CI/CD
164-
165-
### Wiki Content Synchronization
166-
167-
Wiki content in the `wiki-content/` directory is automatically synchronized to the GitHub Wiki via the `update-wiki.yml` GitHub Action. Any changes pushed to `wiki-content/` on the `main` branch are reflected in the wiki.
168-
169-
### Application Deployment Pipeline
170-
171-
Use `azd pipeline config` to set up a CI/CD pipeline in GitHub Actions:
172-
173-
```bash
174-
azd pipeline config
175-
```
176-
177-
This generates a GitHub Actions workflow that runs `azd provision` and `azd deploy` on each push to the main branch.
178-
179-
---
180-
181-
## Self-Hosted Deployment
182-
183-
For on-premises or non-Azure deployments:
184-
185-
1. **Build container images:**
186-
187-
```bash
188-
docker compose build
189-
```
190-
191-
2. **Configure environment variables** for SQL Server and Azure Storage (or use a compatible storage emulator).
192-
193-
3. **Run services** using Docker Compose or your container orchestrator (Kubernetes, Docker Swarm, etc.).
194-
195-
4. **Database setup** — Point the connection string to your SQL Server instance. The Install Wizard handles schema creation on first launch.
196-
197-
---
198-
199163
*Back to [Home](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Home)*

wiki-content/Frequently-Asked-Questions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Run `azd up` from the repository root. This single command provisions all requir
4343
1. Ensure **Docker Desktop** (or Podman) is running.
4444
2. Verify the **.NET 10 SDK** is installed: `dotnet --version`
4545
3. Run `dotnet workload restore` from the solution root.
46-
4. Check that ports 1433, 10000, 10001, and 10002 are not in use by other applications.
46+
4. Check that ports 14330, 10000, 10001, and 10002 are not in use by other applications.
4747
5. Review the terminal output from `aspire run` for error messages.
4848

4949
### Do I need to install the Aspire workload?
@@ -144,15 +144,15 @@ The compilation error dialog shows the file name, line number, and error descrip
144144
3. Check the agent logs in the Aspire dashboard.
145145
4. Ensure the job is **enabled** and has been **queued** (visible in the home page table).
146146

147-
### Why was my job executed twice?
147+
### Why was my job executed twice (or more)?
148148

149149
This typically indicates an agent crash during execution. The message visibility timeout expires (default: 5 minutes), making the message visible to another agent. The visibility timeout renewal (every 3 minutes) normally prevents this, but if the agent process terminates unexpectedly, the message will be reprocessed.
150150

151151
### How do I connect the AI Code Assistant?
152152

153153
1. Navigate to **Administration > Settings**.
154-
2. Select your AI provider (OpenAI or Azure OpenAI).
155-
3. Enter your API key and endpoint (for Azure OpenAI).
154+
2. Select your AI provider.
155+
3. Enter your API key and endpoint.
156156
4. Select a model (e.g., `gpt-4`).
157157
5. The AI button appears in the Code Tab editor toolbar.
158158

wiki-content/Visual-Studio.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,6 @@ flowchart LR
4141
| `appsettings.json` | Default job configuration |
4242
| `appsettingsProduction.json` | Production configuration overrides |
4343

44-
---
45-
46-
## Development Workflow
47-
48-
1. **Write job code** in the local Monaco editor or directly in Visual Studio.
49-
2. **Add NuGet dependencies** by editing the `.nuspec` file or using `//css_nuget` directives.
50-
3. **Compile** to verify the code compiles without errors.
51-
4. **Export the `.nupkg`** file generated by the compilation step.
52-
5. **Upload** the package to the main application:
53-
- Open the Job Details dialog in the web application.
54-
- Navigate to the **Code Tab**.
55-
- Switch to **Code Upload** mode.
56-
- Upload the `.nupkg` file.
57-
6. The job is now ready to execute.
5844

5945
---
6046

@@ -70,10 +56,44 @@ flowchart LR
7056

7157
---
7258

73-
## Screenshots
59+
## AI Chat Editor
60+
61+
The Job Creator Template includes a built-in **AI Chat Editor** powered by [GitHub Copilot](https://github.com/features/copilot). The chat panel appears alongside the Monaco code editor and can help you write, debug, and improve your job code.
62+
63+
### Configuring the AI Model
64+
65+
Click the **⚙ settings** button in the Chat panel header to open the configuration dialog. Here you can select the Copilot model and refresh the list of available models:
66+
67+
### Copilot CLI Requirement
68+
69+
The AI Chat feature requires the **GitHub Copilot CLI** to be installed and authenticated on your machine. If the CLI is not detected, the chat panel displays a warning banner with setup instructions:
7470

7571
<img width="977" height="709" alt="Job Creator Template main editor view" src="https://github.com/user-attachments/assets/dedc9e83-62fd-46c5-a58e-4eb92e3a0a72" />
7672

73+
### Installing the Copilot CLI
74+
75+
1. **Install** — Download from [docs.github.com/en/copilot/how-tos/copilot-cli/install-copilot-cli](https://docs.github.com/en/copilot/how-tos/copilot-cli/install-copilot-cli) or run:
76+
```
77+
winget install GitHub.Copilot
78+
```
79+
2. **Verify** — Confirm the install succeeded:
80+
```
81+
copilot --version
82+
```
83+
3. **Authenticate** — Sign in using one of these methods:
84+
- `copilot login`
85+
- Set the `GITHUB_TOKEN` environment variable
86+
- `gh auth login` (if GitHub CLI is installed)
87+
4. **Restart** the Job Creator Template application.
88+
89+
> **Firewall note:** Ensure outbound HTTPS to `api.githubcopilot.com` is allowed.
90+
91+
Once the CLI is installed and authenticated, the warning banner disappears and the AI Chat editor is ready to use.
92+
93+
## Screenshots shoing installing the Copilot CLI
94+
95+
<img width="539" height="686" alt="Copilot AI model and connection configuration dialog" src="https://github.com/user-attachments/assets/b2cb5dd0-c33e-4c43-bf5f-7a46b50c08b9" />
96+
7797
<img width="952" height="553" alt="NuGet package install dialog" src="https://github.com/user-attachments/assets/5a204e7c-100b-4d51-a007-ac774fa2687d" />
7898

7999
<img width="751" height="138" alt="Package installation progress" src="https://github.com/user-attachments/assets/f6beea61-c1de-404a-8603-08bc7249813a" />
@@ -82,14 +102,12 @@ flowchart LR
82102

83103
<img width="919" height="381" alt="Dependencies configuration panel" src="https://github.com/user-attachments/assets/2969fa11-edd9-4aa8-be15-955153847ee9" />
84104

85-
<img width="546" height="412" alt="Authentication configuration dialog" src="https://github.com/user-attachments/assets/dbc738ea-49a1-438e-ba01-9f3ea0b9e73a" />
86-
87-
<img width="539" height="686" alt="Storage connection setup" src="https://github.com/user-attachments/assets/b2cb5dd0-c33e-4c43-bf5f-7a46b50c08b9" />
88-
89105
<img width="519" height="558" alt="Package export options" src="https://github.com/user-attachments/assets/b98afee3-940f-402c-ae30-da0eb80d43a3" />
90106

91107
<img width="977" height="578" alt="Completed job package ready for upload" src="https://github.com/user-attachments/assets/822c7483-acbc-4a69-b3b6-bfe1e97ec051" />
92108

109+
<img width="546" height="412" alt="Copilot CLI not connected — warning shown when the AI Chat editor is opened without the CLI installed" src="https://github.com/user-attachments/assets/dbc738ea-49a1-438e-ba01-9f3ea0b9e73a" />
110+
93111
---
94112

95113
*Back to [Job Development](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Job-Development) · [Home](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Home)*

0 commit comments

Comments
 (0)