New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate java/scala content in akka-http #1290

Closed
richardimaoka opened this Issue Jul 19, 2017 · 39 comments

Comments

Projects
None yet
7 participants
@richardimaoka
Contributor

richardimaoka commented Jul 19, 2017

Like we are doing 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

This comment has been minimized.

Show comment
Hide comment
@richardimaoka

richardimaoka Jul 19, 2017

Contributor

Let me know which one you want to work on, and I'll mark your name for the file!

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

  • client-side/client-https-support.md - @jonas
  • client-side/client-transport.md - @jonas
  • client-side/connection-level.md - @jonas
  • client-side/host-level.md (@jlprat)
  • client-side/index.md (@jlprat)
  • client-side/pool-overflow.md (@jlprat)
  • client-side/request-level.md (@jlprat)
  • client-side/websocket-support.md (@jlprat)
  • common/de-coding.md (@jlprat)
  • common/http-model.md (@jlprat)
  • common/index.md - @jonas
  • common/json-support.md (@jonas)
  • common/marshalling.md - (@jonas, #1367)
  • common/timeouts.md - @jonas
  • common/unmarshalling.md - @jonas
  • common/uri-model.md (@jlprat)
  • configuration.md (@jlprat)
  • handling-blocking-operations-in-akka-http-routes.md (@jlprat)
  • implications-of-streaming-http-entity.md (@jlprat)
  • index.md (@jlprat)
  • introduction.md (@jlprat)
  • migration-guide/index.md (@jrudolph)
  • migration-guide/migration-from-old-http-javadsl.md (@jrudolph)
  • migration-guide/migration-guide-2.4.x-10.0.x.md (@jrudolph)
  • routing-dsl/exception-handling.md (@jlprat)
  • routing-dsl/HttpApp.md (@jlprat)
  • routing-dsl/index.md (@raboof #1600)
  • routing-dsl/marshalling.md - should be merged into common/marshalling - (@jonas, #1367)
  • routing-dsl/overview.md (@raboof, #1599)
  • routing-dsl/rejections.md (@jonas)
  • routing-dsl/routes.md (@atiqsayyed)
  • routing-dsl/source-streaming-support.md (@atiqsayyed)
  • routing-dsl/testkit.md (@atiqsayyed)
  • sse-support.md (@jonas)
  • server-side/low-level-server-side-api.md (@jlprat)
  • server-side/websocket-support.md (@jonas)
  • server-side-https-support.md (@jonas)
and
  • docs/src/main/paradox/java.md

Directives:

  • routing-dsl/directives/cookie-directives/setCookie.md
  • routing-dsl/directives/cookie-directives/deleteCookie.md
  • routing-dsl/directives/cookie-directives/cookie.md
  • routing-dsl/directives/cookie-directives/optionalCookie.md
  • routing-dsl/directives/scheme-directives/extractScheme.md
  • routing-dsl/directives/scheme-directives/scheme.md
  • routing-dsl/directives/cache-condition-directives/conditional.md
  • routing-dsl/directives/caching-directives/alwaysCache.md
  • routing-dsl/directives/caching-directives/cachingProhibited.md
  • routing-dsl/directives/header-directives/headerValuePF.md
  • routing-dsl/directives/websocket-directives/handleWebSocketMessages.md
  • routing-dsl/directives/websocket-directives/handleWebSocketMessagesForProtocol.md
  • routing-dsl/directives/path-directives/redirectToNoTrailingSlashIfPresent.md
  • routing-dsl/directives/path-directives/redirectToTrailingSlashIfMissing.md
  • routing-dsl/directives/path-directives/pathSuffixTest.md
  • routing-dsl/directives/path-directives/ignoreTrailingSlash.md
  • routing-dsl/directives/misc-directives/requestEntityPresent.md
  • routing-dsl/directives/misc-directives/requestEntityEmpty.md
  • routing-dsl/directives/misc-directives/selectPreferredLanguage.md
  • routing-dsl/directives/misc-directives/withoutSizeLimit.md
  • routing-dsl/directives/file-upload-directives/uploadedFile.md
  • routing-dsl/directives/route-directives/reject.md
  • routing-dsl/directives/route-directives/failWith.md
  • routing-dsl/directives/file-and-resource-directives/getFromBrowseableDirectories.md
  • routing-dsl/directives/file-and-resource-directives/getFromDirectory.md
  • routing-dsl/directives/file-and-resource-directives/getFromFile.md
  • routing-dsl/directives/coding-directives/withPrecompressedMediaTypeSupport.md
  • routing-dsl/directives/coding-directives/encodeResponse.md
  • routing-dsl/directives/coding-directives/decodeRequest.md
  • routing-dsl/directives/coding-directives/decodeRequestWith.md
  • routing-dsl/directives/coding-directives/encodeResponseWith.md
  • routing-dsl/directives/coding-directives/responseEncodingAccepted.md
  • routing-dsl/directives/timeout-directives/withRequestTimeoutResponse.md
  • routing-dsl/directives/timeout-directives/withoutRequestTimeout.md
  • routing-dsl/directives/execution-directives/handleRejections.md
  • routing-dsl/directives/execution-directives/handleExceptions.md
  • routing-dsl/directives/respond-with-directives/respondWithHeaders.md
  • routing-dsl/directives/respond-with-directives/respondWithDefaultHeader.md
  • routing-dsl/directives/respond-with-directives/respondWithHeader.md
  • routing-dsl/directives/basic-directives/extractMatchedPath.md
  • routing-dsl/directives/basic-directives/extractMaterializer.md
  • routing-dsl/directives/basic-directives/extractUri.md
  • routing-dsl/directives/basic-directives/extractActorSystem.md
  • routing-dsl/directives/basic-directives/extractSettings.md
  • routing-dsl/directives/basic-directives/mapUnmatchedPath.md
  • routing-dsl/directives/basic-directives/extractStrictEntity.md
  • routing-dsl/directives/basic-directives/extractRequestEntity.md
  • routing-dsl/directives/basic-directives/extractExecutionContext.md
  • routing-dsl/directives/basic-directives/extractRequestContext.md
  • routing-dsl/directives/basic-directives/cancelRejection.md
  • routing-dsl/directives/basic-directives/cancelRejections.md
  • routing-dsl/directives/basic-directives/withMaterializer.md
  • routing-dsl/directives/basic-directives/withSettings.md
  • routing-dsl/directives/basic-directives/pass.md
  • routing-dsl/directives/basic-directives/mapInnerRoute.md
  • routing-dsl/directives/basic-directives/toStrictEntity.md
  • routing-dsl/directives/basic-directives/withLog.md
  • routing-dsl/directives/cookie-directives/index.md (@raboof #1608)
  • routing-dsl/directives/scheme-directives/index.md (@raboof #1608)
  • routing-dsl/directives/cache-condition-directives/index.md (@raboof #1608)
  • routing-dsl/directives/caching-directives/cache.md (@raboof, first #1579)
  • routing-dsl/directives/caching-directives/index.md
  • routing-dsl/directives/form-field-directives/formFieldList.md
  • routing-dsl/directives/form-field-directives/formField.md
  • routing-dsl/directives/form-field-directives/formFieldMultiMap.md
  • routing-dsl/directives/form-field-directives/formFieldMap.md
  • routing-dsl/directives/form-field-directives/index.md
  • routing-dsl/directives/host-directives/extractHostName.md
  • routing-dsl/directives/host-directives/host.md
  • routing-dsl/directives/host-directives/index.md
  • routing-dsl/directives/header-directives/optionalHeaderValue.md
  • routing-dsl/directives/header-directives/optionalHeaderValuePF.md
  • routing-dsl/directives/header-directives/headerValue.md
  • routing-dsl/directives/header-directives/optionalHeaderValueByType.md
  • routing-dsl/directives/header-directives/checkSameOrigin.md
  • routing-dsl/directives/header-directives/headerValueByType.md
  • routing-dsl/directives/header-directives/headerValueByName.md
  • routing-dsl/directives/header-directives/index.md (@raboof #1608)
  • routing-dsl/directives/header-directives/optionalHeaderValueByName.md
  • routing-dsl/directives/websocket-directives/extractOfferedWsProtocols.md
  • routing-dsl/directives/websocket-directives/extractUpgradeToWebSocket.md
  • routing-dsl/directives/websocket-directives/handleWebSocketMessagesForOptionalProtocol.md
  • routing-dsl/directives/websocket-directives/index.md (@raboof #1608)
  • routing-dsl/directives/parameter-directives/parameters.md
  • routing-dsl/directives/parameter-directives/parameterMap.md
  • routing-dsl/directives/parameter-directives/parameterMultiMap.md
  • routing-dsl/directives/parameter-directives/parameter.md
  • routing-dsl/directives/parameter-directives/parameterSeq.md
  • routing-dsl/directives/parameter-directives/index.md
  • routing-dsl/directives/debugging-directives/logResult.md
  • routing-dsl/directives/debugging-directives/logRequest.md
  • routing-dsl/directives/debugging-directives/logRequestResult.md
  • routing-dsl/directives/debugging-directives/index.md (@raboof #1608)
  • routing-dsl/directives/path-directives/rawPathPrefixTest.md
  • routing-dsl/directives/path-directives/pathPrefixTest.md
  • routing-dsl/directives/path-directives/pathSuffix.md
  • routing-dsl/directives/path-directives/pathEndOrSingleSlash.md
  • routing-dsl/directives/path-directives/rawPathPrefix.md
  • routing-dsl/directives/path-directives/pathSingleSlash.md
  • routing-dsl/directives/path-directives/pathEnd.md
  • routing-dsl/directives/path-directives/index.md
  • routing-dsl/directives/path-directives/pathPrefix.md
  • routing-dsl/directives/path-directives/path.md
  • routing-dsl/directives/method-directives/options.md
  • routing-dsl/directives/method-directives/overrideMethodWithParameter.md
  • routing-dsl/directives/method-directives/post.md
  • routing-dsl/directives/method-directives/delete.md
  • routing-dsl/directives/method-directives/extractMethod.md
  • routing-dsl/directives/method-directives/head.md
  • routing-dsl/directives/method-directives/get.md
  • routing-dsl/directives/method-directives/index.md (@raboof #1608)
  • routing-dsl/directives/method-directives/method.md
  • routing-dsl/directives/method-directives/put.md
  • routing-dsl/directives/method-directives/patch.md
  • routing-dsl/directives/misc-directives/withSizeLimit.md
  • routing-dsl/directives/misc-directives/extractClientIP.md
  • routing-dsl/directives/misc-directives/rejectEmptyResponse.md
  • routing-dsl/directives/misc-directives/index.md (@raboof #1608)
  • routing-dsl/directives/misc-directives/validate.md
  • routing-dsl/directives/file-upload-directives/storeUploadedFiles.md
  • routing-dsl/directives/file-upload-directives/fileUploadAll.md
  • routing-dsl/directives/file-upload-directives/fileUpload.md
  • routing-dsl/directives/file-upload-directives/storeUploadedFile.md
  • routing-dsl/directives/file-upload-directives/index.md (@raboof #1608)
  • routing-dsl/directives/range-directives/withRangeSupport.md
  • routing-dsl/directives/range-directives/index.md (@raboof #1608)
  • routing-dsl/directives/future-directives/completeOrRecoverWith.md
  • routing-dsl/directives/future-directives/onCompleteWithBreaker.md
  • routing-dsl/directives/future-directives/onSuccess.md
  • routing-dsl/directives/future-directives/onComplete.md
  • routing-dsl/directives/future-directives/index.md
  • routing-dsl/directives/custom-directives.md
  • routing-dsl/directives/security-directives/authorizeAsync.md
  • routing-dsl/directives/security-directives/authenticateOAuth2PF.md
  • routing-dsl/directives/security-directives/authorize.md
  • routing-dsl/directives/security-directives/authenticateBasicPFAsync.md
  • routing-dsl/directives/security-directives/authenticateOrRejectWithChallenge.md
  • routing-dsl/directives/security-directives/authenticateBasic.md
  • routing-dsl/directives/security-directives/authenticateBasicAsync.md
  • routing-dsl/directives/security-directives/authenticateOAuth2Async.md
  • routing-dsl/directives/security-directives/authenticateOAuth2PFAsync.md
  • routing-dsl/directives/security-directives/index.md
  • routing-dsl/directives/security-directives/authenticateBasicPF.md
  • routing-dsl/directives/security-directives/authenticateOAuth2.md
  • routing-dsl/directives/security-directives/extractCredentials.md
  • routing-dsl/directives/alphabetically.md
  • routing-dsl/directives/route-directives/redirect.md
  • routing-dsl/directives/route-directives/complete.md
  • routing-dsl/directives/route-directives/index.md (@raboof #1608)
  • routing-dsl/directives/file-and-resource-directives/getFromResourceDirectory.md
  • routing-dsl/directives/file-and-resource-directives/listDirectoryContents.md
  • routing-dsl/directives/file-and-resource-directives/getFromBrowseableDirectory.md
  • routing-dsl/directives/file-and-resource-directives/getFromResource.md
  • routing-dsl/directives/file-and-resource-directives/index.md (@raboof #1608)
  • routing-dsl/directives/by-trait.md
  • routing-dsl/directives/path-directives.md
  • routing-dsl/directives/coding-directives/requestEncodedWith.md
  • routing-dsl/directives/coding-directives/index.md (@raboof #1608)
  • routing-dsl/directives/timeout-directives/index.md (@raboof #1608)
  • routing-dsl/directives/timeout-directives/withRequestTimeout.md
  • routing-dsl/directives/marshalling-directives/completeWith.md
  • routing-dsl/directives/marshalling-directives/entity.md
  • routing-dsl/directives/marshalling-directives/handleWith.md
  • routing-dsl/directives/marshalling-directives/index.md (@raboof #1608)
  • routing-dsl/directives/execution-directives/index.md (@raboof #1608)
  • routing-dsl/directives/index.md
  • routing-dsl/directives/respond-with-directives/respondWithDefaultHeaders.md
  • routing-dsl/directives/respond-with-directives/index.md (@raboof #1608)
  • routing-dsl/directives/basic-directives/mapRequestContext.md
  • routing-dsl/directives/basic-directives/provide.md
  • routing-dsl/directives/basic-directives/recoverRejections.md
  • routing-dsl/directives/basic-directives/mapRejections.md
  • routing-dsl/directives/basic-directives/mapRequest.md
  • routing-dsl/directives/basic-directives/recoverRejectionsWith.md
  • routing-dsl/directives/basic-directives/mapSettings.md
  • routing-dsl/directives/basic-directives/mapResponseEntity.md
  • routing-dsl/directives/basic-directives/mapRouteResultPF.md
  • routing-dsl/directives/basic-directives/extractUnmatchedPath.md
  • routing-dsl/directives/basic-directives/extract.md
  • routing-dsl/directives/basic-directives/mapRouteResult.md
  • routing-dsl/directives/basic-directives/extractRequest.md
  • routing-dsl/directives/basic-directives/extractDataBytes.md
  • routing-dsl/directives/basic-directives/extractLog.md
  • routing-dsl/directives/basic-directives/mapResponseHeaders.md
  • routing-dsl/directives/basic-directives/mapRouteResultFuture.md
  • routing-dsl/directives/basic-directives/mapResponse.md
  • routing-dsl/directives/basic-directives/mapRouteResultWith.md
  • routing-dsl/directives/basic-directives/withExecutionContext.md
  • routing-dsl/directives/basic-directives/index.md
  • routing-dsl/directives/basic-directives/mapRouteResultWithPF.md
  • routing-dsl/directives/basic-directives/extractParserSettings.md
Contributor

richardimaoka commented Jul 19, 2017

Let me know which one you want to work on, and I'll mark your name for the file!

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

  • client-side/client-https-support.md - @jonas
  • client-side/client-transport.md - @jonas
  • client-side/connection-level.md - @jonas
  • client-side/host-level.md (@jlprat)
  • client-side/index.md (@jlprat)
  • client-side/pool-overflow.md (@jlprat)
  • client-side/request-level.md (@jlprat)
  • client-side/websocket-support.md (@jlprat)
  • common/de-coding.md (@jlprat)
  • common/http-model.md (@jlprat)
  • common/index.md - @jonas
  • common/json-support.md (@jonas)
  • common/marshalling.md - (@jonas, #1367)
  • common/timeouts.md - @jonas
  • common/unmarshalling.md - @jonas
  • common/uri-model.md (@jlprat)
  • configuration.md (@jlprat)
  • handling-blocking-operations-in-akka-http-routes.md (@jlprat)
  • implications-of-streaming-http-entity.md (@jlprat)
  • index.md (@jlprat)
  • introduction.md (@jlprat)
  • migration-guide/index.md (@jrudolph)
  • migration-guide/migration-from-old-http-javadsl.md (@jrudolph)
  • migration-guide/migration-guide-2.4.x-10.0.x.md (@jrudolph)
  • routing-dsl/exception-handling.md (@jlprat)
  • routing-dsl/HttpApp.md (@jlprat)
  • routing-dsl/index.md (@raboof #1600)
  • routing-dsl/marshalling.md - should be merged into common/marshalling - (@jonas, #1367)
  • routing-dsl/overview.md (@raboof, #1599)
  • routing-dsl/rejections.md (@jonas)
  • routing-dsl/routes.md (@atiqsayyed)
  • routing-dsl/source-streaming-support.md (@atiqsayyed)
  • routing-dsl/testkit.md (@atiqsayyed)
  • sse-support.md (@jonas)
  • server-side/low-level-server-side-api.md (@jlprat)
  • server-side/websocket-support.md (@jonas)
  • server-side-https-support.md (@jonas)
and
  • docs/src/main/paradox/java.md

Directives:

  • routing-dsl/directives/cookie-directives/setCookie.md
  • routing-dsl/directives/cookie-directives/deleteCookie.md
  • routing-dsl/directives/cookie-directives/cookie.md
  • routing-dsl/directives/cookie-directives/optionalCookie.md
  • routing-dsl/directives/scheme-directives/extractScheme.md
  • routing-dsl/directives/scheme-directives/scheme.md
  • routing-dsl/directives/cache-condition-directives/conditional.md
  • routing-dsl/directives/caching-directives/alwaysCache.md
  • routing-dsl/directives/caching-directives/cachingProhibited.md
  • routing-dsl/directives/header-directives/headerValuePF.md
  • routing-dsl/directives/websocket-directives/handleWebSocketMessages.md
  • routing-dsl/directives/websocket-directives/handleWebSocketMessagesForProtocol.md
  • routing-dsl/directives/path-directives/redirectToNoTrailingSlashIfPresent.md
  • routing-dsl/directives/path-directives/redirectToTrailingSlashIfMissing.md
  • routing-dsl/directives/path-directives/pathSuffixTest.md
  • routing-dsl/directives/path-directives/ignoreTrailingSlash.md
  • routing-dsl/directives/misc-directives/requestEntityPresent.md
  • routing-dsl/directives/misc-directives/requestEntityEmpty.md
  • routing-dsl/directives/misc-directives/selectPreferredLanguage.md
  • routing-dsl/directives/misc-directives/withoutSizeLimit.md
  • routing-dsl/directives/file-upload-directives/uploadedFile.md
  • routing-dsl/directives/route-directives/reject.md
  • routing-dsl/directives/route-directives/failWith.md
  • routing-dsl/directives/file-and-resource-directives/getFromBrowseableDirectories.md
  • routing-dsl/directives/file-and-resource-directives/getFromDirectory.md
  • routing-dsl/directives/file-and-resource-directives/getFromFile.md
  • routing-dsl/directives/coding-directives/withPrecompressedMediaTypeSupport.md
  • routing-dsl/directives/coding-directives/encodeResponse.md
  • routing-dsl/directives/coding-directives/decodeRequest.md
  • routing-dsl/directives/coding-directives/decodeRequestWith.md
  • routing-dsl/directives/coding-directives/encodeResponseWith.md
  • routing-dsl/directives/coding-directives/responseEncodingAccepted.md
  • routing-dsl/directives/timeout-directives/withRequestTimeoutResponse.md
  • routing-dsl/directives/timeout-directives/withoutRequestTimeout.md
  • routing-dsl/directives/execution-directives/handleRejections.md
  • routing-dsl/directives/execution-directives/handleExceptions.md
  • routing-dsl/directives/respond-with-directives/respondWithHeaders.md
  • routing-dsl/directives/respond-with-directives/respondWithDefaultHeader.md
  • routing-dsl/directives/respond-with-directives/respondWithHeader.md
  • routing-dsl/directives/basic-directives/extractMatchedPath.md
  • routing-dsl/directives/basic-directives/extractMaterializer.md
  • routing-dsl/directives/basic-directives/extractUri.md
  • routing-dsl/directives/basic-directives/extractActorSystem.md
  • routing-dsl/directives/basic-directives/extractSettings.md
  • routing-dsl/directives/basic-directives/mapUnmatchedPath.md
  • routing-dsl/directives/basic-directives/extractStrictEntity.md
  • routing-dsl/directives/basic-directives/extractRequestEntity.md
  • routing-dsl/directives/basic-directives/extractExecutionContext.md
  • routing-dsl/directives/basic-directives/extractRequestContext.md
  • routing-dsl/directives/basic-directives/cancelRejection.md
  • routing-dsl/directives/basic-directives/cancelRejections.md
  • routing-dsl/directives/basic-directives/withMaterializer.md
  • routing-dsl/directives/basic-directives/withSettings.md
  • routing-dsl/directives/basic-directives/pass.md
  • routing-dsl/directives/basic-directives/mapInnerRoute.md
  • routing-dsl/directives/basic-directives/toStrictEntity.md
  • routing-dsl/directives/basic-directives/withLog.md
  • routing-dsl/directives/cookie-directives/index.md (@raboof #1608)
  • routing-dsl/directives/scheme-directives/index.md (@raboof #1608)
  • routing-dsl/directives/cache-condition-directives/index.md (@raboof #1608)
  • routing-dsl/directives/caching-directives/cache.md (@raboof, first #1579)
  • routing-dsl/directives/caching-directives/index.md
  • routing-dsl/directives/form-field-directives/formFieldList.md
  • routing-dsl/directives/form-field-directives/formField.md
  • routing-dsl/directives/form-field-directives/formFieldMultiMap.md
  • routing-dsl/directives/form-field-directives/formFieldMap.md
  • routing-dsl/directives/form-field-directives/index.md
  • routing-dsl/directives/host-directives/extractHostName.md
  • routing-dsl/directives/host-directives/host.md
  • routing-dsl/directives/host-directives/index.md
  • routing-dsl/directives/header-directives/optionalHeaderValue.md
  • routing-dsl/directives/header-directives/optionalHeaderValuePF.md
  • routing-dsl/directives/header-directives/headerValue.md
  • routing-dsl/directives/header-directives/optionalHeaderValueByType.md
  • routing-dsl/directives/header-directives/checkSameOrigin.md
  • routing-dsl/directives/header-directives/headerValueByType.md
  • routing-dsl/directives/header-directives/headerValueByName.md
  • routing-dsl/directives/header-directives/index.md (@raboof #1608)
  • routing-dsl/directives/header-directives/optionalHeaderValueByName.md
  • routing-dsl/directives/websocket-directives/extractOfferedWsProtocols.md
  • routing-dsl/directives/websocket-directives/extractUpgradeToWebSocket.md
  • routing-dsl/directives/websocket-directives/handleWebSocketMessagesForOptionalProtocol.md
  • routing-dsl/directives/websocket-directives/index.md (@raboof #1608)
  • routing-dsl/directives/parameter-directives/parameters.md
  • routing-dsl/directives/parameter-directives/parameterMap.md
  • routing-dsl/directives/parameter-directives/parameterMultiMap.md
  • routing-dsl/directives/parameter-directives/parameter.md
  • routing-dsl/directives/parameter-directives/parameterSeq.md
  • routing-dsl/directives/parameter-directives/index.md
  • routing-dsl/directives/debugging-directives/logResult.md
  • routing-dsl/directives/debugging-directives/logRequest.md
  • routing-dsl/directives/debugging-directives/logRequestResult.md
  • routing-dsl/directives/debugging-directives/index.md (@raboof #1608)
  • routing-dsl/directives/path-directives/rawPathPrefixTest.md
  • routing-dsl/directives/path-directives/pathPrefixTest.md
  • routing-dsl/directives/path-directives/pathSuffix.md
  • routing-dsl/directives/path-directives/pathEndOrSingleSlash.md
  • routing-dsl/directives/path-directives/rawPathPrefix.md
  • routing-dsl/directives/path-directives/pathSingleSlash.md
  • routing-dsl/directives/path-directives/pathEnd.md
  • routing-dsl/directives/path-directives/index.md
  • routing-dsl/directives/path-directives/pathPrefix.md
  • routing-dsl/directives/path-directives/path.md
  • routing-dsl/directives/method-directives/options.md
  • routing-dsl/directives/method-directives/overrideMethodWithParameter.md
  • routing-dsl/directives/method-directives/post.md
  • routing-dsl/directives/method-directives/delete.md
  • routing-dsl/directives/method-directives/extractMethod.md
  • routing-dsl/directives/method-directives/head.md
  • routing-dsl/directives/method-directives/get.md
  • routing-dsl/directives/method-directives/index.md (@raboof #1608)
  • routing-dsl/directives/method-directives/method.md
  • routing-dsl/directives/method-directives/put.md
  • routing-dsl/directives/method-directives/patch.md
  • routing-dsl/directives/misc-directives/withSizeLimit.md
  • routing-dsl/directives/misc-directives/extractClientIP.md
  • routing-dsl/directives/misc-directives/rejectEmptyResponse.md
  • routing-dsl/directives/misc-directives/index.md (@raboof #1608)
  • routing-dsl/directives/misc-directives/validate.md
  • routing-dsl/directives/file-upload-directives/storeUploadedFiles.md
  • routing-dsl/directives/file-upload-directives/fileUploadAll.md
  • routing-dsl/directives/file-upload-directives/fileUpload.md
  • routing-dsl/directives/file-upload-directives/storeUploadedFile.md
  • routing-dsl/directives/file-upload-directives/index.md (@raboof #1608)
  • routing-dsl/directives/range-directives/withRangeSupport.md
  • routing-dsl/directives/range-directives/index.md (@raboof #1608)
  • routing-dsl/directives/future-directives/completeOrRecoverWith.md
  • routing-dsl/directives/future-directives/onCompleteWithBreaker.md
  • routing-dsl/directives/future-directives/onSuccess.md
  • routing-dsl/directives/future-directives/onComplete.md
  • routing-dsl/directives/future-directives/index.md
  • routing-dsl/directives/custom-directives.md
  • routing-dsl/directives/security-directives/authorizeAsync.md
  • routing-dsl/directives/security-directives/authenticateOAuth2PF.md
  • routing-dsl/directives/security-directives/authorize.md
  • routing-dsl/directives/security-directives/authenticateBasicPFAsync.md
  • routing-dsl/directives/security-directives/authenticateOrRejectWithChallenge.md
  • routing-dsl/directives/security-directives/authenticateBasic.md
  • routing-dsl/directives/security-directives/authenticateBasicAsync.md
  • routing-dsl/directives/security-directives/authenticateOAuth2Async.md
  • routing-dsl/directives/security-directives/authenticateOAuth2PFAsync.md
  • routing-dsl/directives/security-directives/index.md
  • routing-dsl/directives/security-directives/authenticateBasicPF.md
  • routing-dsl/directives/security-directives/authenticateOAuth2.md
  • routing-dsl/directives/security-directives/extractCredentials.md
  • routing-dsl/directives/alphabetically.md
  • routing-dsl/directives/route-directives/redirect.md
  • routing-dsl/directives/route-directives/complete.md
  • routing-dsl/directives/route-directives/index.md (@raboof #1608)
  • routing-dsl/directives/file-and-resource-directives/getFromResourceDirectory.md
  • routing-dsl/directives/file-and-resource-directives/listDirectoryContents.md
  • routing-dsl/directives/file-and-resource-directives/getFromBrowseableDirectory.md
  • routing-dsl/directives/file-and-resource-directives/getFromResource.md
  • routing-dsl/directives/file-and-resource-directives/index.md (@raboof #1608)
  • routing-dsl/directives/by-trait.md
  • routing-dsl/directives/path-directives.md
  • routing-dsl/directives/coding-directives/requestEncodedWith.md
  • routing-dsl/directives/coding-directives/index.md (@raboof #1608)
  • routing-dsl/directives/timeout-directives/index.md (@raboof #1608)
  • routing-dsl/directives/timeout-directives/withRequestTimeout.md
  • routing-dsl/directives/marshalling-directives/completeWith.md
  • routing-dsl/directives/marshalling-directives/entity.md
  • routing-dsl/directives/marshalling-directives/handleWith.md
  • routing-dsl/directives/marshalling-directives/index.md (@raboof #1608)
  • routing-dsl/directives/execution-directives/index.md (@raboof #1608)
  • routing-dsl/directives/index.md
  • routing-dsl/directives/respond-with-directives/respondWithDefaultHeaders.md
  • routing-dsl/directives/respond-with-directives/index.md (@raboof #1608)
  • routing-dsl/directives/basic-directives/mapRequestContext.md
  • routing-dsl/directives/basic-directives/provide.md
  • routing-dsl/directives/basic-directives/recoverRejections.md
  • routing-dsl/directives/basic-directives/mapRejections.md
  • routing-dsl/directives/basic-directives/mapRequest.md
  • routing-dsl/directives/basic-directives/recoverRejectionsWith.md
  • routing-dsl/directives/basic-directives/mapSettings.md
  • routing-dsl/directives/basic-directives/mapResponseEntity.md
  • routing-dsl/directives/basic-directives/mapRouteResultPF.md
  • routing-dsl/directives/basic-directives/extractUnmatchedPath.md
  • routing-dsl/directives/basic-directives/extract.md
  • routing-dsl/directives/basic-directives/mapRouteResult.md
  • routing-dsl/directives/basic-directives/extractRequest.md
  • routing-dsl/directives/basic-directives/extractDataBytes.md
  • routing-dsl/directives/basic-directives/extractLog.md
  • routing-dsl/directives/basic-directives/mapResponseHeaders.md
  • routing-dsl/directives/basic-directives/mapRouteResultFuture.md
  • routing-dsl/directives/basic-directives/mapResponse.md
  • routing-dsl/directives/basic-directives/mapRouteResultWith.md
  • routing-dsl/directives/basic-directives/withExecutionContext.md
  • routing-dsl/directives/basic-directives/index.md
  • routing-dsl/directives/basic-directives/mapRouteResultWithPF.md
  • routing-dsl/directives/basic-directives/extractParserSettings.md
@jrudolph

This comment has been minimized.

Show comment
Hide comment
@jrudolph

jrudolph Jul 19, 2017

Member

Thanks a lot @richard-imaoka for getting this initiative started. I think we might want to exclude the directives details pages for now. One reason is that they don't all map 1-to-1 and the other is that the other documentation is currently more important to be merged.

Member

jrudolph commented Jul 19, 2017

Thanks a lot @richard-imaoka for getting this initiative started. I think we might want to exclude the directives details pages for now. One reason is that they don't all map 1-to-1 and the other is that the other documentation is currently more important to be merged.

@richardimaoka

This comment has been minimized.

Show comment
Hide comment
@richardimaoka

richardimaoka Jul 19, 2017

Contributor

OK sure, removed the directives details pages.

Contributor

richardimaoka commented Jul 19, 2017

OK sure, removed the directives details pages.

@jrudolph

This comment has been minimized.

Show comment
Hide comment
@jrudolph

jrudolph Jul 20, 2017

Member

👍, thanks. Let's start with the other ones.

Member

jrudolph commented Jul 20, 2017

👍, thanks. Let's start with the other ones.

@jlprat

This comment has been minimized.

Show comment
Hide comment
@jlprat

jlprat Jul 20, 2017

Member

What if a whole section should be on the Scala version but not on the Java one (or vice-versa)? What's the way to do it?

Member

jlprat commented Jul 20, 2017

What if a whole section should be on the Scala version but not on the Java one (or vice-versa)? What's the way to do it?

@raboof

This comment has been minimized.

Show comment
Hide comment
@raboof

raboof Jul 20, 2017

Member

@jlprat Unfortunately we don't have a way to make ToC elements conditional yet, see lightbend/paradox#128

Member

raboof commented Jul 20, 2017

@jlprat Unfortunately we don't have a way to make ToC elements conditional yet, see lightbend/paradox#128

@jlprat

This comment has been minimized.

Show comment
Hide comment
@jlprat

jlprat Jul 20, 2017

Member

OK, from the top of my head, there are a couple of pages where some sections are missing on Java (custom headers for example)

Member

jlprat commented Jul 20, 2017

OK, from the top of my head, there are a couple of pages where some sections are missing on Java (custom headers for example)

@jrudolph

This comment has been minimized.

Show comment
Hide comment
@jrudolph

jrudolph Jul 20, 2017

Member

Yes, there will probably some difficulties but that shouldn't stop us from starting the work on the easier cases.

Member

jrudolph commented Jul 20, 2017

Yes, there will probably some difficulties but that shouldn't stop us from starting the work on the easier cases.

@jlprat

This comment has been minimized.

Show comment
Hide comment
@jlprat

jlprat Jul 20, 2017

Member
Member

jlprat commented Jul 20, 2017

@jlprat

This comment has been minimized.

Show comment
Hide comment
@jlprat

jlprat Jul 20, 2017

Member

I take HttpApp

Member

jlprat commented Jul 20, 2017

I take HttpApp

jlprat added a commit to jlprat/akka-http that referenced this issue Jul 20, 2017

=doc Consolidate HttpApp docs #1290
Issue: 1290
Merge Java and Scala doc pages

raboof added a commit that referenced this issue Jul 21, 2017

=doc Consolidate HttpApp docs #1290 (#1293)
Issue: 1290
Merge Java and Scala doc pages

jonas added a commit to jonas/akka-http that referenced this issue Jul 21, 2017

jonas added a commit to jonas/akka-http that referenced this issue Jul 21, 2017

jonas added a commit to jonas/akka-http that referenced this issue Jul 21, 2017

jonas added a commit to jonas/akka-http that referenced this issue Jul 21, 2017

@jonas

This comment has been minimized.

Show comment
Hide comment
@jonas

jonas Jul 21, 2017

Member

Did

  • client-side/client-https-support.md
  • client-side/client-transport.md
  • client-side/connection-level.md
  • common/timeouts.md
Member

jonas commented Jul 21, 2017

Did

  • client-side/client-https-support.md
  • client-side/client-transport.md
  • client-side/connection-level.md
  • common/timeouts.md

jonas added a commit that referenced this issue Jul 25, 2017

=doc #1290 Merge common/timeouts.md and a few client-side pages (#1298)
* =doc #1290 Merge common/timeouts.md

* =doc #1290 Merge client-side/client-https-support.md

* =doc #1290 Merge client-side/client-transport.md

* =doc #1290 Merge client-side/connection-level.md

* Remove header that is defined twice

jonas added a commit to jonas/akka-http that referenced this issue Jul 26, 2017

=doc #1290 Remove custom anchors at the start of the page
Paradox does not verify them which makes them hard to maintain and
removing them will make it easier to merge the Java and Scala
documentation by avoiding to need to fix a lot of additional anchors.

Generated with:

    anchors=$(find docs/src/main/paradox/ -name "*.md" | xargs -n 1 head -1 | sed -n 's#<a id="\(.*\)"></a>#\1#p')
    files=$(find docs/src/main/paradox/ -name "*.md")
    # Remove fragments from links
    for id in $anchors; do sed -i "s/#$id[)]/)/" $files; done
    # Remove top-level page anchors
    for id in $anchors; do sed -i "/^<a.id=.$id.><.a>$/d" $files; done

raboof added a commit that referenced this issue Jul 26, 2017

=doc #1290 Remove custom anchors at the start of the page (#1308)
* Remove executable bit from .gitignore
* =doc #1290 Remove custom anchors at the start of the page

Paradox does not verify them which makes them hard to maintain and
removing them will make it easier to merge the Java and Scala
documentation by avoiding to need to fix a lot of additional anchors.

Generated with:

    anchors=$(find docs/src/main/paradox/ -name "*.md" | xargs -n 1 head -1 | sed -n 's#<a id="\(.*\)"></a>#\1#p')
    files=$(find docs/src/main/paradox/ -name "*.md")
    # Remove fragments from links
    for id in $anchors; do sed -i "s/#$id[)]/)/" $files; done
    # Remove top-level page anchors
    for id in $anchors; do sed -i "/^<a.id=.$id.><.a>$/d" $files; done
@jonas

This comment has been minimized.

Show comment
Hide comment
@jonas

jonas Jul 26, 2017

Member

I wrote a small script to help track status and to do the initial work of merging a page:

> scripts/doc-merge.sh status
client-side/client-https-support.md                          : Merged
client-side/client-transport.md                              : Merged
client-side/connection-level.md                              : Merged
client-side/host-level.md                                    : Merged
client-side/index.md                                         : Merged
client-side/pool-overflow.md                                 : Merged
client-side/request-level.md                                 : Merged
client-side/websocket-support.md                             : Merged
common/encoding.md                                           : Merged
common/http-model.md                                         : Merged
common/index.md                                              : Merged
common/json-support.md                                       : Merged
common/marshalling.md                                        : 14 insertions(+), 18 deletions(-)
common/timeouts.md                                           : Merged
common/unmarshalling.md                                      : 6 insertions(+), 12 deletions(-)
common/uri-model.md                                          : Merged
common/xml-support.md                                        : Merged
compatibility-guidelines.md                                  : Merged
configuration.md                                             : Merged
handling-blocking-operations-in-akka-http-routes.md          : Merged
implications-of-streaming-http-entity.md                     : Merged
index.md                                                     : Merged
introduction.md                                              : Merged
migration-guide/index.md                                     : Merged
migration-guide/migration-from-old-http-javadsl.md           : Merged
migration-guide/migration-from-spray.md                      : Merged
migration-guide/migration-guide-10.0.x.md                    : Merged
migration-guide/migration-guide-2.4.x-10.0.x.md              : Merged
release-notes.md                                             : Merged
routing-dsl/HttpApp.md                                       : Merged
routing-dsl/case-class-extraction.md                         : No java version
routing-dsl/exception-handling.md                            : Merged
routing-dsl/index.md                                         : 29 insertions(+), 10 deletions(-)
routing-dsl/marshalling.md                                   : No scala version
routing-dsl/overview.md                                      : 28 insertions(+), 17 deletions(-)
routing-dsl/path-matchers.md                                 : No java version
routing-dsl/rejections.md                                    : Merged
routing-dsl/routes.md                                        : 62 insertions(+), 53 deletions(-)
routing-dsl/source-streaming-support.md                      : 80 insertions(+), 35 deletions(-)
routing-dsl/testkit.md                                       : 104 insertions(+), 72 deletions(-)
security.md                                                  : Merged
security/2016-09-30-windows-directory-traversal.md           : Merged
security/2017-01-23-denial-of-service-via-leak-on-unconsumed-closed-connections.md : Merged
security/2017-05-03-illegal-media-range-in-accept-header-causes-stackoverflowerror.md : Merged
server-side/http2.md                                         : Merged
server-side/low-level-api.md                                 : Merged
server-side/server-https-support.md                          : Merged
server-side/websocket-support.md                             : Merged
sse-support.md                                               : Merged

doc-merge.sh.txt

Member

jonas commented Jul 26, 2017

I wrote a small script to help track status and to do the initial work of merging a page:

> scripts/doc-merge.sh status
client-side/client-https-support.md                          : Merged
client-side/client-transport.md                              : Merged
client-side/connection-level.md                              : Merged
client-side/host-level.md                                    : Merged
client-side/index.md                                         : Merged
client-side/pool-overflow.md                                 : Merged
client-side/request-level.md                                 : Merged
client-side/websocket-support.md                             : Merged
common/encoding.md                                           : Merged
common/http-model.md                                         : Merged
common/index.md                                              : Merged
common/json-support.md                                       : Merged
common/marshalling.md                                        : 14 insertions(+), 18 deletions(-)
common/timeouts.md                                           : Merged
common/unmarshalling.md                                      : 6 insertions(+), 12 deletions(-)
common/uri-model.md                                          : Merged
common/xml-support.md                                        : Merged
compatibility-guidelines.md                                  : Merged
configuration.md                                             : Merged
handling-blocking-operations-in-akka-http-routes.md          : Merged
implications-of-streaming-http-entity.md                     : Merged
index.md                                                     : Merged
introduction.md                                              : Merged
migration-guide/index.md                                     : Merged
migration-guide/migration-from-old-http-javadsl.md           : Merged
migration-guide/migration-from-spray.md                      : Merged
migration-guide/migration-guide-10.0.x.md                    : Merged
migration-guide/migration-guide-2.4.x-10.0.x.md              : Merged
release-notes.md                                             : Merged
routing-dsl/HttpApp.md                                       : Merged
routing-dsl/case-class-extraction.md                         : No java version
routing-dsl/exception-handling.md                            : Merged
routing-dsl/index.md                                         : 29 insertions(+), 10 deletions(-)
routing-dsl/marshalling.md                                   : No scala version
routing-dsl/overview.md                                      : 28 insertions(+), 17 deletions(-)
routing-dsl/path-matchers.md                                 : No java version
routing-dsl/rejections.md                                    : Merged
routing-dsl/routes.md                                        : 62 insertions(+), 53 deletions(-)
routing-dsl/source-streaming-support.md                      : 80 insertions(+), 35 deletions(-)
routing-dsl/testkit.md                                       : 104 insertions(+), 72 deletions(-)
security.md                                                  : Merged
security/2016-09-30-windows-directory-traversal.md           : Merged
security/2017-01-23-denial-of-service-via-leak-on-unconsumed-closed-connections.md : Merged
security/2017-05-03-illegal-media-range-in-accept-header-causes-stackoverflowerror.md : Merged
server-side/http2.md                                         : Merged
server-side/low-level-api.md                                 : Merged
server-side/server-https-support.md                          : Merged
server-side/websocket-support.md                             : Merged
sse-support.md                                               : Merged

doc-merge.sh.txt

@jlprat

This comment has been minimized.

Show comment
Hide comment
@jlprat

jlprat Jul 26, 2017

Member

The 2 last ones (server-side/...) have the Scala equivalent 1 level up.

Member

jlprat commented Jul 26, 2017

The 2 last ones (server-side/...) have the Scala equivalent 1 level up.

@jonas

This comment has been minimized.

Show comment
Hide comment
@jonas

jonas Jul 26, 2017

Member

@jlprat Is the plan to move the Scala pages into the server-side directory?

Member

jonas commented Jul 26, 2017

@jlprat Is the plan to move the Scala pages into the server-side directory?

@ktoso

This comment has been minimized.

Show comment
Hide comment
@ktoso

ktoso Oct 27, 2017

Member

Thanks @atiqsayyed for handling source-streaming-support.md! Just a few left :)

Member

ktoso commented Oct 27, 2017

Thanks @atiqsayyed for handling source-streaming-support.md! Just a few left :)

@raboof

This comment has been minimized.

Show comment
Hide comment
@raboof

raboof Dec 6, 2017

Member

@jlprat I think I found a nice solution for java/scala-specific ToC entries, #1600

Member

raboof commented Dec 6, 2017

@jlprat I think I found a nice solution for java/scala-specific ToC entries, #1600

@jlprat

This comment has been minimized.

Show comment
Hide comment
@jlprat

jlprat Dec 6, 2017

Member
Member

jlprat commented Dec 6, 2017

@raboof

This comment has been minimized.

Show comment
Hide comment
@raboof

raboof Dec 7, 2017

Member

Just about there for the 'regular' documentation, seems like it's time to start tackling the directives now. I've already scripted some common differences in #1608, but there's plenty left - I've added them to the list above.

Member

raboof commented Dec 7, 2017

Just about there for the 'regular' documentation, seems like it's time to start tackling the directives now. I've already scripted some common differences in #1608, but there's plenty left - I've added them to the list above.

raboof added a commit that referenced this issue Dec 8, 2017

@jonas

This comment has been minimized.

Show comment
Hide comment
@jonas

jonas Dec 9, 2017

Member

@raboof I suggest to close this ticket and track consolidation of the routing DSL docs in a new ticket since the history is getting quite long.

Member

jonas commented Dec 9, 2017

@raboof I suggest to close this ticket and track consolidation of the routing DSL docs in a new ticket since the history is getting quite long.

@raboof

This comment has been minimized.

Show comment
Hide comment
@raboof

raboof Dec 9, 2017

Member

@jonas works for me! @richardimaoka you want to help keep inventory of progress again?

Member

raboof commented Dec 9, 2017

@jonas works for me! @richardimaoka you want to help keep inventory of progress again?

@raboof

This comment has been minimized.

Show comment
Hide comment
@raboof

raboof Dec 14, 2017

Member

@richardimaoka did you see the ping above? :)

Member

raboof commented Dec 14, 2017

@richardimaoka did you see the ping above? :)

@richardimaoka

This comment has been minimized.

Show comment
Hide comment
@richardimaoka

richardimaoka Dec 14, 2017

Contributor

Sorry I misses the earlier message. I didn’t fully go thorough the conversation in detail but it’s about closing this issue and open a new one? Fine for me then.

Contributor

richardimaoka commented Dec 14, 2017

Sorry I misses the earlier message. I didn’t fully go thorough the conversation in detail but it’s about closing this issue and open a new one? Fine for me then.

@raboof

This comment has been minimized.

Show comment
Hide comment
@raboof

raboof Dec 14, 2017

Member

@richardimaoka Indeed! Do you want to create the ticket again?

Member

raboof commented Dec 14, 2017

@richardimaoka Indeed! Do you want to create the ticket again?

@richardimaoka

This comment has been minimized.

Show comment
Hide comment
@richardimaoka

richardimaoka Dec 14, 2017

Contributor

What's the most recent status? Is it tracked in #1290 (comment), or should I run @jonas's script to check the status?

Contributor

richardimaoka commented Dec 14, 2017

What's the most recent status? Is it tracked in #1290 (comment), or should I run @jonas's script to check the status?

@raboof

This comment has been minimized.

Show comment
Hide comment
@raboof

raboof Dec 14, 2017

Member

I think that comment should be accurate - I haven't run the script myself

Member

raboof commented Dec 14, 2017

I think that comment should be accurate - I haven't run the script myself

@richardimaoka

This comment has been minimized.

Show comment
Hide comment
@richardimaoka

richardimaoka Dec 14, 2017

Contributor

OK, here you go ! #1624

Contributor

richardimaoka commented Dec 14, 2017

OK, here you go ! #1624

@jonas jonas added this to the 10.0.12 milestone Dec 14, 2017

@jrudolph jrudolph modified the milestones: 10.0.12, 10.1.0-RC1 Dec 23, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment