Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task
ljohnson09 opened this issue May 20, 2024 · 18 comments · May be fixed by microbiomedata/nmdc-runtime#598
Open
1 task
Assignees

Comments

@ljohnson09
Copy link
Contributor

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

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
Copy link

@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
Copy link
Contributor Author

ljohnson09 commented May 21, 2024

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
Copy link

dwinston commented May 21, 2024

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
Copy link

aclum commented May 21, 2024

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

@ssarrafan
Copy link
Contributor

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

@aclum
Copy link

aclum commented Jun 14, 2024

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

@ssarrafan
Copy link
Contributor

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

@PeopleMakeCulture
Copy link

I've added this to our Polyneme board for tracking

@PeopleMakeCulture PeopleMakeCulture moved this from Bench to Lineup in Polyneme mixset Jun 19, 2024
@PeopleMakeCulture PeopleMakeCulture moved this from Lineup to On base in Polyneme mixset Jun 24, 2024
@PeopleMakeCulture PeopleMakeCulture moved this from On base to Lineup in Polyneme mixset Jun 24, 2024
@PeopleMakeCulture PeopleMakeCulture moved this from Lineup to On base in Polyneme mixset Jul 10, 2024
@aclum
Copy link

aclum commented Jul 12, 2024

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

@PeopleMakeCulture
Copy link

Yes I can get to it this week

@PeopleMakeCulture PeopleMakeCulture moved this from On base to At bat in Polyneme mixset Jul 15, 2024
@PeopleMakeCulture PeopleMakeCulture moved this from Todo to In Progress in 2024 - Sprint 41 - July 15-26, 2024 Jul 15, 2024
@PeopleMakeCulture PeopleMakeCulture changed the title Update API documentation for Q3 UR round Update get_data notebook in runtime docs to use napa style identifiers Jul 15, 2024
@PeopleMakeCulture
Copy link

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

@aclum
Copy link

aclum commented Jul 15, 2024

yes

@ssarrafan
Copy link
Contributor

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

@ssarrafan
Copy link
Contributor

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

@turbomam
Copy link
Member

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

@ssarrafan
Copy link
Contributor

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

@ssarrafan
Copy link
Contributor

Removing from sprint. No update, no response.

@aclum
Copy link

aclum commented Oct 21, 2024

Pinged the pull request to see if can be worked on again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Front of house
6 participants