Project

General

Profile

Actions

Bug #19926

closed

Python SDK reverses option 1 / option 2 between "install" and "test" sections

Added by Peter Amstutz over 1 year ago. Updated about 1 year ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Story points:
0.5
Release relationship:
Auto

Description

https://doc.arvados.org/v2.5/sdk/python/sdk-python.html

The install has option 1: OS package / option 2: pip

The test section refers to option 1: pip and then option 2: OS package

  1. Fix the ordering
  2. In the "test" section, put option 1 / option 2 under headings so it is more clear

Subtasks 1 (0 open1 closed)

Task #20050: Review 19926-pysdk-install-docs-fixResolvedStephen Smith02/02/2023Actions
Actions #1

Updated by Peter Amstutz over 1 year ago

  • Description updated (diff)
Actions #2

Updated by Peter Amstutz over 1 year ago

  • Story points set to 0.5
Actions #3

Updated by Peter Amstutz about 1 year ago

  • Target version changed from To be scheduled to 2023-02-15 sprint
Actions #4

Updated by Peter Amstutz about 1 year ago

  • Assigned To set to Brett Smith
Actions #5

Updated by Brett Smith about 1 year ago

19926-pysdk-install-docs-fix @ c260a7641679548fbb3623206a9950bb5e0a4dec

I went further than the ticket said, I went ahead and flattened the whole page so each install section includes its own install steps, test steps, and then directs you to further documentation. This way readers don't have to keep alternating between sections they skip and sections they read. I did it in like 30 minutes so still well under the estimated time.

Actions #6

Updated by Brett Smith about 1 year ago

  • Status changed from New to In Progress
Actions #7

Updated by Stephen Smith about 1 year ago

This lgtm!

Actions #8

Updated by Brett Smith about 1 year ago

  • Status changed from In Progress to Resolved
Actions #9

Updated by Peter Amstutz about 1 year ago

  • Release set to 57
Actions

Also available in: Atom PDF