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

chore: validating links in docs and samples #2210

Merged
merged 2 commits into from
Sep 11, 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
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ It is good practice to write unit tests as you implement your services. The kick
== Package service

Use Docker to package your service and any of its dependencies.
See https://docs.kalix.io/projects/container-registries.html[Configuring registries] for more information.
See https://docs.kalix.io/operations/container-registries.html[Configuring registries] for more information.


[#_run_locally]
Expand All @@ -85,5 +85,5 @@ You can test and debug your services by xref:java-protobuf:running-locally.adoc[

After testing locally, deploy your service to Kalix using the CLI or the Console. The following pages provide information about deployment:

* https://docs.kalix.io/projects/index.html[Working with Kalix projects]
* https://docs.kalix.io/services/deploy-service.html#_deploy[Deploying a packaged service]
* https://docs.kalix.io/operations/index.html[Working with Kalix projects]
* https://docs.kalix.io/operations/deploy-service.html#_deploy[Deploying a packaged service]
4 changes: 2 additions & 2 deletions docs/src/modules/java-protobuf/pages/project-template.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Before running the code generation tools, make sure you have the following:
To deploy the Kalix service, you need:

* A https://console.kalix.io[Kalix account]
* A https://docs.kalix.io/projects/create-project.html[Kalix project]
* A https://docs.kalix.io/operations/create-project.html[Kalix project]
* The https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI (kalix)]
* A configured registry in which to publish the service container image. Refer to https://docs.kalix.io/projects/container-registries.html[Configuring registries] for more information on how to make your Docker registry available to Kalix.
* A configured registry in which to publish the service container image. Refer to https://docs.kalix.io/operations/container-registries.html[Configuring registries] for more information on how to make your Docker registry available to Kalix.

:sectnums:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ include::example$java-protobuf-customer-registry-quickstart/src/main/java/custom

To build and publish the container image and then deploy the service, follow these steps:

. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/projects/create-project.html[create your first project], and set this project as the default.
. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/operations/create-project.html[create your first project], and set this project as the default.
+
[source,command line]
----
Expand All @@ -212,7 +212,7 @@ mvn deploy kalix:deploy
----
include::partial$important-mvn-kalixdeploy.adoc[]

. You can https://docs.kalix.io/services/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
. You can https://docs.kalix.io/operations/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
+
[source,command line]
----
Expand All @@ -221,14 +221,14 @@ kalix service list

== Invoke your service

Once the service has started successfully, you can https://docs.kalix.io/services/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:
Once the service has started successfully, you can https://docs.kalix.io/operations/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:

[source,command line]
----
kalix service proxy <service name> --grpcui
----

The `--grpcui` option also starts and opens a https://docs.kalix.io/services/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).
The `--grpcui` option also starts and opens a https://docs.kalix.io/operations/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).

Or you can use command line gRPC or HTTP clients, such as `grpcurl` or `curl`, to invoke the service through the proxy at `localhost:8080`, using plaintext connections.

Expand Down Expand Up @@ -260,7 +260,7 @@ grpcurl \
customer.api.CustomerService/GetCustomer
----

You can https://docs.kalix.io/services/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:
You can https://docs.kalix.io/operations/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:

[source,command line]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Create a customer registry that includes publishing to Kafka. Package it into a
** Java {java-pb-version} or higher
** https://maven.apache.org/download.cgi[Maven {minimum_maven_version} or higher, window="new"]
** https://github.com/fullstorydev/grpcurl#installation[`grpcurl`, window="new"]
** Configure your project message broker to use Kafka and create the topic `customer_changes` by following the https://docs.kalix.io/projects/message-brokers.html[Configure message brokers] how-to. When setting the broker the configuration file you pass should be like `kafka/my-dev.kafka.properties` that you can find in this project.
** Configure your project message broker to use Kafka and create the topic `customer_changes` by following the https://docs.kalix.io/operations/message-brokers.html[Configure message brokers] how-to. When setting the broker the configuration file you pass should be like `kafka/my-dev.kafka.properties` that you can find in this project.

[NOTE]
====
Expand Down Expand Up @@ -120,7 +120,7 @@ include::example$java-protobuf-customer-registry-kafka-quickstart/src/main/java/

To build and publish the container image and then deploy the service, follow these steps:

. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/projects/create-project.html[create your first project], and set this project as the default.
. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/operations/create-project.html[create your first project], and set this project as the default.
+
----
kalix auth login
Expand All @@ -134,21 +134,21 @@ mvn deploy kalix:deploy
----
include::partial$important-mvn-kalixdeploy.adoc[]

. You can https://docs.kalix.io/services/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
. You can https://docs.kalix.io/operations/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
+
----
kalix service list
----

== Invoke your service

Once the service has started successfully, you can https://docs.kalix.io/services/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:
Once the service has started successfully, you can https://docs.kalix.io/operations/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:

----
kalix service proxy <service name> --grpcui
----

The `--grpcui` option also starts and opens a https://docs.kalix.io/services/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).
The `--grpcui` option also starts and opens a https://docs.kalix.io/operations/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).

Or you can use command line gRPC or HTTP clients, such as `grpcurl` or `curl`, to invoke the service through the proxy at `localhost:8080`, using plaintext connections.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,21 +214,21 @@ To build and publish the container image and then deploy the service, follow the
sbt Docker/publish -Ddocker.username=[your-docker-hub-username]
----

. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/projects/create-project.html[create your first project], and set this project as the default.
. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/operations/create-project.html[create your first project], and set this project as the default.
+
[source,command line]
----
kalix auth login
----

. https://docs.kalix.io/services/deploy-service.html#_deploy[Deploy the service] with the published container image from above:
. https://docs.kalix.io/operations/deploy-service.html#_deploy[Deploy the service] with the published container image from above:
+
[source,command line]
----
kalix service deploy <service name> <container image>
----

. You can https://docs.kalix.io/services/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
. You can https://docs.kalix.io/operations/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
+
[source,command line]
----
Expand All @@ -237,14 +237,14 @@ kalix service list

== Invoke your service

Once the service has started successfully, you can https://docs.kalix.io/services/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:
Once the service has started successfully, you can https://docs.kalix.io/operations/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:

[source,command line]
----
kalix service proxy <service name> --grpcui
----

The `--grpcui` option also starts and opens a https://docs.kalix.io/services/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).
The `--grpcui` option also starts and opens a https://docs.kalix.io/operations/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).

Or you can use command line gRPC or HTTP clients, such as `grpcurl` or `curl`, to invoke the service through the proxy at `localhost:8080`, using plaintext connections.

Expand Down Expand Up @@ -276,7 +276,7 @@ grpcurl \
customer.api.CustomerService/GetCustomer
----

You can https://docs.kalix.io/services/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:
You can https://docs.kalix.io/operations/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:

[source,command line]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ This will result in a compilation error in the `Main` class. That is expected be

To build and publish the container image and then deploy the service, follow these steps:

. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/projects/create-project.html[create your first project], and set this project as the default.
. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/operations/create-project.html[create your first project], and set this project as the default.
+
----
kalix auth login
Expand All @@ -120,7 +120,7 @@ mvn deploy kalix:deploy
----
include::partial$important-mvn-kalixdeploy.adoc[]

. You can https://docs.kalix.io/services/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
. You can https://docs.kalix.io/operations/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
+
----
kalix service list
Expand All @@ -129,13 +129,13 @@ kalix service list
[#invoke]
== Invoke your service

Once the service has started successfully, you can https://docs.kalix.io/services/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:
Once the service has started successfully, you can https://docs.kalix.io/operations/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:

----
kalix service proxy <service name> --grpcui
----

The `--grpcui` option also starts and opens a https://docs.kalix.io/services/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).
The `--grpcui` option also starts and opens a https://docs.kalix.io/operations/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).

Or you can use command line gRPC or HTTP clients, such as `grpcurl` or `curl`, to invoke the service through the proxy at `localhost:8080`, using plaintext connections.

Expand Down Expand Up @@ -174,7 +174,7 @@ grpcurl \
customer.view.CustomerByEmail/GetCustomer
----

You can https://docs.kalix.io/services/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:
You can https://docs.kalix.io/operations/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:

----
kalix service expose <service name>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ The `src/main/java/shopping/cart/Main.java` file already contains the required c

To build and publish the container image and then deploy the service, follow these steps:

. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/projects/create-project.html[create your first project], and set this project as the default.
. If you haven't done so yet, sign in to your Kalix account. If this is your first time using Kalix, this will let you register an account, https://docs.kalix.io/operations/create-project.html[create your first project], and set this project as the default.
+
----
kalix auth login
Expand All @@ -271,21 +271,21 @@ mvn deploy kalix:deploy
----
include::partial$important-mvn-kalixdeploy.adoc[]

. You can https://docs.kalix.io/services/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
. You can https://docs.kalix.io/operations/deploy-service.html#_verify_service_status[verify the status of the deployed service] using:
+
----
kalix service list
----

== Invoke your service

Once the service has started successfully, you can https://docs.kalix.io/services/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:
Once the service has started successfully, you can https://docs.kalix.io/operations/invoke-service.html#_testing_and_development[start a proxy locally] to access the service:

----
kalix service proxy <service name> --grpcui
----

The `--grpcui` option also starts and opens a https://docs.kalix.io/services/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).
The `--grpcui` option also starts and opens a https://docs.kalix.io/operations/invoke-service.html#_using_the_built_in_graphical_client[gRPC web UI] for exploring and invoking the service (available at http://127.0.0.1:8080/ui/).

Or you can use command line gRPC or HTTP clients, such as `grpcurl` or `curl`, to invoke the service through the proxy at `localhost:8080`, using plaintext connections.

Expand All @@ -312,7 +312,7 @@ grpcurl \
shopping.cart.api.ShoppingCart/GetCart
----

You can https://docs.kalix.io/services/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:
You can https://docs.kalix.io/operations/invoke-service.html#_exposing_services_to_the_internet[expose the service to the internet]. A generated hostname will be returned from the expose command:

----
kalix service expose <service name>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/java-protobuf/partials/pubsub-note.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[NOTE]
====
In the Protobuf descriptors, only topic names are referenced and no additional details about how to connect to the topics are needed. When deploying the application there must be a broker configuration in the Kalix project, with credentials and details on how connect to the broker. For details about configuring a broker see https://docs.kalix.io/projects/message-brokers.html[Configure message brokers]
In the Protobuf descriptors, only topic names are referenced and no additional details about how to connect to the topics are needed. When deploying the application there must be a broker configuration in the Kalix project, with credentials and details on how connect to the broker. For details about configuring a broker see https://docs.kalix.io/operations/message-brokers.html[Configure message brokers]
====
6 changes: 3 additions & 3 deletions docs/src/modules/java/pages/development-process.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ integration tests. Please consult the component specific pages to learn more abo
== Package service

Use Docker to package your service and any of its dependencies.
See https://docs.kalix.io/projects/container-registries.html[Configuring registries] for more information.
See https://docs.kalix.io/operations/container-registries.html[Configuring registries] for more information.

[#_run_locally]
== Run locally
Expand All @@ -90,5 +90,5 @@ You can test and debug your services by xref:running-locally.adoc[running them l

After testing locally, deploy your service to Kalix using the CLI or the Console. The following pages provide information about deployment:

* https://docs.kalix.io/projects/index.html[Working with Kalix projects]
* https://docs.kalix.io/services/deploy-service.html#_deploy[Deploying a packaged service]
* https://docs.kalix.io/operations/index.html[Working with Kalix projects]
* https://docs.kalix.io/operations/deploy-service.html#_deploy[Deploying a packaged service]
4 changes: 2 additions & 2 deletions docs/src/modules/java/pages/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Before you start, make sure you have the following:
To deploy the Kalix service, you need:

* A https://console.kalix.io[Kalix account]
* A https://docs.kalix.io/projects/create-project.html[Kalix project]
* A https://docs.kalix.io/operations/create-project.html[Kalix project]
* The https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI (kalix)]
* A configured registry in which to publish the service container image. Refer to https://docs.kalix.io/projects/container-registries.html[Configuring registries] for more information on how to make your Docker registry available to Kalix.
* A configured registry in which to publish the service container image. Refer to https://docs.kalix.io/operations/container-registries.html[Configuring registries] for more information on how to make your Docker registry available to Kalix.

:sectnums:

Expand Down
Loading
Loading