Skip to content

Commit ecb3286

Browse files
committed
fix spelling; add deprecation policy to prgenv-gnu
1 parent 2b40f09 commit ecb3286

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/software/prgenv/prgenv-gnu.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ The release schedule is not fixed, with new versions will be released roughly ev
2323
| 24.11 | a100, gh200, zen2 | daint, eiger, santis, clariden, bristen |
2424
| 24.7 | gh200, zen2 | daint, eiger, todi |
2525

26+
### Deprecation policy
27+
28+
We will provide full support for 12 months after the uenv image is released, and remove the images when they are no longer being used or when system upgrades break their functionality on the system.
29+
30+
* It is recommended to document how you compiled and set up your workflow using `prgenv-gnu` so that you can recreate it with future versions.
31+
* The 24.7 release is no longer supported and will be removed at the end of July 2025 - users are encouraged to update to 24.11 or later, before requesting support.
32+
33+
### Versions
34+
2635
=== "24.11"
2736

2837
The key updates in version 24.11:v1 from the 24.7 version were:

docs/software/uenv/deploy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ uenv image delete --token=${HOME}/.ssh/jfrog-token <NAMESPACE>::<IMAGE>
196196
!!! danger
197197

198198
Removing a uenv that has been deployed (i.e. is in the `deploy::` namespace) is potentially disruptive for users.
199-
Please see the [uenv lifecycle][ref-uenv-lifecycle] guide for more information.
199+
Please see the [uenv life cycle][ref-uenv-lifecycle] guide for more information.
200200

201201
## Source code access
202202

@@ -228,7 +228,7 @@ Permissions to access restricted resources is set on a per-pipeline basis
228228
| `vmd` | `uenv-sources-csstaff` | `uenv-sources/vmd` | VMD requires an account to download the source code | Alberto Invernizzi |
229229

230230
[](){#ref-uenv-lifecycle}
231-
## uenv lifecycle
231+
## uenv life cycle
232232

233233
Scientific applications and tools have different release cycles (e.g. annual, quarterly or irregular), and the communities that use them have different expectations (e.g. ML users expect tools released in the last 3 months, while some scientific communities value support for old versions of software).
234234
For this reason, there is not a universal release and deprecation schedule for supported applications and programming environments - how often to release, how long to provide support, and when to remove old versions is up to the maintainer of the uenv, based on their user's requirements and the overheads of maintaining old versions.
@@ -260,7 +260,7 @@ The versioning section should provide the following information:
260260
* `sciapp/2023`: provided "as is" for the first quarter of 2025 while users have the chance to upgrade.
261261
* If there is a major breaking change to the system that would require a large effort to continue providing last year's version, and would require users to also update their workflow, we might choose to encourage deprecate early and help users upgrade to the latest version.
262262

263-
Generally speacking, uenv are removed (deleted from the `deploy::` namespace) under the following circumstances:
263+
Generally speaking, uenv are removed (deleted from the `deploy::` namespace) under the following circumstances:
264264

265265
- when they are no longer supported as per the deprecation policy of the uenv;
266266
- when release candidates are superceded by a new release candidate or an official `:v1` release;

0 commit comments

Comments
 (0)