Skip to content

Commit

Permalink
docs: more direct links to pages that redirect
Browse files Browse the repository at this point in the history
  • Loading branch information
raboof committed Nov 28, 2024
1 parent f08f77f commit ef42f22
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/src/main/paradox/apidesign.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/client/details.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/src/main/paradox/release-notes/releases-1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/server/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ef42f22

Please sign in to comment.