Skip to content
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

docs: revise URL structure (libraries) #1976

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ However, once we declare the project stable, we will adhere to the following
rules:

Our binary compatibility guarantees are described in depth in the
[Binary Compatibility](https://doc.akka.io/docs/akka-grpc/current/binary-compatibility.html)
[Binary Compatibility](https://doc.akka.io/libraries/akka-grpc/current/binary-compatibility.html)
section of the documentation.

Akka gRPC uses [Lightbend MiMa](https://github.com/lightbend/mima) to
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ The Akka family of projects is managed by teams at [Lightbend](https://lightbend

## Documentation

- [Akka gRPC reference](https://doc.akka.io/docs/akka-grpc/current/) documentation
- [Akka gRPC reference](https://doc.akka.io/libraries/akka-grpc/current/) documentation

## Project Status

This library is ready to be used in production

The API on both sides (Client and Server) is a simple Akka Streams-based one.

The client side is currently implemented on top of [io.grpc:grpc-netty-shaded](https://mvnrepository.com/artifact/io.grpc/grpc-netty-shaded) with an [Akka HTTP](https://doc.akka.io/docs/akka-http/current) client
The client side is currently implemented on top of [io.grpc:grpc-netty-shaded](https://mvnrepository.com/artifact/io.grpc/grpc-netty-shaded) with an [Akka HTTP](https://doc.akka.io/libraries/akka-http/current) client
backend alternative available.

As for performance, we are currently relying on the JVM TLS implementation,
Expand Down Expand Up @@ -55,4 +55,4 @@ project in Java and Scala respectively, with both sbt and Gradle configurations.

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

Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details.
Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details.
10 changes: 5 additions & 5 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -209,19 +209,19 @@ lazy val docs = Project(id = "akka-grpc-docs", base = file("docs"))
"akka.version" -> Dependencies.Versions.akka,
"akka-http.version" -> Dependencies.Versions.akkaHttp,
"grpc.version" -> Dependencies.Versions.grpc,
"project.url" -> "https://doc.akka.io/docs/akka-grpc/current/",
"canonical.base_url" -> "https://doc.akka.io/docs/akka-grpc/current",
"project.url" -> "https://doc.akka.io/libraries/akka-grpc/current/",
"canonical.base_url" -> "https://doc.akka.io/libraries/akka-grpc/current",
"scaladoc.scala.base_url" -> s"https://www.scala-lang.org/api/current/",
// Akka
"extref.akka.base_url" -> s"https://doc.akka.io/docs/akka/${Dependencies.Versions.akkaBinary}/%s",
"extref.akka.base_url" -> s"https://doc.akka.io/libraries/akka-core/${Dependencies.Versions.akkaBinary}/%s",
"scaladoc.akka.base_url" -> s"https://doc.akka.io/api/akka/${Dependencies.Versions.akkaBinary}",
"javadoc.akka.base_url" -> s"https://doc.akka.io/japi/akka/${Dependencies.Versions.akkaBinary}/",
// Akka HTTP
"extref.akka-http.base_url" -> s"https://doc.akka.io/docs/akka-http/${Dependencies.Versions.akkaHttpBinary}/%s",
"extref.akka-http.base_url" -> s"https://doc.akka.io/libraries/akka-http/${Dependencies.Versions.akkaHttpBinary}/%s",
"scaladoc.akka.http.base_url" -> s"https://doc.akka.io/api/akka-http/${Dependencies.Versions.akkaHttpBinary}/",
"javadoc.akka.http.base_url" -> s"https://doc.akka.io/japi/akka-http/${Dependencies.Versions.akkaHttpBinary}/",
// Akka Management
"extref.akka-management.base_url" -> s"https://doc.akka.io/docs/akka-management/current/%s",
"extref.akka-management.base_url" -> s"https://doc.akka.io/libraries/akka-management/current/%s",
// Akka gRPC
"scaladoc.akka.grpc.base_url" -> s"/${(Preprocess / siteSubdirName).value}/",
"javadoc.akka.grpc.base_url" -> "" // @apidoc links to Scaladoc
Expand Down
4 changes: 2 additions & 2 deletions docs/release-train-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Variables to be expanded in this template:
### Check availability

- [ ] Check [API](https://doc.akka.io/api/akka-grpc/$VERSION$/) documentation
- [ ] Check [reference](https://doc.akka.io/docs/akka-grpc/$VERSION$/) documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
- [ ] Check [reference](https://doc.akka.io/libraries/akka-grpc/$VERSION$/) documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
- [ ] Check the release on https://repo.akka.io/maven/com/lightbend/akka/grpc/akka-grpc-scalapb-protoc-plugin_2.12/$VERSION$/akka-grpc-scalapb-protoc-plugin_2.12-$VERSION$.pom

### When everything is on https://repo.akka.io/maven
Expand All @@ -56,7 +56,7 @@ For minor or major releases:

### Afterwards

- [ ] 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/lightbend/akka-guide)
- [ ] Update [Akka Projection gRPC samples](https://github.com/akka/akka-projection/tree/main/samples/grpc)
- [ ] Update sbt new (g8) template:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/.htaccess
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Sample redirect when renaming pages
# RedirectMatch 301 ^/docs/akka-grpc/([^/]+)/release-notes/1.0.html https://doc.akka.io/docs/akka-grpc/$1/release-notes/1.0.x.html
# RedirectMatch 301 ^/libraries/akka-grpc/([^/]+)/release-notes/1.0.html https://doc.akka.io/libraries/akka-grpc/$1/release-notes/1.0.x.html
4 changes: 2 additions & 2 deletions docs/src/main/paradox/quickstart-java/streaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ This method is generated in the `GreeterService` interface and we have to implem

@@snip [GreeterServiceImpl.java](/samples/akka-grpc-quickstart-java/src/main/java/com/example/helloworld/GreeterServiceImpl.java) { #import #service-stream }

To connect all input and output streams of all connected clients dynamically we use a [MergeHub](https://doc.akka.io/docs/akka/current/stream/stream-dynamic.html#using-the-mergehub) for the incoming
messages and a [BroadcastHub](https://doc.akka.io/docs/akka/current/stream/stream-dynamic.html#using-the-broadcasthub) for the outgoing messages.
To connect all input and output streams of all connected clients dynamically we use a [MergeHub](https://doc.akka.io/libraries/akka-core/current/stream/stream-dynamic.html#using-the-mergehub) for the incoming
messages and a [BroadcastHub](https://doc.akka.io/libraries/akka-core/current/stream/stream-dynamic.html#using-the-broadcasthub) for the outgoing messages.

The `MergeHub` and `BroadcastHub` are only needed because we want to connect different clients with each other.
If each client was separate it might look like this to have the stream of incoming messages from one client
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/paradox/quickstart-scala/streaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ This method is generated in the `GreeterService` interface and we have to implem

@@snip [GreeterServiceImpl.scala](/samples/akka-grpc-quickstart-scala/src/main/scala/com/example/helloworld/GreeterServiceImpl.scala) { #import #service-stream }

To connect all input and output streams of all connected clients dynamically we use a [MergeHub](https://doc.akka.io/docs/akka/current/stream/stream-dynamic.html#using-the-mergehub) for the incoming
messages and a [BroadcastHub](https://doc.akka.io/docs/akka/current/stream/stream-dynamic.html#using-the-broadcasthub) for the outgoing messages.
To connect all input and output streams of all connected clients dynamically we use a [MergeHub](https://doc.akka.io/libraries/akka-core/current/stream/stream-dynamic.html#using-the-mergehub) for the incoming
messages and a [BroadcastHub](https://doc.akka.io/libraries/akka-core/current/stream/stream-dynamic.html#using-the-broadcasthub) for the outgoing messages.

The `MergeHub` and `BroadcastHub` are only needed because we want to connect different clients with each other.
If each client was separate it might look like this to have the stream of incoming messages from one client
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/server/grpc-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To serve a gRPC service with Akka gRPC, it is recommended to serve the
native gRPC protocol on a different port than gRPC-Web, as the two protocols
will likely require a different security story. You can use
@apidoc[WebHandler.grpcWebHandler](WebHandler$) to serve your
gRPC-Web endpoint with basic CORS infrastructure in place. To use CORS please have a look at our [akka-http docs](https://doc.akka.io/docs/akka-http/current/routing-dsl/directives/cors-directives/cors.html).
gRPC-Web endpoint with basic CORS infrastructure in place. To use CORS please have a look at our [akka-http docs](https://doc.akka.io/libraries/akka-http/current/routing-dsl/directives/cors-directives/cors.html).

And then serve the handlers with @apidoc[WebHandler.grpcWebHandler](WebHandler$) like this:

Expand Down
2 changes: 1 addition & 1 deletion gradle-plugin/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ gradlePlugin {
}

pluginBundle {
website = 'https://doc.akka.io/docs/akka-grpc/current/'
website = 'https://doc.akka.io/libraries/akka-grpc/current/'
vcsUrl = 'https://github.com/akka/akka-grpc'
description = 'Building streaming gRPC servers and clients on top of Akka Streams'
tags = ['akka', 'streams', 'reactive']
Expand Down
2 changes: 1 addition & 1 deletion plugin-tester-scala/src/main/resources/logback.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<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/2.6/typed/logging.html#logback -->
logging config, see the Akka docs: https://doc.akka.io/libraries/akka/2.6/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
4 changes: 2 additions & 2 deletions runtime/src/main/resources/reference.conf
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ akka.grpc.client."*" {

# Service discovery mechanism to use. The default is to use a static host
# and port that will be resolved via DNS.
# Any of the mechanisms described in https://doc.akka.io/docs/akka-management/current/discovery/index.html can be used
# Any of the mechanisms described in https://doc.akka.io/libraries/akka-management/current/discovery/index.html can be used
# including Kubernetes, Consul, AWS API
service-discovery {
mechanism = "static"
# Service name to use if a service-discovery.mechanism other than static or grpc-dns
service-name = ""
# See https://doc.akka.io/docs/akka-management/current/discovery/index.html for meanings for each mechanism
# See https://doc.akka.io/libraries/akka-management/current/discovery/index.html for meanings for each mechanism
# if blank then not passed to the lookup
port-name = ""
protocol = ""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<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/2.6/typed/logging.html#logback -->
logging config, see the Akka docs: https://doc.akka.io/libraries/akka/2.6/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<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/2.6/typed/logging.html#logback -->
logging config, see the Akka docs: https://doc.akka.io/libraries/akka/2.6/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
2 changes: 1 addition & 1 deletion scripts/link-validator.conf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ site-link-validator {
# Resolves URLs with the given prefix as local files instead
link-mappings = [
{
prefix = "https://doc.akka.io/docs/akka-grpc/snapshot/"
prefix = "https://doc.akka.io/libraries/akka-grpc/snapshot/"
replace = "/docs/akka-grpc/snapshot/"
}
{
Expand Down
Loading