Project

General

Profile

Actions
Copy link

Feature #21572

closed

Reorganize doc/user/getting_started/setup-cli.html to prioritize installing as much as possible

Added by Brett Smith 5 months ago. Updated about 1 month ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Brett Smith
Category:
Documentation
Target version:
Development 2024-06-19 sprint
Story points:
-

Description

User requested that this page just have a block of commands they can copy and paste to set everything up. I don't know if we can get 100% there right now, but we could probably get a lot closer, and good enough, with reasonable effort. Right now the page expects you to read a separate install page for each tool, which is a lot of hoop-jumping. Planned sections:

  1. Install with Debian/Ubuntu packages: Set up the apt repository, update, install all the client tool packages
  2. Install with RHEL family packages: Set up the yum repository, update, install all the client tool packages
  3. Install without privileges: Probably break this up into subsections to go from what most people will find easiest vs. hardest. Explain what you get at each step and let users know they can jump off whenever.
    1. The Python tools: run python3 -m venv, pip install arvados-cwl-runner arvados_fuse crunchstat_summary
    2. If #20727 is done: Download arvados-client to the right place
    3. The Ruby tools: gem install arvados-cli—I'm less sure what's an appropriate incantation for this

The page can then link to separate pages for individual tools, for more information or for people who want to be more selective for whatever reason.

Subtasks 1 (0 open — 1 closed)

Task #21593: Review 21572-user-packagesResolvedBrett Smith06/14/2024Actions
Actions
Copy link
 #2

Updated by Brett Smith 5 months ago

  • Description updated (diff)
Actions
Copy link
 #3

Updated by Peter Amstutz 4 months ago

  • Target version set to Development 2024-03-27 sprint
Actions
Copy link
 #4

Updated by Peter Amstutz 4 months ago

  • Assigned To set to Brett Smith
Actions
Copy link
 #5

Updated by Peter Amstutz 4 months ago

  • Target version changed from Development 2024-03-27 sprint to Development 2024-04-10 sprint
Actions
Copy link
 #6

Updated by Peter Amstutz 3 months ago

  • Target version changed from Development 2024-04-10 sprint to Development 2024-04-24 sprint
Actions
Copy link
 #7

Updated by Peter Amstutz 3 months ago

  • Target version changed from Development 2024-04-24 sprint to Development 2024-05-22 sprint
Actions
Copy link
 #8

Updated by Peter Amstutz 3 months ago

  • Target version changed from Development 2024-05-22 sprint to Development 2024-06-05 sprint
Actions
Copy link
 #9

Updated by Peter Amstutz 2 months ago

  • Target version changed from Development 2024-06-05 sprint to 439
Actions
Copy link
 #10

Updated by Peter Amstutz 2 months ago

  • Target version changed from 439 to Development 2024-06-05 sprint
Actions
Copy link
 #11

Updated by Peter Amstutz about 2 months ago

  • Target version changed from Development 2024-06-05 sprint to Development 2024-06-19 sprint
Actions
Copy link
 #12

Updated by Brett Smith about 1 month ago

  • Status changed from New to In Progress
Actions
Copy link
 #13

Updated by Brett Smith about 1 month ago

Brett Smith wrote:

  1. Install without privileges: Probably break this up into subsections to go from what most people will find easiest vs. hardest. Explain what you get at each step and let users know they can jump off whenever.

I'm starting to think it doesn't make sense to do this in the abstract, because realistically you'll need privileges to install build tools and headers for curl and FUSE. At that point, the instructions are so much more complicated for such a narrow use case, I don't think the effort is justified.

What might make sense is a higher-level generic "how to add Arvados Python packages to your development environment." But then it probably makes sense to have that documentation in the Python package(s) specifically, rather than this generic "setup client tools" page.

Actions
Copy link
 #14

Updated by Brett Smith about 1 month ago

21572-user-packages @ c053155a074d202cc4a52a4a5829bd0083a3a69f - developer-run-tests: #4282

  • All agreed upon points are implemented / addressed.
    • More or less, see the caveat above
  • Anything not implemented (discovered or discussed during work) has a follow-up story.
    • N/A
  • Code is tested and passing, both automated and manual, what manual testing was done is described
    • See above. Also tested the install instructions by hand in Docker containers of focal (the oldest deb-based distro we support) and Rocky 8.8.
  • Documentation has been updated.
    • Yes
  • Behaves appropriately at the intended scale (describe intended scale).
    • N/A for a pure documentation branch
  • Considered backwards and forwards compatibility issues between client and server.
    • Ditto
  • Follows our coding standards and GUI style guidelines.
    • N/A (no documentation style guide)
Actions
Copy link
 #15

Updated by Lucas Di Pentima about 1 month ago

This makes it a lot less cumbersome. LGTM, thanks!

Actions
Copy link
 #16

Updated by Brett Smith about 1 month ago

  • Status changed from In Progress to Resolved
Actions
Copy link

Also available in: Atom PDF