playframework/playframework

play-socket.io not mentioned in documentation and examples

Open

#8,015 opened on Nov 16, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (12,623 stars) (4,032 forks)batch import
help wantedtopic:documentation

Description

Play Version (2.5.x / etc)

2.6.x

API (Scala / Java / Neither / Both)

both

Actual Behavior

The clustered chat client for socket io is not mentioned in the main play documentation and the chatroom examples don't mention it either:

not mentioned in

etc

May also want to add to tutorials page:

and include links to socket.io from the home page / 2.6.x highlights etc:

Contributor guide

Tech stack
scalajava
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Play documentation structureBasic understanding of Play Socket.IO
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests adding mentions of play socket.io to the main Play documentation, tutorials page (https://www.playframework.com/documentation/2.6.0/Tutorials#WebSocket), and the blog post (https://blog.playframework.com/play socket io/). Also the chatroom example repos (scala/clustered chat and java/clustered chat) should be linked from the documentation. The contributor should examine the existing documentation pages to find suitable places for these references, and then update the relevant markdown or HTML files in the playframework repository.