Skip to content

Improve readthedocs and example scripts #371

Description

@helen-m-lin

User story

As a user, I want to understand the task status for my upload job, so I can monitor my upload.
A few users have brought up that the "up_for_reschedule" status causes confusion and they are worried their job is stuck.

We can repurpose this ticket for general improvements to aind-data-transfer-service docs.

Acceptance criteria

  • Update the readthedocs User Guide to explain that "up_for_reschedule" status is expected when monitoring the compression jobs in slurm.
  • Review and update readthedocs user guide
  • Review and update example scripts

Sprint Ready Checklist

  • 1. Acceptance criteria defined
  • 2. Team understands acceptance criteria
  • 3. Team has defined solution / steps to satisfy acceptance criteria
  • 4. Acceptance criteria is verifiable / testable
  • 5. External / 3rd Party dependencies identified
  • 6. Ticket is prioritized and sized

Notes

Add any helpful notes here.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions