From ef42f2299be0b5c3e55f85b9f3999c3b8ca31ba9 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Thu, 28 Nov 2024 18:52:30 +0100 Subject: [PATCH] docs: more direct links to pages that redirect --- docs/src/main/paradox/apidesign.md | 2 +- docs/src/main/paradox/client/details.md | 2 +- docs/src/main/paradox/getting-started.md | 2 +- docs/src/main/paradox/release-notes/releases-1.0.md | 2 +- docs/src/main/paradox/server/kubernetes.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/main/paradox/apidesign.md b/docs/src/main/paradox/apidesign.md index e45a1dc8..49c27db2 100644 --- a/docs/src/main/paradox/apidesign.md +++ b/docs/src/main/paradox/apidesign.md @@ -1,7 +1,7 @@ # API Design When designing a gRPC API, you could take into consideration some of the -[Google Cloud API Design Patterns](https://cloud.google.com/apis/design/design_patterns). +[Google Cloud API Design Patterns](https://google.aip.dev/general#design-patterns). ## Methods without request or response diff --git a/docs/src/main/paradox/client/details.md b/docs/src/main/paradox/client/details.md index d22864e8..0b9d4089 100644 --- a/docs/src/main/paradox/client/details.md +++ b/docs/src/main/paradox/client/details.md @@ -76,7 +76,7 @@ Java ## Rich error model -Beyond status codes you can also use the [Rich error model](https://grpc.io/docs/guides/error/#richer-error-model). Currently there is no particular support for consuming such error objects (such as the ones based on the [common protobuf](https://cloud.google.com/apis/design/errors#error_model), but you can obtain them 'manually'. +Beyond status codes you can also use the [Rich error model](https://grpc.io/docs/guides/error/#richer-error-model). Currently there is no particular support for consuming such error objects (such as the ones based on the [common protobuf](https://google.aip.dev/193), but you can obtain them 'manually'. Extract the `StatusRuntimeException` and parse the Rich error model to access `code`, `message` and `details`. Then find the details you are looking for based on their `typeUrl` and unpack them: diff --git a/docs/src/main/paradox/getting-started.md b/docs/src/main/paradox/getting-started.md index 55c5b670..3363f490 100644 --- a/docs/src/main/paradox/getting-started.md +++ b/docs/src/main/paradox/getting-started.md @@ -6,5 +6,5 @@ To try out Pekko gRPC and understand how the development process might work out, ## Video Introduction -The Akka team have a [video](https://doc.akka.io/docs/akka-grpc/current/getting-started.html#video-introduction). +The Akka team have a [video](https://doc.akka.io/libraries/akka-grpc/current/getting-started.html#video-introduction). Much of what is discussed is relevant to Pekko gRPC. diff --git a/docs/src/main/paradox/release-notes/releases-1.0.md b/docs/src/main/paradox/release-notes/releases-1.0.md index d934c3e6..863d9591 100644 --- a/docs/src/main/paradox/release-notes/releases-1.0.md +++ b/docs/src/main/paradox/release-notes/releases-1.0.md @@ -32,7 +32,7 @@ there are security issues published for those versions. ## 1.0.0 Apache Pekko gRPC 1.0.0 is based on Akka gRPC 2.1.6. Pekko came about as a result of Lightbend's decision to make future -Akka releases under a [Business Software License](https://www.lightbend.com/blog/why-we-are-changing-the-license-for-akka), +Akka releases under a [Business Software License](https://akka.io/blog/why-we-are-changing-the-license-for-akka), a license that is not compatible with Open Source usage. Apache Pekko has changed the package names, among other changes. Config names have changed to use `pekko` instead diff --git a/docs/src/main/paradox/server/kubernetes.md b/docs/src/main/paradox/server/kubernetes.md index 77031d77..b7616aeb 100644 --- a/docs/src/main/paradox/server/kubernetes.md +++ b/docs/src/main/paradox/server/kubernetes.md @@ -67,7 +67,7 @@ route. ## Google Cloud Endpoints -The Google cloud has a [Cloud Endpoints](https://cloud.google.com/endpoints) feature that +The Google cloud has a [Cloud Endpoints](https://cloud.google.com/endpoints/docs) feature that allows exposing a gRPC API in a more 'controlled' way: you can configure API key management, authentication, monitoring quote/rate limiting, generate a 'developer portal' for your API's users and much more. You need to provide your `.proto` definitions when creating the endpoint, and