Git Product home page Git Product logo

elsa-website's Introduction

⚠️ DOCUMENTATION HAS MOVED!

The new home for Elsa documentation has moved to elsa-documentation.

See you there!

elsa-website's People

Contributors

ansario avatar c-lillini avatar constantine-v avatar delaet avatar dependabot[bot] avatar mikecasas avatar progala2 avatar sfmskywalker avatar simona-taran avatar sipkeschoorstrartl avatar swuecho avatar terle avatar totpero avatar vahidnaderi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

elsa-website's Issues

How to Connect Console Workflow to Elsa Studio

Hello Team ,

I want to connect Elsa.Sample.RabbitMQWorker to Elsa Studio to visualize the workflow but unable to connect it.. Please let me know how to connect console workflow to Elsa Studio.

TIA
Regard
Rahul

Reference errors for 'GenerateSignalUrl' and 'WithBranches'.

I am getting the below reference errors in my dotnet core 3.1 application.
1.) I am trying to generate an absolute URL containing the security token as "context.GenerateSignalUrl("Approve")" but getting error as below:
'ActivityExecutionContext' does not contain a definition for 'GenerateSignalUrl' and no accessible extension method 'GenerateSignalUrl' accepting a first argument of type 'ActivityExecutionContext' could be found (are you missing a using directive or an assembly reference?)

2.) I am trying to divide the workflow into multiple branches as "activity => activity.WithBranches("Approve", "Reject")" but getting erros as below:
'IActivityBuilder' does not contain a definition for 'WithBranches' and the best extension method overload 'ForkExtensions.WithBranches(ISetupActivity, params string[])' requires a receiver of type 'ISetupActivity'

It would be great if anyone could let me know what I am missing.

Thank you.

Docs menu links results in 404

When you are on:

https://elsa-workflows.github.io/elsa-core/

Go to the lower left corner menu under docs. None of the links are working and resulting in a 404

URLs behind the menu links:

Getting started:
https://elsa-workflows.github.io/elsa-core/docs/installing-elsa-core

Concepts:
https://elsa-workflows.github.io/elsa-core/docs/concepts-workflows

Guides:
https://elsa-workflows.github.io/elsa-core/docs/concepts-workflows

The links seems to be missing /installation/ path after the /docs.

Example of working link:
https://elsa-workflows.github.io/elsa-core/docs/installation/installing-elsa-core

To learn how to use Elsa, a user should be able to read usage documentation

One of two "elephant in the room" issues relating to docs. This one deals with docs that users will want to read, wheras #17 deals with docs for developers. Users will need some documentation for Elsa 2.0. We are going to need to decide how much we are planning on preparing, and start scheduling the work to write it.

It might be best to treat this particular issue as a spike, with the intended outcome of analysis & agreement. That way this issue doesn't inflate like a balloon and become a never-ending "Do all the work!" issue. In that case, the outcome of this will be to create a series of follow-up issues to write specific, agreed-upon pieces of documentation.

Here are some ideas of docs which users might want to read. We could use this as a starting-point for discussion, and it's almost certainly not complete:

  • Conceptual overviews
  • Introduction to each pre-created activity
    • What does it do?
    • What are its configuration parameters?
    • Does it expect any specific inputs?
    • What are its outputs?
  • How-to guides for the Dashboard & Designer UIs

Acceptance criteria

Presuming we treat this issue as a spike, then the team should have worked-up and agreed upon a list of user documentation topics which we plan to provide for Elsa 2.0.
In that case, further issues should be created and scheduled so that each of those may be worked-upon.

To learn how to use Elsa, a developer should be able to read API & usage documentation

One of two "elephant in the room" issues relating to docs. This one deals with docs that developers will want to read, wheras elsa-workflows/elsa-core#701 deals with docs for users. Developers will need some documentation for Elsa 2.0. We are going to need to decide how much we are planning on preparing, and start scheduling the work to write it.

It might be best to treat this particular issue as a spike, with the intended outcome of analysis & agreement. That way this issue doesn't inflate like a balloon and become a never-ending "Do all the work!" issue. In that case, the outcome of this will be to create a series of follow-up issues to write specific, agreed-upon pieces of documentation.

Here are some ideas of docs which developers might want to read. We could use this as a starting-point for discussion, and it's almost certainly not complete:

  • Installation & set-up
    • How to use each of the persistence back-ends
    • How to install & integrate with some of the other elective techs (Hangfire, Quartz etc)
    • This probably doesn't need full docs, because we can refer to docs for those techs
    • Setting up the dashboard/designer
  • Conceptual overviews
  • Integration with other technologies
    • ASP.NET Core
    • Dependency Injection
    • Logging
    • Again, not all of these need full docs, because we just need to point out that we use XYZ known mechanism
  • Extending Elsa: Creating your own activity classes
  • Minimum requirements
    • Compatible runtimes
    • Browser compatibility for the dashboard/designer
    • Compatible persistence back-ends
  • API docs
    • Specific service interfaces which devs should know about to perform common tasks
    • Like some of the stores, to get workflow instances and definitions
    • Triggers & signals
  • What's available?
    • A list of the elective NuGet packages
    • An overview of what each one provides

Acceptance criteria

Presuming we treat this issue as a spike, then the team should have worked-up and agreed upon a list of developer documentation topics which we plan to provide for Elsa 2.0.
In that case, further issues should be created and scheduled so that each of those may be worked-upon.

Signal received activity Scope dropdown not available

As per the guides Signal received activity - Scope selected -> Instance
but in ver 2.6.0 Signal received activity the Scope Dropdown is missing.
the example in the guide does not work, is it due to the missing Instance selector
SignalReceivedDialog_As_Per_guide
SignalReceivedDialog_As_Per_guide

Update Documentation

Hello Elsa,

As I am going to explore ELSA, but documentation part is not complete on this https://elsa-workflows.github.io/ and
current running version of Elsa 2.8 and documents are on 2.2

Kindly update the document as well, so it could be easy to understand

To avoid confusion, users should be able to read docs about when Workflows will fail to persist

This is a follow-up issue raised due to some confusion about when Workflow instances should persist and when they should not.

The information is in this issue comment but could be reworded and should be added to some documentation.

Note that after that discovery was made, the default persistence behaviour was changed to WorkflowBurst (previously it had been Suspend). This means that more workflow instances will persist than before.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.