[codex] Clarify self-update guidance for sudo installs#7004
Draft
llewellyn-sl wants to merge 1 commit intomasterfrom
Draft
[codex] Clarify self-update guidance for sudo installs#7004llewellyn-sl wants to merge 1 commit intomasterfrom
llewellyn-sl wants to merge 1 commit intomasterfrom
Conversation
Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
Tracking EDU-1119 docs automation recovery run. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This draft adds a targeted warning for
nextflow self-updateinstalls that were done withsudoor into root-owned locations, plus recovery steps if that leaves the installation unusable.Source context
Doc target
docs/install.mddocs/updating-nextflow.mdRationale
The EDU ticket called out a docs gap around users breaking local Nextflow installs after running
self-updatewith elevated permissions. The existing docs already warn that restricted permissions can break self-install and self-update, so this draft keeps the change narrow: it makes thesudo/ root-owned path explicit, recommends a user-writable install location, and adds a short recovery sequence for the broken-install case.Validation
python3 -m sphinx -b dummy . /tmp/nextflow-docs-dummyfromdocs/, but this environment does not havesphinxinstalledFollow-up
If we see more cases like this, the install and update docs may also benefit from a short troubleshooting section for common local permission mistakes.