Update `get_data` notebook in runtime docs to use napa style identifiers

microbiomedata / user_research

0 stars 0 forks source link

Update `get_data` notebook in runtime docs to use napa style identifiers #34

Open ljohnson09 opened 4 months ago

ljohnson09 commented 4 months ago

Deliverable this task is associated with

See Deliverables tab here:

4.9 | Perform user research to refine public API capabilities

RACI

Tag people in their roles

Responsible: @dwinston @PeopleMakeCulture
Accountable: @aclum
Consulted: @turbomam
Informed: @ljohnson09 @aclum @shreddd

Describe the the task

[ ] Review and update documentation for API to ensure API user research participants have accurate help information

Criteria for completion

Documentation and examples are up-to-date

Estimate people time

Small tshirt size, maybe medium depending on needed updates

Completion Date (Goal)

5/31/24

Target Sprint Start & End Dates

Start: 5/20/24
End: 5/31/24

Tag Blocker/Contingent upon issues

[Tagg issues]

dwinston commented 4 months ago

@ljohnson09 can you please list the resources that user research participants will be directed to, so that we can ensure that they are accurate? I presume it is not just https://api.microbiomedata.org/docs?

ljohnson09 commented 4 months ago

Going to rope in @aclum and @shreddd here, I believe one task will be to see if the users can navigate the linkML docs to identify the proper queries. So this may actually be a @turbomam task?

And perhaps this link: https://microbiomedata.github.io/nmdc-runtime/nb/get_data/ since users will be tasked with finding data/metadata for a study of interest.

dwinston commented 4 months ago

Going to rope in @aclum and @shreddd here, I believe one task will be to see if the users can navigate the linkML docs to identify the proper queries. So this may actually be a @turbomam task?

I think your RACI formulation covers that — I could certainly consult @turbomam for that. 🙂

And perhaps this link: https://microbiomedata.github.io/nmdc-runtime/nb/get_data/ since users will be tasked with finding data/metadata for a study of interest.

Gotcha. Thanks.

aclum commented 4 months ago

it would be great to update https://microbiomedata.github.io/nmdc-runtime/nb/get_data/ to use napa style identifiers.

ssarrafan commented 4 months ago

Appears to be in progress. Will move to the next sprint.

aclum commented 3 months ago

@PeopleMakeCulture is there an update here? Is this still in progress?

ssarrafan commented 3 months ago

I'm removing this from the sprint. @PeopleMakeCulture @dwinston let me know if this is still an active issue. FYI @aclum

PeopleMakeCulture commented 3 months ago

I've added this to our Polyneme board for tracking

aclum commented 2 months ago

@PeopleMakeCulture do you have time to work on this next sprint?

PeopleMakeCulture commented 2 months ago

Yes I can get to it this week

PeopleMakeCulture commented 2 months ago

@aclum @ljohnson09 does the new title correctly capture scope for this issue?

aclum commented 2 months ago

yes

ssarrafan commented 2 months ago

Looks like it's active. Moving to next sprint.

ssarrafan commented 1 month ago

Appears to be blocked by something so I'm removing from the sprint. (Injured).

turbomam commented 1 month ago

Let me know if I'm needed in any way.

ssarrafan commented 1 month ago

@PeopleMakeCulture @dwinston assuming this goes in the backlog while Jing is gone?

ssarrafan commented 1 month ago

Removing from sprint. No update, no response.