akka/akka-core

Link back from cluster-sharding.md to cluster-usage.md#node-roles

Open

#25,440 opened on Aug 6, 2018

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:cluster-shardingt:docs

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

cluster-sharding.md talks about 'roles', which can be confusing for users not yet familiar with that general cluster concept. We should at least add some links back to the cluster-usage.md#node-roles section, and perhaps even show the @akka.cluster.roles@ setting in a quick configuration example snippet on cluster-sharding.md

Contributor guide

Research direction
Locate the cluster sharding.md file, add a hyperlink to cluster usage.md#node roles, and optionally include a configuration example for the akka.cluster.roles setting.
Tech stack
scala
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90