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.

Sign up for GitHub

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

Jump to bottom

Update Workflow Documentation - Parent Issue #4

Closed
16 tasks done
ssarrafan opened this issue Oct 25, 2024 · 6 comments
Closed
16 tasks done

Update Workflow Documentation - Parent Issue #4

ssarrafan opened this issue Oct 25, 2024 · 6 comments
Assignees
@ssarrafan
Labels
documentation Improvements or additions to documentation priority:high This is a high priority to a team member

Comments

@ssarrafan
Copy link
Contributor

ssarrafan commented Oct 25, 2024 •
edited
Loading

Format/template for workflow documentation agreed on at retreat 10/24/24:
Follow the template below for the index.rst file that is in the docs folder of the repo for your workflow:
Title of Workflow
(Image)
Workflow overview
Workflow availability
Requirements for Execution
Hardware requirements
Workflow dependencies
Software
Database(s)
Sample dataset(s)
Input
Output
Version history
Point of contact
@ssarrafan ssarrafan added the documentation Improvements or additions to documentation label Oct 25, 2024
@ssarrafan ssarrafan self-assigned this Oct 25, 2024
@ssarrafan
Copy link
Contributor Author

@kaijli @vlilanl @SamuelPurvine @picowatt @CamiloPosso @corilo I'm moving this issue to the next sprint. Please update this issue when your documentation tasks are completed or close your task so I can keep this updated. I would assume that most of the documentation has already been updated by now but leaving this one more sprint to finish things up.
@aclum FYI

@eecavanna eecavanna mentioned this issue Nov 19, 2024
Closed
@ssarrafan
Copy link
Contributor Author

Still in progress. Some just need to be reviewed and some updated based on the review.

@ssarrafan
Copy link
Contributor Author

Adding lipids workflow per Katherine.

@ssarrafan
Copy link
Contributor Author

So close! Adding this to the next sprint for the final doc.

@ssarrafan ssarrafan added the priority:high This is a high priority to a team member label Jan 9, 2025
@ssarrafan ssarrafan moved this from In Progress to In Review in Documentation Squad Board Jan 9, 2025
@ssarrafan
Copy link
Contributor Author

One last item to be reviewed before closing.

@aclum will review #74 and then we can close this parent issue out.

@ssarrafan
Copy link
Contributor Author

woohoo! closing issue

@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Squad Board Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ssarrafan ssarrafan

Labels
documentation Improvements or additions to documentation priority:high This is a high priority to a team member
Projects
2024 > 2025 - Sprint 53 - December 30, 2024 - January 10, 2025
Status: Done
Documentation Squad Board
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ssarrafan