Merge pull request #4898 from galaxyproject/mau-duckbill

FAQ on wf best practices

_config.yml

@@ -145,6 +145,7 @@ icon-tag:
   galaxy-wf-edit: fa fa-edit
   galaxy-wf-new: fas fa-plus
   galaxy-wf-report-download: fas fa-print
+  galaxy-wf-options: fas fa-cog
   galaxy_instance: fas fa-external-link-alt
   github: fab fa-github
   gitter: fab fa-gitter

faqs/galaxy/workflows_best_practices.md

@@ -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 %})