corteza-docs icon indicating copy to clipboard operation
corteza-docs copied to clipboard

Workflows; what can be improved?

Open tjerman opened this issue 3 years ago • 2 comments

Is the existing workflows documentation clear and detailed enough so that it is understandable by a user that may not be that technical? What could be improved/refactored to make it shorter and clearer? Please review and improve/suggest improvements.

The current docs can be found here

tjerman avatar Apr 19 '21 06:04 tjerman

Hi, the documentation is great so far.

  • The first question when I started reading Workflow docs was "How do I create new workflow?". Docs jump right to explaining the editor but I don't even know where to create one to begin with.

ak99372 avatar Jun 24 '21 16:06 ak99372

Thanks for the feedback; we'll add this to the documentation.


If you're running the "vanilla" Corteza containers, you can see a "Workflows" app on the app selector (see here for example -- https://latest.cortezaproject.org/). Additionally, you can access workflows from the Corteza Admin panel, under Automation > Workflows. Lastly, you can navigate to the /workflow route of your instance; for example, https://latest.cortezaproject.org/workflow

We will add detailed instructions with screenshots to the documentation. If you are able and willing, feel free to open up a pull request for https://github.com/cortezaproject/corteza-docs/blob/2021.3.x/src/modules/integrator-guide/pages/workflows/index.adoc

tjerman avatar Jul 15 '21 14:07 tjerman