This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-http.git
The following commit(s) were added to refs/heads/main by this push:
new cfe5cbc59 update docs to refer to Pekko extensions and examples (#94)
cfe5cbc59 is described below
commit cfe5cbc594f00b230757d73ad849f82b2949e6e9
Author: PJ Fanning <[email protected]>
AuthorDate: Thu Mar 2 11:16:03 2023 +0100
update docs to refer to Pekko extensions and examples (#94)
---
docs/src/main/paradox/client-side/pool-overflow.md | 2 +-
docs/src/main/paradox/examples-and-extensions.md | 19 +++++++++++++++++++
docs/src/main/paradox/extensions.md | 14 --------------
docs/src/main/paradox/index.md | 2 +-
docs/src/main/paradox/introduction.md | 12 +++++-------
docs/src/main/paradox/reference.md | 2 +-
6 files changed, 27 insertions(+), 24 deletions(-)
diff --git a/docs/src/main/paradox/client-side/pool-overflow.md
b/docs/src/main/paradox/client-side/pool-overflow.md
index a46d03b69..8c03ff2af 100644
--- a/docs/src/main/paradox/client-side/pool-overflow.md
+++ b/docs/src/main/paradox/client-side/pool-overflow.md
@@ -46,7 +46,7 @@ there are multiple such requests going on at the same time it
will lead to starv
progress anymore. Make sure to run a long-running request on a dedicated
connection (using the
@ref[Connection-Level Client-Side API](connection-level.md)) to prevent such a
situation.
-## Why does this happen only with Apache Pekko Http and not with [insert other
client]
+## Why does this happen only with Apache Pekko HTTP and not with [insert other
client]
Many Java HTTP clients don't set limits by default for some of the resources
used. E.g. some clients will never queue a
request but will just open another connection to the server if all the pooled
connections are currently busy. However,
diff --git a/docs/src/main/paradox/examples-and-extensions.md
b/docs/src/main/paradox/examples-and-extensions.md
new file mode 100644
index 000000000..b7250f9b6
--- /dev/null
+++ b/docs/src/main/paradox/examples-and-extensions.md
@@ -0,0 +1,19 @@
+# 6. Examples and Extensions
+
+## Examples
+* https://github.com/jrudolph/pekko-http-scala-js-websocket-chat
+* https://github.com/theiterators/pekko-http-microservice
+
+If you are aware of any interesting examples that use Apache Pekko HTTP,
please notify us or create a PR to modify this page.
+
+## Extensions
+There are several [third party
libraries](https://doc.akka.io/docs/akka-http/10.2/extensions.html) that expand
the functionality of Akka HTTP.
+
+Some that support Apache Pekko HTTP snapshots include:
+
+- [pekko-http-json](https://github.com/pjfanning/pekko-http-json): Integrate
some of the best JSON libs in Scala with Pekko HTTP.
+-
[swagger-pekko-http](https://github.com/swagger-akka-http/swagger-pekko-http):
A Scala/Java library for generating Open API (a.k.a. Swagger) from annotated
Pekko HTTP code.
+
+If you are aware of any extensions that support Apache Pekko HTTP, please
notify us or create a PR to modify this page.
+
+See the Scala Index for a more in-depth list of them. [Modules with the topic
pekko-http](https://index.scala-lang.org/search?topics=pekko-http)
diff --git a/docs/src/main/paradox/extensions.md
b/docs/src/main/paradox/extensions.md
deleted file mode 100644
index 926df833e..000000000
--- a/docs/src/main/paradox/extensions.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# 6. Extensions
-
-There are several third party libraries that expand the functionality of Akka
Http.
-
-Among those, we want to highlight the following:
-
-- [akka-http-json](https://github.com/hseeberger/akka-http-json): Integrate
some of the best JSON libs in Scala with Akka HTTP
-- [swagger-akka-http](https://github.com/swagger-akka-http/swagger-akka-http):
A Scala/Java library for generating Open API (a.k.a. Swagger) from annotated
Akka HTTP code
-- [Guardrail](https://github.com/twilio/guardrail): Guardrail is a code
generation tool, capable of reading from OpenAPI/Swagger specification files
and generating Akka HTTP code
-- [akka-http-cors](https://github.com/lomigmegard/akka-http-cors): Akka Http
directives implementing the CORS specifications defined by W3C
-- [akka-http-session](https://github.com/softwaremill/akka-http-session): Web
& mobile client-side akka-http sessions, with optional JWT support
-- [sttp](https://github.com/softwaremill/sttp): Library that provides a clean,
programmer-friendly API to define HTTP requests and execute them using one of
the wrapped backends, akka-http among them.
-
-See the Scala Index for a more in-depth list of them. [
* [server-side/index](server-side/index.md)
* [client-side/index](client-side/index.md)
-* [extensions](extensions.md)
+* [examples and extensions](examples-and-extensions.md)
* [technologies](technologies.md)
* [tips](tipsandtricks.md)
* [contributing](contributing.md)
diff --git a/docs/src/main/paradox/introduction.md
b/docs/src/main/paradox/introduction.md
index f7d206366..86b819a00 100644
--- a/docs/src/main/paradox/introduction.md
+++ b/docs/src/main/paradox/introduction.md
@@ -43,16 +43,12 @@ choose an Apache Pekko version to run against and add a
manual dependency to `pe
group3="org.apache.pekko" artifact3="pekko-http_$scala.binary.version$"
version3="PekkoHttpVersion"
}
-You may download a packaged version of this project by clicking "Create a
project for me!" on the
-@scala[[Lightbend Getting Started
page](https://developer.lightbend.com/start/?group=akka&project=akka-http-quickstart-scala)]
-@java[[Lightbend Getting Started
page](https://developer.lightbend.com/start/?group=akka&project=akka-http-quickstart-java)].
-
-Alternatively, you can bootstrap a new project with Apache Pekko HTTP already
configured using the [Giter8](http://www.foundweekends.org/giter8/) template
directly via sbt:
+You can bootstrap a new project with Apache Pekko HTTP already configured
using the [Giter8](http://www.foundweekends.org/giter8/) template directly via
sbt:
@@@ div { .group-scala }
For Scala (sbt)
: ```sh
- sbt new akka/akka-http-quickstart-scala.g8
+ sbt new theiterators/pekko-http-quickstart-scala.g8
```
@@@
@@@ div { .group-java }
@@ -61,10 +57,12 @@ For Java (Maven or Gradle)
sbt new akka/akka-http-quickstart-java.g8
```
From there on the prepared project can be built using Gradle or Maven.
+Unfortunately, we do not yet have a Java template but it should be easy to
migrate an Akka project to use
+Pekko instead.
@@@
More instructions can be found on the @scala[[template
-project](https://github.com/akka/akka-http-quickstart-scala.g8)]@java[[template
+project](https://github.com/theiterators/pekko-http-quickstart-scala.g8)]@java[[template
project](https://github.com/akka/akka-http-quickstart-java.g8)].
## Routing DSL for HTTP servers
diff --git a/docs/src/main/paradox/reference.md
b/docs/src/main/paradox/reference.md
index ec2c2d7d9..e85e6f25b 100644
--- a/docs/src/main/paradox/reference.md
+++ b/docs/src/main/paradox/reference.md
@@ -12,4 +12,4 @@
## Books
- * [Start Building RESTful Microservices using Apache Pekko HTTP with
Scala](https://www.amazon.com/dp/1976762545/), by Ayush Kumar Mishra, Knoldus
Software LLP, ISBN: 9781976762543, December 2017
+ * The best option is to get a book about [Akka
HTTP](https://doc.akka.io/docs/akka-http/current/reference.html). Anything you
learn should be useful when it comes to Pekko HTTP.
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
