From df817a0aeeeb32b71ba09facee8d936c0cc5ac62 Mon Sep 17 00:00:00 2001 From: Benjamin Labrecque Date: Tue, 28 Jul 2026 08:29:34 +0200 Subject: [PATCH] docs: update add new service docs --- docs/user/add-new-service.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/user/add-new-service.md b/docs/user/add-new-service.md index 5d31193..4836810 100644 --- a/docs/user/add-new-service.md +++ b/docs/user/add-new-service.md @@ -4,9 +4,11 @@ Install the [uv](https://docs.astral.sh/uv/) package manager -## CLI +## CLI (Command-Line Interface) -Using the CLI: +We have our own cli called `agebd`. + +To use the cli, first clone this repo. Then: ``` cd cli @@ -36,7 +38,7 @@ The services are deployed to 2 environments: We distinguish between - `prod` vs `dev` PVs -- **services specific** PVs from a dedicated IOC vs **external** PVs from other IOCs +- **service specific** PVs from a dedicated IOC vs **external** PVs from other IOCs #### PVs - Service Specific @@ -49,15 +51,15 @@ In your code, you only use the `prod` name of a PV. The framework will automatic #### PVs - External -You can only access them. The framework will use the same PV in `prod` and `dev`, -i.e. there is no `dev` PV. +The framework will use the same PV in `prod` and `dev`, i.e. there is no `dev` PV. +However, in `dev` you can only read from the PV, whereas in `prod` you can also write to it. #### PVs - Examples | Environment | Service Specific | External | |---|---|---| -|`prod` | `PV("AGEBD-MYSERVICE:MYPVNAME")` | `PV("AGEOP-SOME-SERVICE:SOME-PVNAME")` | -| `dev` | `PV("AGEBD-MYSERVICE-DEV:MYPVNAME")` | - | +|`prod` | `PV("AGEBD-MYSERVICE:MYPVNAME")` read&write | `PV("AGEOP-SOME-SERVICE:SOME-PVNAME")` read&write | +| `dev` | `PV("AGEBD-MYSERVICE-DEV:MYPVNAME")` read&write | `PV("AGEOP-SOME-SERVICE:SOME-PVNAME")` readonly | ### Python