Repository navigation
Add deprecations page to docs - #7766
Conversation
Add a docs page under "Updates" that lists discouraged, deprecated, and recently removed features, with the stable version for each. Fix deprecation markup and unmarked deprecations across the docs. Remove several legacy features that have been deprecated and undocumented for years: - `k8s.volumeClaims` config option - `REDUCED_REDUNDANCY` S3 storage class - `-pod-image` option of `kuberun` - Leftover handling of `process.$name` selectors in `Session.fetchContainers()` Signed-off-by: Ben Sherman <bentshermann@gmail.com>
✅ Deploy Preview for nextflow-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Note: the deprecations page is not meant to be exhaustive. I trimmed several entries from the original list discovered by the agent (e.g. config option renames). The goal is more to track the deprecation / removal of major user-facing features |
|
|
jorgee
left a comment
There was a problem hiding this comment.
A few suggestions:
1. List this PR's own removals on the new page
The "Removed" table and the 26.10 migration notes don't mention the features this PR removes:
k8s.volumeClaimsconfig option, replaced byk8s.storageClaimNameandk8s.storageMountPath-pod-imageoption ofkuberun, replaced by-head-imageREDUCED_REDUNDANCYvalue ofaws.client.storageClass. It is still accepted by thepublishDirandworkflow.outputstorageClassoptions, which do no validation, so it might be worth saying it is only removed from the config option.
k8s.volumeClaims matters most here. With this change, kuberun stops with "Missing K8s storage volume claim", and that message doesn't point to the replacement options. A row on this page and a bullet in the 26.10 breaking changes would help users find the replacement.
2. Discouraged vs deprecated mismatches
- Workflow
|and&are listed as discouraged here, butdocs/workflow.mdxtags them with<DeprecatedInVersion version="26.04">. - The process
whensection is listed as discouraged here and instrict-syntax.mdx, butdocs/reference/syntax.mdxcalls it deprecated.
It would be good to pick one status and use it everywhere.
3. Minor
Path.listFiles()is deprecated in 26.04 (it is in the 26.04 migration notes, and this PR updates its tag), but it is not on the page. Suggested row:listFiles()| 26.04 |listDirectory().- The
-entryrow only mentionsrun, but this PR also marks the option as deprecated inlaunch.
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
|
Thanks Jorge.
I don't mention these in the docs because they were deprecated many years ago and have not been documented for a long time either. So I think it is safe to simply remove all trace of them
I resolved all of these
I reworded the Some deprecations like |
Adds a Deprecations page under "Updates" in the docs. It lists discouraged, deprecated, and recently removed features, along with the stable version in which each was deprecated or removed. The goal is to give users one place to check what is going away, and to give us one place to track deprecations.
Docs fixes
DeprecatedInVersionconsistently, replacing a lowercase tag inconfig.mdxandChangedInVersionin two places-entryas deprecated in thelaunchreference and in the 24.10 migration notesaws.client.uploadStorageClassas deprecated in favor ofaws.client.storageClass-with-weblogfrom thekuberunoptions listpublishDir, and warn thatkuberunis no longer maintainedRemovals
These features have been deprecated, and undocumented, for years:
k8s.volumeClaimsconfig option (usek8s.storageClaimNameandk8s.storageMountPath)REDUCED_REDUNDANCYS3 storage class-pod-imageoption ofkuberun(use-head-image)process.$nameselectors inSession.fetchContainers(). The selector syntax itself was removed in 20.07, but this code still warned about it and reported the container inworkflow.containermetadata.