Skip to content

Commit

Permalink
docs: links fixing (#4454)
Browse files Browse the repository at this point in the history
  • Loading branch information
ennru authored Nov 25, 2024
1 parent 66e509e commit 870595f
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 18 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Akka HTTP
=========
The Akka family of projects is managed by teams at [Lightbend](https://lightbend.com/) with help from the community.
The Akka family of projects is managed by teams at [Akka (formerly Lightbend)](https://akka.io/) with help from the community.

The Akka HTTP modules implement a full server- and client-side HTTP stack on top
of akka-actor and akka-stream. It's not a web-framework but rather a more
Expand All @@ -21,9 +21,7 @@ Documentation
-------------

The documentation is available at
[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/).
[doc.akka.io](https://doc.akka.io/libraries/akka-http/current/).


Current versions of all Akka libraries
Expand All @@ -41,11 +39,10 @@ You can join these groups and chats to discuss and ask Akka related questions:
- Issue tracker: [![github: akka/akka-http][github-issues-badge]][github-issues] (Please use the issue
tracker for bugs and reasonable feature requests. Please ask usage questions on the other channels.)

All of our forums, chat rooms, and issue trackers are governed by our [Code Of Conduct](https://www.lightbend.com/conduct).
All of our forums, chat rooms, and issue trackers are governed by our [Code Of Conduct](https://akka.io/conduct).

In addition to that, you may enjoy following:

- The [news](https://akka.io/blog/news-archive.html) section of the page, which is updated whenever a new version is released
- The [Akka Team Blog](https://akka.io/blog)
- [@akkateam](https://twitter.com/akkateam) on Twitter

Expand All @@ -67,13 +64,13 @@ and general hints on how to prepare your pull request. You can also ask for clar
Maintenance
-----------

This project is maintained by Lightbend's core Akka Team as well as the extended Akka HTTP Team, consisting of excellent and experienced developers who have shown their dedication and knowledge about HTTP and the codebase. This team may grow dynamically, and it is possible to propose new members to it.
This project is maintained by the core Akka Team as well as the extended Akka HTTP Team, consisting of excellent and experienced developers who have shown their dedication and knowledge about HTTP and the codebase. This team may grow dynamically, and it is possible to propose new members to it.

Joining the extended team in such form gives you, in addition to street-cred, of course committer rights to this repository as well as higher impact onto the roadmap of the project. Come and join us!

License
-------

Akka is licensed under the Business Source License 1.1, please see the [Akka License FAQ](https://www.lightbend.com/akka/license-faq).
Akka is licensed under the Business Source License 1.1, please see the [Akka License FAQ](https://akka.io/bsl-license-faq).

Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details.
2 changes: 1 addition & 1 deletion docs/src/main/paradox/client-side/host-level.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ by failing requests with a @apidoc[BufferOverflowException] when the internal bu
exist or too many requests have been issued to the pool.

To mimic the request-level API we can put an explicit queue in front of the pool and decide ourselves what to do when
this explicit queue overflows. This example shows how to do this. (Thanks go to [kazuhiro's blog for the initial idea](https://kazuhiro.github.io/scala/akka/akka-http/akka-streams/2016/01/31/connection-pooling-with-akka-http-and-source-queue.html).)
this explicit queue overflows. This example shows how to do this.

You can tweak the `QueueSize` setting according to your memory constraints. In any case, you need to think about a strategy
about what to do when requests fail because the queue overflowed (e.g. try again later or just fail).
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ However, if your application is not primarily a web application because its core

Akka HTTP was designed specifically as “not-a-framework”, not because we don’t like frameworks, but for use cases where a framework is not the right choice. Akka HTTP is made for building integration layers based on HTTP and as such tries to “stay on the sidelines”. Therefore you normally don’t build your application “on top of” Akka HTTP, but you build your application on top of whatever makes sense and use Akka HTTP merely for the HTTP integration needs.

On the other hand, if you prefer to build your applications with the guidance of a framework, you should give [Play Framework](https://www.playframework.com/) or [Lagom](https://www.lagomframework.com/) a try, which both use Akka internally. If you
On the other hand, if you prefer to build your applications with the guidance of a framework, you should give [Play Framework](https://www.playframework.com/) a try, which both use Akka internally. If you
come from Play and want to try Akka HTTP, we collected a @ref[side-by-side comparison](routing-dsl/play-comparison.md) to show how some Play routing features map to the Akka HTTP routing DSL.

## Using Akka HTTP
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/quickstart-java/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Akka HTTP Quickstart for Java

Akka HTTP offers a general toolkit for providing and consuming HTTP-based services. The Akka HTTP modules implement a full server- and client-side HTTP stack on top of `akka-actor` and `akka-stream`. A typical application does not sit on top of Akka HTTP. Instead, Akka HTTP makes it easier to build integration layers based on HTTP, and therefore stays on the sidelines. This allows you to base your app on what makes sense and use Akka HTTP for HTTP integration.

Akka HTTP is not a framework--not because we don't like frameworks--but to provide maximum flexibility. For example, you might use the Play framework to implement browser-based interactions or Lagom framework for creating microservices, both of them are also based on Akka.
Akka HTTP is not a framework--not because we don't like frameworks--but to provide maximum flexibility. For example, you might use the Play framework to implement browser-based interactions, also based on Akka.

Akka HTTP follows a rather open design and often offers several APIs for accomplishing the same thing. You can choose the API with the level of abstraction that best suits your application. If you have trouble achieving something using a high-level API, you can probably find a lower-level API to use. The low-level APIs offer more flexibility, but might require you to write more application code.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/quickstart-scala/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Akka HTTP Quickstart for Scala

Akka HTTP offers a general toolkit for providing and consuming HTTP-based services. The Akka HTTP modules implement a full server- and client-side HTTP stack on top of `akka-actor` and `akka-stream`. A typical application does not sit on top of Akka HTTP. Instead, Akka HTTP makes it easier to build integration layers based on HTTP, and therefore stays on the sidelines. This allows you to base your app on what makes sense and use Akka HTTP for HTTP integration.

Akka HTTP is not a framework--not because we don't like frameworks--but to provide maximum flexibility. For example, you might use the Play framework to implement browser-based interactions or Lagom framework for creating microservices, both of them are also based on Akka.
Akka HTTP is not a framework--not because we don't like frameworks--but to provide maximum flexibility. For example, you might use the Play framework to implement browser-based interactions, also based on Akka.

Akka HTTP follows a rather open design and often offers several APIs for accomplishing the same thing. You can choose the API with the level of abstraction that best suits your application. If you have trouble achieving something using a high-level API, you can probably find a lower-level API to use. The low-level APIs offer more flexibility, but might require you to write more application code.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ as defined in [RFC 6750](https://tools.ietf.org/html/rfc6750), and allow users t

When transforming request `Credentials` into an application specific user identifier the naive solution for
checking the secret (password) would be a regular string comparison, but doing this would open up the application to
timing attacks. See for example [Timing Attacks Explained](https://emerose.com/timing-attacks-explained) for an explanation of the problem.
timing attacks.

To protect users of the library from that mistake the secret is not available through the API, instead the method
`Credentials.Provided.verify(String)` should be used. It does a constant time comparison rather than returning early
Expand Down
2 changes: 1 addition & 1 deletion project/plugins.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.7")
addSbtPlugin("com.github.sbt" % "sbt-boilerplate" % "0.7.0")
addSbtPlugin("com.lightbend.sbt" % "sbt-publish-rsync" % "0.3")
addSbtPlugin("com.lightbend.sbt" % "sbt-bill-of-materials" % "1.0.2")
addSbtPlugin("io.akka" % "sbt-paradox-akka" % "24.10.4")
addSbtPlugin("io.akka" % "sbt-paradox-akka" % "24.10.6")
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0")
addSbtPlugin("net.bzzt" % "sbt-reproducible-builds" % "0.32")
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.12.1")
Expand Down
8 changes: 4 additions & 4 deletions project/project-info.conf
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ project-info {
text: "Github issues"
}
release-notes: {
url: "https://akka.io/blog/news-archive.html"
text: "akka.io blog"
url: "https://doc.akka.io/reference/release-notes.html"
text: "Akka release notes"
new-tab: false
}
forums: [
{
text: "Lightbend Discuss"
url: "https://discuss.lightbend.com/tags/c/akka/akka-http"
text: "Akka Discuss"
url: "https://discuss.akka.io"
}
]
}
Expand Down

0 comments on commit 870595f

Please sign in to comment.