Skip to content

Commit

Permalink
docs: revise URL structure (libraries) (#4425)
Browse files Browse the repository at this point in the history
* docs: revise URL structure (libraries)
* Update current links
  • Loading branch information
ennru authored Sep 20, 2024
1 parent 4436421 commit 9b1221f
Show file tree
Hide file tree
Showing 14 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions .algolia-search-index-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"index_name": "akka_http_docs",
"start_urls": [
{
"url": "https://doc.akka.io/docs/akka-http/current/",
"url": "https://doc.akka.io/libraries/akka-http/current/",
"extra_attributes": {
"language": [
"scala",
Expand Down Expand Up @@ -41,4 +41,4 @@
"299459375"
],
"nb_hits": 1650
}
}
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ This allows simple and fast iterations on changes that would need to be introduc

## Binary compatibility
Binary compatibility rules and guarantees are described in depth in the [Binary Compatibility Rules
](https://doc.akka.io/docs/akka/current/common/binary-compatibility-rules.html) section of the documentation.
](https://doc.akka.io/libraries/akka-core/current/common/binary-compatibility-rules.html) section of the documentation.

Akka-http uses MiMa (which is short for [Lightbend Migration Manager](https://github.com/lightbend/migration-manager)) to
validate binary compatibility of incoming Pull Requests. If your PR fails due to binary compatibility issues, you may see
Expand All @@ -150,7 +150,7 @@ Situations when it may be fine to ignore a MiMa issued warning include:
- if it is touching any class marked as `private[akka]`, `/** INTERNAL API*/` or similar markers
- if it is concerning internal classes (often recognizable by package names like `dungeon`, `impl`, `internal` etc.)
- if it is adding API to classes / traits which are only meant for extension by Akka itself, i.e. should not be extended by end-users
- if it is touching any class marked with the `@InternalApi`, `@DoNotInherit`, and `@ApiMayChange`. See [API stability annotations and comments](https://doc.akka.io/docs/akka/current/common/binary-compatibility-rules.html#api-stability-annotations-and-comments)
- if it is touching any class marked with the `@InternalApi`, `@DoNotInherit`, and `@ApiMayChange`. See [API stability annotations and comments](https://doc.akka.io/libraries/akka-core/current/common/binary-compatibility-rules.html#api-stability-annotations-and-comments)
- other tricky situations

If it turns out that the change can be safely ignored, please add the filter to a file with the issue number in the filename, placed in the submodule's `src/main/mima-filters/<last-released-version>.backwards.excludes` directory.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Documentation
-------------

The documentation is available at
[doc.akka.io](https://doc.akka.io/docs/akka-http/current/), for
[Scala](https://doc.akka.io/docs/akka-http/current/scala/http/) and
[Java](https://doc.akka.io/docs/akka-http/current/java/http/).
[doc.akka.io](https://doc.akka.io/libraries/akka-http/current/), for
[Scala](https://doc.akka.io/libraries/akka-http/current/scala/http/) and
[Java](https://doc.akka.io/libraries/akka-http/current/java/http/).


Current versions of all Akka libraries
--------------------------------------

The current versions of all Akka libraries are listed on the [Akka Dependencies](https://doc.akka.io/docs/akka-dependencies/current/) page. Releases of the Akka HTTP libraries in this repository are listed on the [GitHub releases](https://github.com/akka/akka-http/releases) page.
The current versions of all Akka libraries are listed on the [Akka Dependencies](https://doc.akka.io/libraries/akka-dependencies/current/) page. Releases of the Akka HTTP libraries in this repository are listed on the [GitHub releases](https://github.com/akka/akka-http/releases) page.


Community
Expand Down
2 changes: 1 addition & 1 deletion akka-http-core/src/main/resources/reference.conf
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ akka.http {
#
# It is also possible to provide a payload for each heartbeat message,
# this setting can be configured programatically by modifying the websocket settings.
# See: https://doc.akka.io/docs/akka-http/current/server-side/websocket-support.html
# See: https://doc.akka.io/libraries/akka-http/current/server-side/websocket-support.html
periodic-keep-alive-mode = ping

# Interval for sending periodic keep-alives
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ private[http] object PoolInterface {
private[this] val PoolOverflowException = new BufferOverflowException( // stack trace cannot be prevented here because `BufferOverflowException` is final
s"Exceeded configured max-open-requests value of [${poolId.hcps.setup.settings.maxOpenRequests}]. This means that the request queue of this pool (${poolId.hcps}) " +
s"has completely filled up because the pool currently does not process requests fast enough to handle the incoming request load. " +
"Please retry the request later. See https://doc.akka.io/docs/akka-http/current/scala/http/client-side/pool-overflow.html for " +
"Please retry the request later. See https://doc.akka.io/libraries/akka-http/current/scala/http/client-side/pool-overflow.html for " +
"more information.")

val hcps = poolId.hcps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import akka.stream._
* This low-level API is expected to be replaced by an Attribute in the future.
*
* In any case, you might want to use `handleWebSocketMessages` instead as documented
* at https://doc.akka.io/docs/akka-http/current/server-side/websocket-support.html#routing-support
* at https://doc.akka.io/libraries/akka-http/current/server-side/websocket-support.html#routing-support
*
* @deprecated use the WebSocketUpgrade attribute instead since 10.2.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import akka.stream.{ FlowShape, Graph, SinkShape, SourceShape }
* create a WebSocket handshake response and handle the WebSocket message stream with the given handler.
*
* This is a low-level API. You might want to use `handleWebSocketMessages` instead as documented
* at https://doc.akka.io/docs/akka-http/current/server-side/websocket-support.html#routing-support
* at https://doc.akka.io/libraries/akka-http/current/server-side/websocket-support.html#routing-support
*/
trait WebSocketUpgrade {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import akka.http.scaladsl.model.HttpResponse
* registers a WebSocket handler.
*
* This is a low-level API. You might want to use `handleWebSocketMessages` instead as documented
* at https://doc.akka.io/docs/akka-http/current/server-side/websocket-support.html#routing-support
* at https://doc.akka.io/libraries/akka-http/current/server-side/websocket-support.html#routing-support
*/
trait WebSocketUpgrade extends jm.ws.WebSocketUpgrade {
/**
Expand Down
4 changes: 2 additions & 2 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -485,12 +485,12 @@ lazy val docs = project("docs")
"quickstart-scala/index.html"),
Compile / paradoxProperties ++= Map(
"project.name" -> "Akka HTTP",
"canonical.base_url" -> "https://doc.akka.io/docs/akka-http/current",
"canonical.base_url" -> "https://doc.akka.io/libraries/akka-http/current",
"akka.version" -> AkkaDependency.docs.version,
"akka.minimum.version" -> AkkaDependency.minimumExpectedAkkaVersion,
"jackson.xml.version" -> Dependencies.jacksonXmlVersion,
"scalafix.version" -> _root_.scalafix.sbt.BuildInfo.scalafixVersion, // grab from scalafix plugin directly
"extref.akka-docs.base_url" -> s"https://doc.akka.io/docs/akka/${AkkaDependency.docs.link}/%s",
"extref.akka-docs.base_url" -> s"https://doc.akka.io/libraries/akka-core/${AkkaDependency.docs.link}/%s",
"javadoc.akka.http.base_url" -> {
val v = if (isSnapshot.value) "current" else version.value
s"https://doc.akka.io/japi/akka-http/$v"
Expand Down
2 changes: 1 addition & 1 deletion docs/release-train-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ For minor or major releases:
### Afterwards
- [ ] Add the released version to `project/MiMa.scala` to the `mimaPreviousArtifacts` key *of all current compatible branches*.
- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) and version for [Akka module versions](https://doc.akka.io/docs/akka-dependencies/current/) in [akka-dependencies repo](https://github.com/akka/akka-dependencies)
- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) and version for [Akka module versions](https://doc.akka.io/libraries/akka-dependencies/current/) in [akka-dependencies repo](https://github.com/akka/akka-dependencies)
- [ ] Update [Akka Guide samples](https://github.com/akka/akka-platform-guide)
- [ ] Update sbt new (g8) template:
- [ ] [Akka HTTP Scala](https://github.com/akka/akka-http-quickstart-scala.g8/blob/main/src/main/g8/default.properties)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/client-side/client-transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Java
You can use @apidoc[ClientTransport.withCustomResolver](ClientTransport) to customize host name resolution. The given resolution function will be called for every connection attempt to resolve
a hostname / port combination (potentially asynchronously) to an `InetSocketAddress`.

As a backend to implement the resolution function you can use Akka's [Async DNS Resolution](https://doc.akka.io/docs/akka/current/io-dns.html#dns-extension).
As a backend to implement the resolution function you can use Akka's [Async DNS Resolution](https://doc.akka.io/libraries/akka-core/current/io-dns.html#dns-extension).

Potential use cases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Creates a @scala[@scaladoc[Route](akka.http.scaladsl.server.index#Route=akka.htt
that handles the request using a function or `PartialFunction` from @apidoc[HttpRequest] to a @scala[`Future`]@java[`CompletionStage`] of @apidoc[HttpResponse].

This directive can be used to include external components request processing components defined as a `Function` or `PartialFunction`
(like [those provided by akka-grpc](https://doc.akka.io/docs/akka-grpc/current/server/walkthrough.html#serving-multiple-services))
(like [those provided by akka-grpc](https://doc.akka.io/libraries/akka-grpc/current/server/walkthrough.html#serving-multiple-services))
into a routing tree defined by directives and routes.

For the `PartialFunction` variant, the given list of rejections will be used to reject the request with if the `PartialFunction` is not defined for a request. By default,
Expand All @@ -25,4 +25,4 @@ There is also a strict version called @ref[handleSync](handleSync.md).
## Example

Scala
: @@snip [RouteDirectivesExamplesSpec.scala](/docs/src/test/scala/docs/http/scaladsl/server/directives/RouteDirectivesExamplesSpec.scala) { #handle-examples-with-PF }
: @@snip [RouteDirectivesExamplesSpec.scala](/docs/src/test/scala/docs/http/scaladsl/server/directives/RouteDirectivesExamplesSpec.scala) { #handle-examples-with-PF }
4 changes: 2 additions & 2 deletions project/AkkaDependency.scala
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ object AkkaDependency {
}
}

// Default version updated only when needed, https://doc.akka.io//docs/akka/current/project/downstream-upgrade-strategy.html
// Default version updated only when needed, https://doc.akka.io/libraries/akka-core/current/project/downstream-upgrade-strategy.html
val minimumExpectedAkkaVersion = "2.9.3"
val default = akkaDependency(defaultVersion = minimumExpectedAkkaVersion)
val docs = akkaDependency(defaultVersion = minimumExpectedAkkaVersion)
Expand Down Expand Up @@ -87,7 +87,7 @@ object AkkaDependency {
import scala.concurrent.Await
import scala.concurrent.duration._

val versionFile = "https://doc.akka.io/docs/akka/snapshot/paradox.json"
val versionFile = "https://doc.akka.io/libraries/akka-core/snapshot/paradox.json"
val body = Await.result(http.run(url(versionFile)), 10.seconds).bodyAsString
val versionProperty = """"version" : """"
val i = body.indexOf(versionProperty)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<configuration>
<!-- This is a development logging configuration that logs to standard out, for an example of a production
logging config, see the Akka docs: https://doc.akka.io/docs/akka/current/typed/logging.html#logback -->
logging config, see the Akka docs: https://doc.akka.io/libraries/akka-core/current/typed/logging.html#logback -->
<appender name="STDOUT" target="System.out" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>[%date{ISO8601}] [%level] [%logger] [%thread] [%X{akkaSource}] - %msg%n</pattern>
Expand Down

0 comments on commit 9b1221f

Please sign in to comment.