OpenEnergyPlatform / OpenEnergyPlatform/oeplatform
Link the academy notebooks from the platform, and put their re-run in the release procedure
Open
@jh-RLI is already working on this.
Since Sep 15, 2026.
documentation
OEKG-API
- Dominant language
- Python
- Stars
- 65
- Forks
- 29
- Avg merge
- 15h 25m
- Merged PRs (30d)
- 32
Description
Parent
Spec: #2454 — Document and teach the OEKG REST API. Derived from WF-15 decisions D16 and D17.
What to build
The notebooks become reachable from the platform, and the chore that keeps them true gets an owner.
They are frozen snapshots protected by nothing mechanical — the code→doc pinning test for them was specified, costed and declined. A dated banner plus a line on the release procedure is therefore their entire defence, so that line has to actually exist, in the document releases are actually run from.
Acceptance criteria
- Both tutorial URLs are added to the platform's external tutorial URL map, beside the existing academy tutorial links.
- The OEKG API documentation links to both notebooks.
-
RELEASE_PROCEDURE.mdgains a step in its numbered release list: after the production deploy, re-run both academy notebooks against production and update their dated banner to the released version. - The step names the academy repository, since the files being re-run and re-committed live there.
- Changelog entry.
Blocked by
- #2463 and #2464 — the two notebooks — both URLs are needed, and there is nothing to re-run until both exist.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.