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 (598 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

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

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

Research direction
Replace the Scala DSL code snippets on the Java marshalling documentation page with Java equivalents.
Tech stack
scala
Domain
backenddocumentation
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.
Active
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.
85