dotnet/orleans

Can we add a “scenarios” page to the docs?

Open

#2,937 opened on Apr 13, 2017

View on GitHub
 (3 comments) (1 reaction) (0 assignees)C# (10,777 stars) (2,123 forks)batch import
Needs: documentation 📄help wanted

Description

Based on the questions I have had recently, it would be good to have a “scenario” section to the docs that explores where Actor / Orleans is a good fit. I have discussed IoT, Halo players, possibly bots, etc. If you scroll down https://azure.microsoft.com/en-us/services/functions/ you will see a great section of Function scenarios – would be great something similar for Orleans.

Contributor guide

Tech stack
csharp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with OrleansKnowledge of use cases
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue proposes creating a scenarios documentation page similar to the Azure Functions scenarios page. Investigate existing docs in the Orleans repository for current examples. Gather example scenarios like IoT, Halo players, bots, and others discussed in the comments. Draft a new markdown page in the docs folder and submit a pull request.