topic Re: READ ME section in Workato Pros Discussion Board

READ ME section

gordonhuworkato — Wed, 14 Apr 2021 05:04:03 GMT

Just an idea...is Workato considering adding a section like READ ME in each recipe so that we can document what the use case is, and more granular detail.

Notes on each steps is great. But sometimes I forgot what a recipe was for unless I went back to confluence to check it.

If I have a magic wand: link workato recipe with some documentation platform like confluence, draw.io. This will help future workato chef when reading a recipe

Re: READ ME section

canderson — Wed, 14 Apr 2021 05:06:11 GMT

UPVOTE!

Re: READ ME section

sher-yim806 — Wed, 14 Apr 2021 05:10:48 GMT

There is a Description section under the Settings for each recipe. It wasn't obvious to find tho.

Re: READ ME section

christopher — Wed, 14 Apr 2021 05:11:19 GMT

Hi Gordon! If you go to the recipe 'Settings' there is a place where you can add a description of the recipe.

Re: READ ME section

gordonhuworkato — Wed, 14 Apr 2021 06:03:35 GMT

Oh my...now I feel dumb. This is the first time I see it. I think my eyes ignore that “description” on purpose. I only go to Settings to share the recipe with the support.

Thanks Christopher Benham!

Agree with Sher Yim that Description in Settings may not be the best place.

Re: READ ME section

john-zink-1 — Wed, 14 Apr 2021 06:14:10 GMT

There is already a description in the setting for each recipe. If that was updated to support markdown and moved to the recipe page (as opposed to buried in settings) I’d think that’d settle this use case without duplication from the current description section.

Re: READ ME section

mroldanvega — Wed, 14 Apr 2021 06:23:55 GMT

Is it searchable? Otherwise is not that helpful.

Re: READ ME section

ajorde — Wed, 14 Apr 2021 06:45:58 GMT

As long as we're talking magic wands, I'd love a recipe metadata section - let me add tags or fields to recipes and then allow those recipes to be read by recipeops actions (e.g., searching active recipes by mentioned tag to perform some action like starting/stopping recipes). Currently I manage this only through recipe naming convention.

Re: READ ME section

amlan — Thu, 15 Apr 2021 00:02:36 GMT

Nishtha Mehrotra tagging you for you suggestions. Adding tags to recipes and making recipes searchable by tags and by words in descriptions.

Re: READ ME section

nishtha — Sat, 17 Apr 2021 01:28:31 GMT

Thanks everyone for the suggestions! We'll keep these in mind as we are iterating on designs.