Akka-http: Consolidate the remainder of java/scala content in akka-http

[richardimaoka]

Continued from #1290 as the conversation of #1290 got too long.

Description:

Like we did on akka/akka#23052 "consolidate java/scala content", let's consolidate the java and scala contents in akka-http, too.

Below is the procedure described by @raboof.

The process is as follows:

• Mention in this issue which pages you're planning to merge
  
  
  
  • Either the Akka maintainers or @richard-imaoka can update the list below
  
  
• Compare a file in docs/src/main/paradox/java/... with the same one under docs/src/main/paradox/scala/.... They should cover the same contents, but one is for Java and the other is for Scala. The 'compare files' feature of IntelliJ IDEA is a nice tool for this.
• Update the file in the scala folder to contain both the Scala and Java content. You may use:
  @scala and @java directives for inline text
  @@@ div { .group-scala } for blocks
  code blocks become tabbed
• Replace the 'java' version of the page with a symlink:
  
  
  
  • Remove the old version (git rm akka-docs/src/main/paradox/java/...)
  
  
  • Create a symlink (cd akka-docs/src/main/paradox/java; ln -s ../scala/... ...; cd -)
  
  
  • Add the symlink to git (git add akka-docs/src/main/paradox/java/...)
    
    Test your changes (sbt akka-docs/paradox, see CONTRIBUTING.md for details, check both the Java and Scala versions)
  
  

You could look at https://github.com/akka/akka/pull/23039/files as an example - it's probably best to contribute PR's on a page-per-page basis at least at first. Feel free to let us know if you have any questions/problems!

[richardimaoka]

Under docs/src/main/paradox/java/http/

• [x] routing-dsl/index.md (@raboof #1600)

Directives:

• [x] routing-dsl/directives/cookie-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/scheme-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/cache-condition-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/caching-directives/cache.md (@raboof)
• [x] routing-dsl/directives/caching-directives/index.md (@jlprat #1671)
• [x] routing-dsl/directives/form-field-directives/formFieldList.md @raboof #1688
• [x] routing-dsl/directives/form-field-directives/formField.md @raboof #1688
• [x] routing-dsl/directives/form-field-directives/formFieldMultiMap.md @raboof #1688
• [x] routing-dsl/directives/form-field-directives/formFieldMap.md @raboof #1688
• [x] routing-dsl/directives/form-field-directives/index.md @raboof #1688
• [x] routing-dsl/directives/host-directives/extractHostName.md @raboof #1692
• [x] routing-dsl/directives/host-directives/host.md @raboof #1692
• [x] routing-dsl/directives/host-directives/index.md @raboof #1692
• [x] routing-dsl/directives/header-directives/optionalHeaderValue.md (@jlprat #1676)
• [x] routing-dsl/directives/header-directives/optionalHeaderValuePF.md (@jlprat #1676)
• [x] routing-dsl/directives/header-directives/headerValue.md (@jlprat #1676)
• [x] routing-dsl/directives/header-directives/optionalHeaderValueByType.md (@jlprat #1676)
• [x] routing-dsl/directives/header-directives/checkSameOrigin.md (@jlprat #1676)
• [x] routing-dsl/directives/header-directives/headerValueByType.md (@jlprat #1676)
• [x] routing-dsl/directives/header-directives/headerValueByName.md (@jlprat #1676)
• [x] routing-dsl/directives/header-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/header-directives/optionalHeaderValueByName.md (@jlprat #1676)
• [x] routing-dsl/directives/websocket-directives/extractOfferedWsProtocols.md @raboof #1627
• [x] routing-dsl/directives/websocket-directives/extractUpgradeToWebSocket.md @raboof #1627
• [x] routing-dsl/directives/websocket-directives/handleWebSocketMessagesForOptionalProtocol.md @raboof #1693
• [x] routing-dsl/directives/websocket-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/parameter-directives/parameters.md (@jlprat #1658)
• [x] routing-dsl/directives/parameter-directives/parameterMap.md (@jlprat #1658)
• [x] routing-dsl/directives/parameter-directives/parameterMultiMap.md (@jlprat #1658)
• [x] routing-dsl/directives/parameter-directives/parameter.md (@jlprat #1658)
• [x] routing-dsl/directives/parameter-directives/parameterSeq.md @raboof #1694
• [x] routing-dsl/directives/parameter-directives/index.md (@jlprat #1658)
• [x] routing-dsl/directives/debugging-directives/logResult.md @raboof #1695
• [x] routing-dsl/directives/debugging-directives/logRequest.md @raboof #1695
• [x] routing-dsl/directives/debugging-directives/logRequestResult.md @raboof #1695
• [x] routing-dsl/directives/debugging-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/path-directives/rawPathPrefixTest.md (@jlprat #1673)
• [x] routing-dsl/directives/path-directives/pathPrefixTest.md (@jlprat #1673)
• [x] routing-dsl/directives/path-directives/pathSuffix.md (@jlprat #1673)
• [x] routing-dsl/directives/path-directives/pathEndOrSingleSlash.md @raboof #1641
• [x] routing-dsl/directives/path-directives/rawPathPrefix.md (@jlprat #1673)
• [x] routing-dsl/directives/path-directives/pathSingleSlash.md (@jlprat #1673)
• [x] routing-dsl/directives/path-directives/pathEnd.md @raboof #1641
• [x] routing-dsl/directives/path-directives/index.md (@jlprat #1673)
• [x] routing-dsl/directives/path-directives/pathPrefix.md (@jlprat #1673)
• [x] routing-dsl/directives/path-directives/path.md @raboof #1641
• [x] routing-dsl/directives/method-directives/options.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/overrideMethodWithParameter.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/post.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/delete.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/extractMethod.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/head.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/get.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/method-directives/method.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/put.md (@jlprat #1659)
• [x] routing-dsl/directives/method-directives/patch.md (@jlprat #1659)
• [x] routing-dsl/directives/misc-directives/withSizeLimit.md (@jlprat #1663)
• [x] routing-dsl/directives/misc-directives/extractClientIP.md (@jlprat #1663)
• [x] routing-dsl/directives/misc-directives/rejectEmptyResponse.md (@jlprat #1663)
• [x] routing-dsl/directives/misc-directives/index.md @raboof #1608
• [x] routing-dsl/directives/misc-directives/validate.md @raboof #1640
• [x] routing-dsl/directives/file-upload-directives/storeUploadedFiles.md (@jlprat #1672)
• [x] routing-dsl/directives/file-upload-directives/fileUploadAll.md (@jlprat #1672)
• [x] routing-dsl/directives/file-upload-directives/fileUpload.md @raboof #1630
• [x] routing-dsl/directives/file-upload-directives/storeUploadedFile.md (@jlprat #1672)
• [x] routing-dsl/directives/file-upload-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/range-directives/withRangeSupport.md (@jlprat #1671)
• [x] routing-dsl/directives/range-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/future-directives/completeOrRecoverWith.md (@jlprat #1675)
• [x] routing-dsl/directives/future-directives/onCompleteWithBreaker.md (@jlprat #1675)
• [x] routing-dsl/directives/future-directives/onSuccess.md (@jlprat #1675)
• [x] routing-dsl/directives/future-directives/onComplete.md (@jlprat #1675)
• [x] routing-dsl/directives/future-directives/index.md (@jlprat #1675)
• [x] routing-dsl/directives/custom-directives.md @jlprat #/1704
• [x] routing-dsl/directives/security-directives/authorizeAsync.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateOAuth2PF.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authorize.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateBasicPFAsync.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateOrRejectWithChallenge.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateBasic.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateBasicAsync.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateOAuth2Async.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateOAuth2PFAsync.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/index.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateBasicPF.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/authenticateOAuth2.md (@jlprat #1696)
• [x] routing-dsl/directives/security-directives/extractCredentials.md (@jlprat #1696)
• [x] routing-dsl/directives/alphabetically.md (@jlprat just unification for the moment not consolidated #1709 contains the workaround with empty lines)
• [x] routing-dsl/directives/route-directives/redirect.md @jlprat #1702
• [x] routing-dsl/directives/route-directives/complete.md @jlprat #1702
• [x] routing-dsl/directives/route-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/file-and-resource-directives/getFromResourceDirectory.md @jlprat #1698
• [x] routing-dsl/directives/file-and-resource-directives/listDirectoryContents.md @jlprat #1698
• [x] routing-dsl/directives/file-and-resource-directives/getFromBrowseableDirectory.md @jlprat #1698
• [x] routing-dsl/directives/file-and-resource-directives/getFromResource.md @jlprat #1698
• [x] routing-dsl/directives/file-and-resource-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/by-trait.md (@jlprat #1707)
• [x] routing-dsl/directives/path-directives.md (@jlprat #1673)
• [x] routing-dsl/directives/coding-directives/requestEncodedWith.md (@jlprat #1671)
• [x] routing-dsl/directives/coding-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/timeout-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/timeout-directives/withRequestTimeout.md (@jlprat #1671)
• [x] routing-dsl/directives/marshalling-directives/completeWith.md @jlprat #1700
• [x] routing-dsl/directives/marshalling-directives/entity.md @jlprat #1700
• [x] routing-dsl/directives/marshalling-directives/handleWith.md @jlprat #1700
• [x] routing-dsl/directives/marshalling-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/execution-directives/index.md (@raboof #1608)
• [x] routing-dsl/directives/index.md @raboof
• [x] routing-dsl/directives/respond-with-directives/respondWithDefaultHeaders.md (@jlprat #1674)
• [x] routing-dsl/directives/respond-with-directives/index.md @raboof #1608
• [x] routing-dsl/directives/basic-directives/mapRequestContext.md @raboof #1630
• [x] routing-dsl/directives/basic-directives/provide.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/recoverRejections.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapRejections.md @raboof #1630
• [x] routing-dsl/directives/basic-directives/mapRequest.md @raboof #1630
• [x] routing-dsl/directives/basic-directives/recoverRejectionsWith.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapSettings.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapResponseEntity.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapRouteResultPF.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/extractUnmatchedPath.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/extract.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapRouteResult.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/extractRequest.md @raboof #1630
• [x] routing-dsl/directives/basic-directives/extractDataBytes.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/extractLog.md @raboof #1630
• [x] routing-dsl/directives/basic-directives/mapResponseHeaders.md @raboof #1630
• [x] routing-dsl/directives/basic-directives/mapRouteResultFuture.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapResponse.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapRouteResultWith.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/withExecutionContext.md @raboof #1631
• [x] routing-dsl/directives/basic-directives/index.md @raboof #1634
• [x] routing-dsl/directives/basic-directives/mapRouteResultWithPF.md @raboof #1630
• [x] routing-dsl/directives/basic-directives/extractParserSettings.md @raboof #1627

[jrudolph]

Woohoo done!!!! Great work, everyone!

[ktoso]

Awesome, and so quickly!
You're all awesome, thanks @richardimaoka @jlprat @jonas @raboof @jrudolph :)

[raboof]

🎉 🎅 🎉