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# (2,123 forks)batch import
Needs: documentation 📄help wanted

Repository metrics

Stars
 (10,777 stars)
PR merge metrics
 (Avg merge 2d 2h) (64 merged PRs in 30d)

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

Research direction
Identify common scenarios where Orleans shines and propose a structure for a scenarios page in the documentation.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git.NET basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80