Closed cd-work closed 6 months ago
The analysis contains 1 package(s) Phylum has not yet processed, preventing a complete risk analysis. Phylum is processing these packages currently and should complete soon. Please wait for up to 30 minutes, then re-run the analysis.
The idea behind the requested documentation updates is to provide users with context and actionable next steps to take when they experience errors. Improving error messages is part of the solution (as was done in the Birdcage update here). The error messages only go so far, given their brevity, and the common text in a lot of these messages is to get more details at the https://docs.phylum.io/cli/lockfile_generation site.
However, that page does not have a troubleshooting section or information on common errors, leaving users scratching their head as to what went wrong and what they should do next. To improve the user experience for these error cases, it is expected that at least the following would exist on the docs/lockfile_generation.md
page:
Sandbox::spawn must be called from a single-threaded process
--skip-sandbox
?)This list is not exhaustive and will likely change over time as more users discover more errors.
Minimum system requirements
We don't know these and they might change at any time without our knowledge.
Explain why exact versions may not always be possible (like was done https://github.com/phylum-dev/birdcage/pull/69#discussion_r1481961961)
What does the user gain from us going on about why we can't provide information? That doesn't help them with troubleshooting at all.
Primary example is when used in a Docker container
This causes a panic and the message Sandbox::spawn must be called from a single-threaded process
Docker containers aren't all created equal. It is possible to run birdcage sandboxing inside Docker as far as I'm aware.
Did you test it and run into this error message? Because that is not the error message I would expect when running inside of Docker.
Lockfile generation sandbox exceptions/permissions
All of them? Because there's a lot. Most of them nobody needs to care about.
How to reach out for "level 2" support
Shouldn't this be covered by our general documentation? It makes no difference what kind of issue you run into when it comes to this. We don't need to repeat the same thing over and over for this.
FYI...the discussion was continued out of band. Some of the changes are represented in #1357 and the conversation will continue there.
Closes #1350.
I wouldn't make any documentation changes for this, however @maxrake has expressed interest in adding extra documentation. Could you go into additional details on what exactly you'd want to see documented?