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

metaG - Valerie #14

Closed
Tracked by #4
ssarrafan opened this issue Oct 25, 2024 · 5 comments · Fixed by #45
Closed
Tracked by #4

metaG - Valerie #14

ssarrafan opened this issue Oct 25, 2024 · 5 comments · Fixed by #45
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ssarrafan
Copy link
Contributor

ssarrafan commented Oct 25, 2024

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

If you have updated figures please put the editable components of the figures here as well as in the documentation
Please follow the following format for updating your documentation:

@ssarrafan
Copy link
Contributor Author

@kaijli what's the status of this? Is this in progress? Can you complete this by Friday?

@eecavanna
Copy link
Collaborator

eecavanna commented Nov 21, 2024

Since the workflow repo doesn't have the actual workflow code in it, it does make sense to me to not add the docs there as that might imply to people that that is a "complete" repo. With that in mind, I'd recommend you put the docs for that workflow (er, that "wrapper workflow") directly in this repo, in:

content/nmdc/src/reference

You can create a new Markdown document in there. When you open a PR, I'll look into how to add some link to that new document. I don't think it'll appear on the sidebar automatically, nor do I think all of our teammates will necessarily support it being visible in the sidebar.

@aclum
Copy link
Contributor

aclum commented Nov 22, 2024

Shouldn't this go in the EDGE repo b/c that is where the end to end WDL is?

@kaijli kaijli linked a pull request Nov 26, 2024 that will close this issue
@kaijli kaijli moved this from In Progress to In Review in 2024 - Sprint 50 - November 18 - 29, 2024 Nov 27, 2024
@ssarrafan
Copy link
Contributor Author

@aclum @eecavanna @kaijli let's discuss this at the next doc squad meeting? I'll add a post to the slack channel.

@kaijli
Copy link
Contributor

kaijli commented Nov 27, 2024

We decided to put it in the documentation repository during the recent Tuesday meeting. Pull request has been opened and documentation is ready for review.

@ssarrafan ssarrafan moved this from In Progress to In Review in Documentation Squad Board Dec 3, 2024
@kaijli kaijli closed this as completed in #45 Dec 9, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Squad Board Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

5 participants