akka/akka-http

Fix marshalling docs for Java

Open

#1,367 opened on Aug 18, 2017

View on GitHub
聽(10 comments)聽(0 reactions)聽(1 assignee)Scala聽(1,311 stars)聽(598 forks)batch import
1 - triagedhelp wantedt:docs

Description

This one was very very embarrassing to find...

The marshalling page for JavaDSL is ScalaDSL 馃槶 "TODO overhaul for Java" We did not notice for quite some time it seems...

http://doc.akka.io/docs/akka-http/current/java/http/common/marshalling.html We've had this since 2.4: http://doc.akka.io/docs/akka/2.4.10/java/http/common/marshalling.html

We have to fix this soon.

Contributor guide

Tech stack
javarest api
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Java DSLAkka HTTP basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue states that the marshalling page for JavaDSL incorrectly shows ScalaDSL code. The incorrect pages are at: http://doc.akka.io/docs/akka http/current/java/http/common/marshalling.html and http://doc.akka.io/docs/akka/2.4.10/java/http/common/marshalling.html. To fix, locate the source file for the Java documentation (likely in the akka http repository under docs/src/main/paradox/java/http/common/marshalling.md or similar). Replace the ScalaDSL code snippets with correct Java DSL examples. Refer to existing working Java documentation or the ScalaDSL page for guidance. The issue has been assigned, so coordinate with the assignee to avoid duplication.
Fix marshalling docs for Java 路 akka/akka-http#1367 | Good First Issue