Skip to content

Commit f000776

Browse files
authored
chore: align with updated doc URLs (#35)
1 parent 6ed689d commit f000776

4 files changed

Lines changed: 30 additions & 25 deletions

File tree

samples/java-eventsourced-shopping-cart/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This example project implements an API for a shopping cart using an Akka Serverl
88
read [designing services](https://developer.lightbend.com/docs/akka-serverless/designing/index.html)
99
* developing - it may be useful to read up
1010
on [developing services](https://developer.lightbend.com/docs/akka-serverless/developing/index.html) and in particular
11-
the [Java section](https://developer.lightbend.com/docs/akka-serverless/java-services/index.html)
11+
the [Java section](https://developer.lightbend.com/docs/akka-serverless/java/index.html)
1212

1313
## Building
1414

@@ -44,7 +44,7 @@ mvn compile exec:java
4444

4545
With both the proxy and your application running, any defined endpoints should be available at `http://localhost:9000`.
4646
In addition to the defined gRPC interface, each method has a corresponding HTTP endpoint. Unless configured otherwise (
47-
see [Transcoding HTTP](https://docs.lbcs.dev/js-services/proto.html#_transcoding_http)), this endpoint accepts POST
47+
see [Transcoding HTTP](https://developer.lightbend.com/docs/akka-serverless/java/proto.html#_transcoding_http)), this endpoint accepts POST
4848
requests at the path `/[package].[entity name]/[method]`. For example, using `curl`:
4949

5050
* Send an AddItem command:
@@ -75,8 +75,8 @@ grpcurl --plaintext -d '{"cart_id": "cart1", "product_id": "akka-tshirt" }' loca
7575

7676
## Running integration tests
7777

78-
The integration tests in `src/it` are added by setting it as test source directory. To Integration Tests in src/it/java
79-
with
78+
The integration tests in `src/it` are added by setting `it` as test source directory.
79+
To run the Integration Tests in `src/it/java` use
8080

8181
```shell
8282
mvn verify -Pit
@@ -93,6 +93,6 @@ You will need to update the `akkasls.dockerImage` property in the `pom.xml` and
9393
for more information on how to make your docker image available to Akka Serverless.
9494

9595
Finally, you can or use the [Akka Serverless Console](https://console.akkaserverless.com)
96-
to create a project and then deploy your service into the project either by using `mvn deploy`, through the `akkasls`
97-
CLI or via the web interface. When using `mvn deploy`, Maven will also conveniently package and publish your docker
98-
image prior to deployment.
96+
to create a project and then deploy your service into the project either by using `mvn deploy`,
97+
through the `akkasls` CLI or via the web interface. When using `mvn deploy`, Maven will also
98+
conveniently package and publish your docker image prior to deployment.

samples/java-valueentity-shopping-cart/README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@ This example project implements an API for a shopping cart using an Akka Serverl
44

55
## See also
66

7-
* designing - while designing your service it is useful to read [designing services](https://developer.lightbend.com/docs/akka-serverless/designing/index.html)
8-
* developing - it may be useful to read up on [developing services](https://developer.lightbend.com/docs/akka-serverless/developing/index.html) and in particular the [Java section](https://developer.lightbend.com/docs/akka-serverless/java-services/index.html)
7+
* designing - while designing your service it is useful to
8+
read [designing services](https://developer.lightbend.com/docs/akka-serverless/designing/index.html)
9+
* developing - it may be useful to read up
10+
on [developing services](https://developer.lightbend.com/docs/akka-serverless/developing/index.html) and in particular
11+
the [Java section](https://developer.lightbend.com/docs/akka-serverless/java/index.html)
912

1013
## Building
1114

@@ -15,13 +18,12 @@ To build, at a minimum you need to generate and process sources, particularly wh
1518
mvn compile
1619
```
1720

18-
1921
## Running Locally
2022

21-
In order to run your application locally, you must run the Akka Serverless proxy. The included `docker-compose` file contains the configuration required to run the proxy for a locally running application.
22-
It also contains the configuration to start a local Google Pub/Sub emulator that the Akka Serverless proxy will connect to.
23-
To start the proxy, run the following command from this directory:
24-
23+
In order to run your application locally, you must run the Akka Serverless proxy. The included `docker-compose` file
24+
contains the configuration required to run the proxy for a locally running application. It also contains the
25+
configuration to start a local Google Pub/Sub emulator that the Akka Serverless proxy will connect to. To start the
26+
proxy, run the following command from this directory:
2527

2628
```shell
2729
docker-compose up
@@ -40,7 +42,10 @@ To start the application locally, the `exec-maven-plugin` is used. Use the follo
4042
mvn compile exec:java
4143
```
4244

43-
With both the proxy and your application running, any defined endpoints should be available at `http://localhost:9000`. In addition to the defined gRPC interface, each method has a corresponding HTTP endpoint. Unless configured otherwise (see [Transcoding HTTP](https://docs.lbcs.dev/js-services/proto.html#_transcoding_http)), this endpoint accepts POST requests at the path `/[package].[entity name]/[method]`. For example, using `curl`:
45+
With both the proxy and your application running, any defined endpoints should be available at `http://localhost:9000`.
46+
In addition to the defined gRPC interface, each method has a corresponding HTTP endpoint. Unless configured otherwise (
47+
see [Transcoding HTTP](https://developer.lightbend.com/docs/akka-serverless/java/proto.html#_transcoding_http)), this endpoint accepts POST
48+
requests at the path `/[package].[entity name]/[method]`. For example, using `curl`:
4449

4550
* Send an AddItem command:
4651

@@ -70,8 +75,8 @@ grpcurl --plaintext -d '{"cart_id": "cart1", "product_id": "akka-tshirt" }' loca
7075

7176
## Running integration tests
7277

73-
The integration tests in `src/it` are added by setting it as test source directory.
74-
To Integration Tests in src/it/java with
78+
The integration tests in `src/it` are added by setting `it` as test source directory.
79+
To run the Integration Tests in `src/it/java` use
7580

7681
```shell
7782
mvn verify -Pit

samples/valueentity-counter/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ mvn archetype:generate \
99
-DarchetypeVersion=LATEST
1010
```
1111

12-
See the [Kickstart a Maven project](https://developer.lightbend.com/docs/akka-serverless/java-services/kickstart.html) in the documentation for details.
12+
See the [Kickstart a Maven project](https://developer.lightbend.com/docs/akka-serverless/java/kickstart.html) in the documentation for details.
1313

1414
## Building and running unit tests
1515

sdk/src/main/scala/com/akkaserverless/javasdk/impl/DocLinks.scala

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ object DocLinks {
2121
private val baseUrl = "https://developer.lightbend.com/docs/akka-serverless"
2222

2323
private val errorCodes = Map(
24-
"AS-00112" -> s"$baseUrl/java-services/views.html#changing",
25-
"AS-00402" -> s"$baseUrl/java-services/topic-eventing.html",
26-
"AS-00406" -> s"$baseUrl/java-services/topic-eventing.html"
24+
"AS-00112" -> s"$baseUrl/java/views.html#changing",
25+
"AS-00402" -> s"$baseUrl/java/topic-eventing.html",
26+
"AS-00406" -> s"$baseUrl/java/topic-eventing.html"
2727
)
2828

2929
// fallback if not defined in errorCodes
3030
private val errorCodeCategories = Map(
31-
"AS-001" -> s"$baseUrl/java-services/views.html",
32-
"AS-002" -> s"$baseUrl/java-services/value-entity.html",
33-
"AS-003" -> s"$baseUrl/java-services/eventsourced.html",
34-
"AS-004" -> s"$baseUrl/java-services/" // no single page for eventing
31+
"AS-001" -> s"$baseUrl/java/views.html",
32+
"AS-002" -> s"$baseUrl/java/value-entity.html",
33+
"AS-003" -> s"$baseUrl/java/eventsourced.html",
34+
"AS-004" -> s"$baseUrl/java/" // no single page for eventing
3535
)
3636

3737
def forErrorCode(code: String): Option[String] =

0 commit comments

Comments
 (0)