Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issues with HelloWorld samples in documentation #6439

Open
onlinegroeicoach opened this issue Feb 23, 2025 · 1 comment
Open

Issues with HelloWorld samples in documentation #6439

onlinegroeicoach opened this issue Feb 23, 2025 · 1 comment
Milestone

Comments

@onlinegroeicoach
Copy link

Documentation Improvement Request

Just started with Elsa and dong the 2 HelloWorld samples described on this page
https://docs.elsaworkflows.io/getting-started/hello-world

Documentation Issue Overview

Is your documentation issue related to a specific problem? Please describe.
Got the Console example working after minor changes in Program.cs:
Added these 2 usings
using Elsa.Workflows; // Contains IWorkflowRunner
using Elsa.Workflows.Activities; // Contains WriteLine

No clue how to get ASP.NET web app working however, too many issues and too new to the project to get what it tries to do.

Proposed Documentation Changes

Describe the changes or additions you'd like
Program.cs (of Console):
using Elsa.Extensions;
using Elsa.Workflows;
using Elsa.Workflows.Activities;
using Microsoft.Extensions.DependencyInjection;

// Setup service container.
var services = new ServiceCollection();

// Add Elsa services to the container.
services.AddElsa();

// Build the service container.
var serviceProvider = services.BuildServiceProvider();

// Instantiate an activity to run.
var activity = new WriteLine("Hello World!");

// Resolve a workflow runner to execute the activity.
var workflowRunner = serviceProvider.GetRequiredService();

// Execute the activity.
await workflowRunner.RunAsync(activity);

In ASP.NET web app put a line that the code is not tested in Elsa 3.2/3.3 and does not work anymore

Affected Sections

Identify which sections of the documentation are affected
Specify which parts of the documentation need updating. This could include README files, API docs, user manuals, or setup guides.

Impact of Changes

Explain the potential impact
Helps to get the Console example working, and saves user time trying out the other example that does not work.

Additional Context

Add any other context or visuals
Include any other information, links, or visuals that might help clarify your request. Visuals can be particularly useful in documentation to explain complex processes or configurations.

@onlinegroeicoach
Copy link
Author

onlinegroeicoach commented Feb 23, 2025

Think I know what my issue is, followed the guide and it setup version 3.3.3 instead of 3.0.0 when running "dotnet add package Elsa" for instance guide probably when only 3.0.0 was available and is not updated for 3.3.3 so just get the samples from https://github.com/elsa-workflows/elsa-guides/blob/main/README.md instead of running dotnet add package Elsa (without explicit 3.0.0 defined) which installs newer version (which follows very different syntax which is not documented).

@sfmskywalker sfmskywalker added this to the Elsa 3.4 milestone Feb 23, 2025
@sfmskywalker sfmskywalker moved this to Todo in ELSA 3 Feb 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

2 participants