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
docs: add Kanboard Portfolio plugin URL to orchestration documentation
Resolves the PORTFOLIO_PLUGIN_URL blocker from Task 62 (US-014).
Plugin URL: https://github.com/geekmuse/kanboard-plugin-portfolio-management
- README.md: add server-side visualization section with plugin link
- docs/sdk-guide.md: add plugin note in orchestration overview and
replace Phase 1 placeholder reference with real link
- docs/design/cross-project-orchestration.md: replace /tmp/ spec
reference and bare repo name with real linked URL in section 3.3
and component table
Copy file name to clipboardExpand all lines: README.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,6 +95,12 @@ with KanboardClient(url=URL, token=TOKEN) as kb:
95
95
critical = analyzer.get_critical_path(tasks)
96
96
```
97
97
98
+
### Server-side visualization (optional)
99
+
100
+
For in-browser Kanboard UI features — including interactive dependency graphs, multi-project Gantt timelines, portfolio dashboards, and board-level blocking indicators — see the companion **[Kanboard Portfolio plugin](https://github.com/geekmuse/kanboard-plugin-portfolio-management)**.
101
+
102
+
The CLI's `portfolio` and `milestone` commands work independently of the plugin, but the plugin provides the visual layer within Kanboard's web interface.
103
+
98
104
See **[docs/sdk-guide.md#cross-project-orchestration](docs/sdk-guide.md#cross-project-orchestration)** and **[docs/cli-reference.md#portfolio](docs/cli-reference.md#portfolio)** for full reference documentation.
|**CLI/SDK client**|`kanboard-cli` (this repo) | Python | CLI-side orchestration (Phase 0 — no plugin), typed SDK resource modules for the plugin API (Phase 1+), CLI commands for portfolio/milestone/dependency workflows |
291
291
292
292
**Key principle:** The CLI provides cross-project orchestration value **independently** of the plugin (Phase 0), and gains additional capabilities when the plugin is installed (Phase 1+). The plugin is an external dependency, not something built or maintained within this project.
@@ -348,9 +348,7 @@ A product company managing multiple software products and a marketing/site proje
348
348
349
349
The Kanboard Portfolio plugin is a **separate PHP project** maintained in its own repository. It is not built, tested, or shipped as part of `kanboard-cli`.
350
350
351
-
> **Plugin specification:** See `/tmp/kanboard-portfolio-plugin-spec.md` for the complete
352
-
> implementation specification (2,400+ lines covering data model, all 28 API endpoints,
353
-
> controllers, templates, events, security, and testing strategy).
**The orchestration classes are opt-in and not wired into `KanboardClient`.** Callers instantiate them separately, passing a `KanboardClient` as a constructor argument.
906
906
907
+
> **Note:** The orchestration classes work with any standard Kanboard instance — no server-side plugin is required for core functionality. For additional server-side features (UI dashboards, interactive dependency graphs, Gantt timelines, and board-level blocking indicators), see the [Kanboard Portfolio plugin](https://github.com/geekmuse/kanboard-plugin-portfolio-management).
`PortfolioManager` aggregates task data across multiple projects and computes milestone progress. It makes N+1 API calls by design (one per project/task) — acceptable for Phase 0; a server-side plugin will solve this in Phase 1.
998
+
`PortfolioManager` aggregates task data across multiple projects and computes milestone progress. It makes N+1 API calls by design (one per project/task) — acceptable for Phase 0; the [Kanboard Portfolio plugin](https://github.com/geekmuse/kanboard-plugin-portfolio-management) will solve this at scale in Phase 1.
0 commit comments