mirror of https://github.com/dapr/java-sdk.git
Update dapr docs for Hugo upgrade (#1443)
Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com> Co-authored-by: Cassie Coyle <cassie.i.coyle@gmail.com>
This commit is contained in:
Marc Duiker
GitHub
parent
bbec093254
commit
cfb90678a0
|
|
@ -12,14 +12,14 @@ When contributing to the [Java SDK](https://github.com/dapr/java-sdk) the follow
|
|||
|
||||
The `examples` directory contains code samples for users to run to try out specific functionality of the various Java SDK packages and extensions. When writing new and updated samples keep in mind:
|
||||
|
||||
- All examples should be runnable on Windows, Linux, and MacOS. While Java code is consistent among operating systems, any pre/post example commands should provide options through [codetabs]({{< ref "contributing-docs.md#tabbed-content" >}})
|
||||
- All examples should be runnable on Windows, Linux, and MacOS. While Java code is consistent among operating systems, any pre/post example commands should provide options through [tabpane]({{% ref "contributing-docs.md#tabbed-content" %}})
|
||||
- Contain steps to download/install any required pre-requisites. Someone coming in with a fresh OS install should be able to start on the example and complete it without an error. Links to external download pages are fine.
|
||||
|
||||
## Docs
|
||||
|
||||
The `daprdocs` directory contains the markdown files that are rendered into the [Dapr Docs](https://docs.dapr.io) website. When the documentation website is built, this repo is cloned and configured so that its contents are rendered with the docs content. When writing docs, keep in mind:
|
||||
|
||||
- All rules in the [docs guide]({{< ref contributing-docs.md >}}) should be followed in addition to these.
|
||||
- All rules in the [docs guide]({{% ref contributing-docs.md %}}) should be followed in addition to these.
|
||||
- All files and directories should be prefixed with `java-` to ensure all file/directory names are globally unique across all Dapr documentation.
|
||||
|
||||
## Github Dapr Bot Commands
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ Dapr offers a variety of packages to help with the development of Java applicati
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
|
||||
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
|
||||
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
|
||||
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
|
||||
- JDK 11 or above - the published jars are compatible with Java 8:
|
||||
- [AdoptOpenJDK 11 - LTS](https://adoptopenjdk.net/)
|
||||
- [Oracle's JDK 15](https://www.oracle.com/java/technologies/javase-downloads.html)
|
||||
|
|
@ -30,9 +30,9 @@ Dapr offers a variety of packages to help with the development of Java applicati
|
|||
|
||||
Next, import the Java SDK packages to get started. Select your preferred build tool to learn how to import.
|
||||
|
||||
{{< tabs Maven Gradle >}}
|
||||
{{< tabpane text=true >}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="Maven" %}}
|
||||
<!--Maven-->
|
||||
|
||||
For a Maven project, add the following to your `pom.xml` file:
|
||||
|
|
@ -65,9 +65,9 @@ For a Maven project, add the following to your `pom.xml` file:
|
|||
...
|
||||
</project>
|
||||
```
|
||||
{{% /codetab %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="Gradle" %}}
|
||||
<!--Gradle-->
|
||||
|
||||
For a Gradle project, add the following to your `build.gradle` file:
|
||||
|
|
@ -84,9 +84,9 @@ dependencies {
|
|||
}
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
{{< /tabpane >}}
|
||||
|
||||
If you are also using Spring Boot, you may run into a common issue where the `OkHttp` version that the Dapr SDK uses conflicts with the one specified in the Spring Boot _Bill of Materials_.
|
||||
|
||||
|
|
@ -106,7 +106,7 @@ Put the Dapr Java SDK to the test. Walk through the Java quickstarts and tutoria
|
|||
|
||||
| SDK samples | Description |
|
||||
| ----------- | ----------- |
|
||||
| [Quickstarts]({{< ref quickstarts >}}) | Experience Dapr's API building blocks in just a few minutes using the Java SDK. |
|
||||
| [Quickstarts]({{% ref quickstarts %}}) | Experience Dapr's API building blocks in just a few minutes using the Java SDK. |
|
||||
| [SDK samples](https://github.com/dapr/java-sdk/tree/master/examples) | Clone the SDK repo to try out some examples and get started. |
|
||||
|
||||
```java
|
||||
|
|
@ -122,7 +122,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full guide on output bindings visit [How-To: Output bindings]({{< ref howto-bindings.md >}}).
|
||||
- For a full guide on output bindings visit [How-To: Output bindings]({{% ref howto-bindings.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/bindings/http) for code samples and instructions to try out output bindings.
|
||||
|
||||
## Available packages
|
||||
|
|
@ -132,14 +132,14 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
|
|||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Client</b></h5>
|
||||
<p class="card-text">Create Java clients that interact with a Dapr sidecar and other Dapr applications.</p>
|
||||
<a href="{{< ref java-client >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref java-client %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Workflow</b></h5>
|
||||
<p class="card-text">Create and manage workflows that work with other Dapr APIs in Java.</p>
|
||||
<a href="{{< ref workflow >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref workflow %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@ type: docs
|
|||
title: "AI"
|
||||
linkTitle: "AI"
|
||||
weight: 3000
|
||||
description: With the Dapr Conversation AI package, you can interact with the Dapr AI workloads from a Java application. To get started, walk through the [Dapr AI]({{< ref java-ai-howto.md >}}) how-to guide.
|
||||
description: With the Dapr Conversation AI package, you can interact with the Dapr AI workloads from a Java application. To get started, walk through the [Dapr AI]({{% ref java-ai-howto.md %}}) how-to guide.
|
||||
---
|
||||
|
|
@ -101,5 +101,5 @@ component for testing, which simply returns the input message.
|
|||
When integrated with LLMs like OpenAI or Claude, you’ll receive meaningful responses instead of echoed input.
|
||||
|
||||
## Next steps
|
||||
- [Learn more about Conversation AI]({{< ref conversation-overview.md >}})
|
||||
- [Conversation AI API reference]({{< ref conversation_api.md >}})
|
||||
- [Learn more about Conversation AI]({{% ref conversation-overview.md %}})
|
||||
- [Conversation AI API reference]({{% ref conversation_api.md %}})
|
||||
|
|
@ -9,13 +9,13 @@ description: How to get up and running with the Dapr Java SDK
|
|||
The Dapr client package allows you to interact with other Dapr applications from a Java application.
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
If you haven't already, [try out one of the quickstarts]({{< ref quickstarts >}}) for a quick walk-through on how to use the Dapr Java SDK with an API building block.
|
||||
If you haven't already, [try out one of the quickstarts]({{% ref quickstarts %}}) for a quick walk-through on how to use the Dapr Java SDK with an API building block.
|
||||
|
||||
{{% /alert %}}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
[Complete initial setup and import the Java SDK into your project]({{< ref java >}})
|
||||
[Complete initial setup and import the Java SDK into your project]({{% ref java %}})
|
||||
|
||||
## Initializing the client
|
||||
You can initialize a Dapr client as so:
|
||||
|
|
@ -24,7 +24,7 @@ You can initialize a Dapr client as so:
|
|||
DaprClient client = new DaprClientBuilder().build()
|
||||
```
|
||||
|
||||
This will connect to the default Dapr gRPC endpoint `localhost:50001`. For information about configuring the client using environment variables and system properties, see [Properties]({{< ref properties.md >}}).
|
||||
This will connect to the default Dapr gRPC endpoint `localhost:50001`. For information about configuring the client using environment variables and system properties, see [Properties]({{% ref properties.md %}}).
|
||||
|
||||
#### Error Handling
|
||||
|
||||
|
|
@ -52,7 +52,7 @@ Example of handling the DaprException and consuming the error details when using
|
|||
|
||||
## Building blocks
|
||||
|
||||
The Java SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}).
|
||||
The Java SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}).
|
||||
|
||||
### Invoke a service
|
||||
|
||||
|
|
@ -76,7 +76,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full guide on service invocation visit [How-To: Invoke a service]({{< ref howto-invoke-discover-services.md >}}).
|
||||
- For a full guide on service invocation visit [How-To: Invoke a service]({{% ref howto-invoke-discover-services.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/invoke) for code samples and instructions to try out service invocation
|
||||
|
||||
### Save & get application state
|
||||
|
|
@ -99,7 +99,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full list of state operations visit [How-To: Get & save state]({{< ref howto-get-save-state.md >}}).
|
||||
- For a full list of state operations visit [How-To: Get & save state]({{% ref howto-get-save-state.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/state) for code samples and instructions to try out state management
|
||||
|
||||
### Publish & subscribe to messages
|
||||
|
|
@ -225,7 +225,7 @@ class Solution {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full guide on publishing messages and subscribing to a topic [How-To: Publish & subscribe]({{< ref howto-publish-subscribe.md >}}).
|
||||
- For a full guide on publishing messages and subscribing to a topic [How-To: Publish & subscribe]({{% ref howto-publish-subscribe.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/pubsub/http) for code samples and instructions to try out pub/sub
|
||||
|
||||
### Interact with output bindings
|
||||
|
|
@ -243,7 +243,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full guide on output bindings visit [How-To: Output bindings]({{< ref howto-bindings.md >}}).
|
||||
- For a full guide on output bindings visit [How-To: Output bindings]({{% ref howto-bindings.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/bindings/http) for code samples and instructions to try out output bindings.
|
||||
|
||||
### Interact with input bindings
|
||||
|
|
@ -265,7 +265,7 @@ public class myClass {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full guide on input bindings, visit [How-To: Input bindings]({{< ref howto-triggers >}}).
|
||||
- For a full guide on input bindings, visit [How-To: Input bindings]({{% ref howto-triggers %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/bindings/http) for code samples and instructions to try out input bindings.
|
||||
|
||||
### Retrieve secrets
|
||||
|
|
@ -282,7 +282,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full guide on secrets visit [How-To: Retrieve secrets]({{< ref howto-secrets.md >}}).
|
||||
- For a full guide on secrets visit [How-To: Retrieve secrets]({{% ref howto-secrets.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/secrets) for code samples and instructions to try out retrieving secrets
|
||||
|
||||
### Actors
|
||||
|
|
@ -308,7 +308,7 @@ public interface DemoActor {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full guide on actors visit [How-To: Use virtual actors in Dapr]({{< ref howto-actors.md >}}).
|
||||
- For a full guide on actors visit [How-To: Use virtual actors in Dapr]({{% ref howto-actors.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/actors) for code samples and instructions to try actors
|
||||
|
||||
### Get & Subscribe to application configurations
|
||||
|
|
@ -341,7 +341,7 @@ try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient())
|
|||
}
|
||||
```
|
||||
|
||||
- For a full list of configuration operations visit [How-To: Manage configuration from a store]({{< ref howto-manage-configuration.md >}}).
|
||||
- For a full list of configuration operations visit [How-To: Manage configuration from a store]({{% ref howto-manage-configuration.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/configuration) for code samples and instructions to try out different configuration operations.
|
||||
|
||||
### Query saved state
|
||||
|
|
@ -411,7 +411,7 @@ try (DaprClient client = builder.build(); DaprPreviewClient previewClient = buil
|
|||
}
|
||||
}
|
||||
```
|
||||
- For a full how-to on query state, visit [How-To: Query state]({{< ref howto-state-query-api.md >}}).
|
||||
- For a full how-to on query state, visit [How-To: Query state]({{% ref howto-state-query-api.md %}}).
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/querystate) for complete code sample.
|
||||
|
||||
### Distributed lock
|
||||
|
|
@ -477,7 +477,7 @@ public class DistributedLockGrpcClient {
|
|||
}
|
||||
```
|
||||
|
||||
- For a full how-to on distributed lock, visit [How-To: Use a Lock]({{< ref howto-use-distributed-lock.md >}})
|
||||
- For a full how-to on distributed lock, visit [How-To: Use a Lock]({{% ref howto-use-distributed-lock.md %}})
|
||||
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/lock) for complete code sample.
|
||||
|
||||
### Workflow
|
||||
|
|
@ -598,9 +598,9 @@ public class DemoWorkflowClient {
|
|||
```
|
||||
|
||||
- For a full guide on workflows, visit:
|
||||
- [How-To: Author workflows]({{< ref howto-author-workflow.md >}}).
|
||||
- [How-To: Manage workflows]({{< ref howto-manage-workflow.md >}}).
|
||||
- [Learn more about how to use workflows with the Java SDK]({{< ref java-workflow.md >}}).
|
||||
- [How-To: Author workflows]({{% ref howto-author-workflow.md %}}).
|
||||
- [How-To: Manage workflows]({{% ref howto-manage-workflow.md %}}).
|
||||
- [Learn more about how to use workflows with the Java SDK]({{% ref java-workflow.md %}}).
|
||||
|
||||
## Sidecar APIs
|
||||
|
||||
|
|
@ -635,4 +635,4 @@ Learn more about the [Dapr Java SDK packages available to add to your Java appli
|
|||
## Related links
|
||||
- [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples)
|
||||
|
||||
For a full list of SDK properties and how to configure them, visit [Properties]({{< ref properties.md >}}).
|
||||
For a full list of SDK properties and how to configure them, visit [Properties]({{% ref properties.md %}}).
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@ type: docs
|
|||
title: "Jobs"
|
||||
linkTitle: "Jobs"
|
||||
weight: 3000
|
||||
description: With the Dapr Jobs package, you can interact with the Dapr Jobs APIs from a Java application to trigger future operations to run according to a predefined schedule with an optional payload. To get started, walk through the [Dapr Jobs]({{< ref java-jobs-howto.md >}}) how-to guide.
|
||||
description: With the Dapr Jobs package, you can interact with the Dapr Jobs APIs from a Java application to trigger future operations to run according to a predefined schedule with an optional payload. To get started, walk through the [Dapr Jobs]({{% ref java-jobs-howto.md %}}) how-to guide.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -160,5 +160,5 @@ public class DemoJobsClient {
|
|||
```
|
||||
|
||||
## Next steps
|
||||
- [Learn more about Jobs]({{< ref jobs-overview.md >}})
|
||||
- [Jobs API reference]({{< ref jobs_api.md >}})
|
||||
- [Learn more about Jobs]({{% ref jobs-overview.md %}})
|
||||
- [Jobs API reference]({{% ref jobs_api.md %}})
|
||||
|
|
@ -245,5 +245,5 @@ Exiting DemoWorkflowClient.
|
|||
1. The worfklow client is then exited.
|
||||
|
||||
## Next steps
|
||||
- [Learn more about Dapr workflow]({{< ref workflow-overview.md >}})
|
||||
- [Workflow API reference]({{< ref workflow_api.md >}})
|
||||
- [Learn more about Dapr workflow]({{% ref workflow-overview.md %}})
|
||||
- [Workflow API reference]({{% ref workflow_api.md %}})
|
||||
|
|
@ -122,7 +122,7 @@ Besides the previous configuration (`DaprTestContainersConfig`) your tests shoul
|
|||
|
||||
## Leveraging Spring & Spring Boot programming model with Dapr
|
||||
|
||||
The Java SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}).
|
||||
The Java SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}).
|
||||
But if you want to leverage the Spring and Spring Boot programming model you can use the `dapr-spring-boot-starter` integration.
|
||||
This includes implementations of Spring Data (`KeyValueTemplate` and `CrudRepository`) as well as a `DaprMessagingTemplate` for producing and consuming messages
|
||||
(similar to [Spring Kafka](https://spring.io/projects/spring-kafka), [Spring Pulsar](https://spring.io/projects/spring-pulsar) and [Spring AMQP for RabbitMQ](https://spring.io/projects/spring-amqp)) and Dapr workflows.
|
||||
|
|
|
|||
Loading…
Reference in New Issue