Bug #22960
openRedundant CLI setup instructions in user guide and SDK sections
Description
These pages are seemingly redundant and it is a little bit confusing:
https://doc.arvados.org/v3.1/user/getting_started/setup-cli.html
https://doc.arvados.org/v3.1/sdk/python/sdk-python.html
In particular, I'm concerned that the user guide may be out of date (or maybe it is based on a common set of includes so it doesn't matter).
Related, a user was looking for arv-mount and although setup-cli includes arvados-fuse it isn't at all obvious that arvados-fuse is actually arv-mount, so we should make that clear in the text.
Updated by Brett Smith 10 months ago
- Related to Bug #21571: Documentation should call it "arv-mount" rather than "FUSE Driver" added
Updated by Brett Smith 9 months ago
I think this ticket is undergroomed and we need more thought to decide what to actually do.
Peter Amstutz wrote:
In particular, I'm concerned that the user guide may be out of date (or maybe it is based on a common set of includes so it doesn't matter).
I have manually confirmed that both sets of instructions work in a fresh Docker container. They don't use 100% the same includes, but in particular the repository setup instructions do use an include to keep them consistent. From there it's just a question of which packages you install, and it's not totally unreasonable to have a difference between "just the Python SDK" and "all the CLI tools."
The bigger problem here is one of intended flow. The user guide imagines you'll take the whole thing in order. This page is early in the guide, so that's why it spells everything out for you. All the SDK references expect you might pop in and out, so that's why they share a single repository setup page.
But, when someone uses a search engine for "install arvados python sdk," it's basically a crapshoot which page they'll end up on. It would be good if we provided the best flow for the user either way. But right now I don't think we have enough input or feedback to know what that is.
Given that there's no functional bug, I'm inclined to let sleeping dogs lie for now until we have a clearer direction for ourselves.
Related, a user was looking for arv-mount and although setup-cli includes arvados-fuse it isn't at all obvious that arvados-fuse is actually arv-mount, so we should make that clear in the text.
There was already a separate ticket for this, maybe I'll do that instead.
Updated by Brett Smith 9 months ago
- Target version deleted (
Development 2025-07-09)