forked from galaxyproject/training-material
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request galaxyproject#4898 from galaxyproject/mau-duckbill
FAQ on wf best practices
- Loading branch information
Showing
4 changed files
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: Ensuring Workflows meet Best Practices | ||
area: workflows | ||
box_type: tip | ||
layout: faq | ||
contributors: [hexylena] | ||
--- | ||
|
||
When you are editing a workflow, there are a number of additional steps you can take to ensure that it is a Best Practice workflow and will be more reusable. | ||
|
||
1. Open a workflow for editing | ||
1. In the workflow menu bar, you'll find the {% icon galaxy-wf-options %} Workflow Options dropdown menu. | ||
1. Click on it and select "Best Practices" from the dropdown menu. | ||
|
||
![screenshot showing the best practices menu item in the gear dropdown.]({% link faqs/galaxy/images/best-practices1.png %}) | ||
|
||
1. This will take you to a new side panel, which allows you to investigate and correct any issues with your workflow. | ||
|
||
![screenshot showing the best practices side panel. several issues are raised like a missing annotation with a link to add that, and non-optional inputs that are unconnected. Additionally several items already have green checks like the workflow defining creator information and a license.]({% link faqs/galaxy/images/best-practices2.png %}) |