Skip to content

Commit cfb9067

Browse files
marcduikercicoyle
andauthored
Update dapr docs for Hugo upgrade (dapr#1443)
Signed-off-by: Marc Duiker <[email protected]> Co-authored-by: Cassie Coyle <[email protected]>
1 parent bbec093 commit cfb9067

File tree

9 files changed

+41
-41
lines changed

9 files changed

+41
-41
lines changed

daprdocs/content/en/java-sdk-contributing/java-contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ When contributing to the [Java SDK](https://github.com/dapr/java-sdk) the follow
1212

1313
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:
1414

15-
- 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" >}})
15+
- 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" %}})
1616
- 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.
1717

1818
## Docs
1919

2020
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:
2121

22-
- All rules in the [docs guide]({{< ref contributing-docs.md >}}) should be followed in addition to these.
22+
- All rules in the [docs guide]({{% ref contributing-docs.md %}}) should be followed in addition to these.
2323
- All files and directories should be prefixed with `java-` to ensure all file/directory names are globally unique across all Dapr documentation.
2424

2525
## Github Dapr Bot Commands

daprdocs/content/en/java-sdk-docs/_index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Dapr offers a variety of packages to help with the development of Java applicati
1515

1616
## Prerequisites
1717

18-
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
19-
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
18+
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
19+
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
2020
- JDK 11 or above - the published jars are compatible with Java 8:
2121
- [AdoptOpenJDK 11 - LTS](https://adoptopenjdk.net/)
2222
- [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
3030

3131
Next, import the Java SDK packages to get started. Select your preferred build tool to learn how to import.
3232

33-
{{< tabs Maven Gradle >}}
33+
{{< tabpane text=true >}}
3434

35-
{{% codetab %}}
35+
{{% tab header="Maven" %}}
3636
<!--Maven-->
3737

3838
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:
6565
...
6666
</project>
6767
```
68-
{{% /codetab %}}
68+
{{% /tab %}}
6969

70-
{{% codetab %}}
70+
{{% tab header="Gradle" %}}
7171
<!--Gradle-->
7272

7373
For a Gradle project, add the following to your `build.gradle` file:
@@ -84,9 +84,9 @@ dependencies {
8484
}
8585
```
8686

87-
{{% /codetab %}}
87+
{{% /tab %}}
8888

89-
{{< /tabs >}}
89+
{{< /tabpane >}}
9090

9191
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_.
9292

@@ -106,7 +106,7 @@ Put the Dapr Java SDK to the test. Walk through the Java quickstarts and tutoria
106106

107107
| SDK samples | Description |
108108
| ----------- | ----------- |
109-
| [Quickstarts]({{< ref quickstarts >}}) | Experience Dapr's API building blocks in just a few minutes using the Java SDK. |
109+
| [Quickstarts]({{% ref quickstarts %}}) | Experience Dapr's API building blocks in just a few minutes using the Java SDK. |
110110
| [SDK samples](https://github.com/dapr/java-sdk/tree/master/examples) | Clone the SDK repo to try out some examples and get started. |
111111

112112
```java
@@ -122,7 +122,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
122122
}
123123
```
124124

125-
- For a full guide on output bindings visit [How-To: Output bindings]({{< ref howto-bindings.md >}}).
125+
- For a full guide on output bindings visit [How-To: Output bindings]({{% ref howto-bindings.md %}}).
126126
- 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.
127127

128128
## Available packages
@@ -132,14 +132,14 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
132132
<div class="card-body">
133133
<h5 class="card-title"><b>Client</b></h5>
134134
<p class="card-text">Create Java clients that interact with a Dapr sidecar and other Dapr applications.</p>
135-
<a href="{{< ref java-client >}}" class="stretched-link"></a>
135+
<a href="{{% ref java-client %}}" class="stretched-link"></a>
136136
</div>
137137
</div>
138138
<div class="card">
139139
<div class="card-body">
140140
<h5 class="card-title"><b>Workflow</b></h5>
141141
<p class="card-text">Create and manage workflows that work with other Dapr APIs in Java.</p>
142-
<a href="{{< ref workflow >}}" class="stretched-link"></a>
142+
<a href="{{% ref workflow %}}" class="stretched-link"></a>
143143
</div>
144144
</div>
145145
</div>

daprdocs/content/en/java-sdk-docs/java-ai/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ type: docs
33
title: "AI"
44
linkTitle: "AI"
55
weight: 3000
6-
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.
6+
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.
77
---

daprdocs/content/en/java-sdk-docs/java-ai/java-ai-howto.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,5 @@ component for testing, which simply returns the input message.
101101
When integrated with LLMs like OpenAI or Claude, you’ll receive meaningful responses instead of echoed input.
102102

103103
## Next steps
104-
- [Learn more about Conversation AI]({{< ref conversation-overview.md >}})
105-
- [Conversation AI API reference]({{< ref conversation_api.md >}})
104+
- [Learn more about Conversation AI]({{% ref conversation-overview.md %}})
105+
- [Conversation AI API reference]({{% ref conversation_api.md %}})

daprdocs/content/en/java-sdk-docs/java-client/_index.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ description: How to get up and running with the Dapr Java SDK
99
The Dapr client package allows you to interact with other Dapr applications from a Java application.
1010

1111
{{% alert title="Note" color="primary" %}}
12-
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.
12+
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.
1313

1414
{{% /alert %}}
1515

1616
## Prerequisites
1717

18-
[Complete initial setup and import the Java SDK into your project]({{< ref java >}})
18+
[Complete initial setup and import the Java SDK into your project]({{% ref java %}})
1919

2020
## Initializing the client
2121
You can initialize a Dapr client as so:
@@ -24,7 +24,7 @@ You can initialize a Dapr client as so:
2424
DaprClient client = new DaprClientBuilder().build()
2525
```
2626

27-
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 >}}).
27+
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 %}}).
2828

2929
#### Error Handling
3030

@@ -52,7 +52,7 @@ Example of handling the DaprException and consuming the error details when using
5252

5353
## Building blocks
5454

55-
The Java SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}).
55+
The Java SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}).
5656

5757
### Invoke a service
5858

@@ -76,7 +76,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
7676
}
7777
```
7878

79-
- For a full guide on service invocation visit [How-To: Invoke a service]({{< ref howto-invoke-discover-services.md >}}).
79+
- For a full guide on service invocation visit [How-To: Invoke a service]({{% ref howto-invoke-discover-services.md %}}).
8080
- 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
8181

8282
### Save & get application state
@@ -99,7 +99,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
9999
}
100100
```
101101

102-
- For a full list of state operations visit [How-To: Get & save state]({{< ref howto-get-save-state.md >}}).
102+
- For a full list of state operations visit [How-To: Get & save state]({{% ref howto-get-save-state.md %}}).
103103
- 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
104104

105105
### Publish & subscribe to messages
@@ -225,7 +225,7 @@ class Solution {
225225
}
226226
```
227227

228-
- For a full guide on publishing messages and subscribing to a topic [How-To: Publish & subscribe]({{< ref howto-publish-subscribe.md >}}).
228+
- For a full guide on publishing messages and subscribing to a topic [How-To: Publish & subscribe]({{% ref howto-publish-subscribe.md %}}).
229229
- 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
230230

231231
### Interact with output bindings
@@ -243,7 +243,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
243243
}
244244
```
245245

246-
- For a full guide on output bindings visit [How-To: Output bindings]({{< ref howto-bindings.md >}}).
246+
- For a full guide on output bindings visit [How-To: Output bindings]({{% ref howto-bindings.md %}}).
247247
- 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.
248248

249249
### Interact with input bindings
@@ -265,7 +265,7 @@ public class myClass {
265265
}
266266
```
267267

268-
- For a full guide on input bindings, visit [How-To: Input bindings]({{< ref howto-triggers >}}).
268+
- For a full guide on input bindings, visit [How-To: Input bindings]({{% ref howto-triggers %}}).
269269
- 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.
270270

271271
### Retrieve secrets
@@ -282,7 +282,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {
282282
}
283283
```
284284

285-
- For a full guide on secrets visit [How-To: Retrieve secrets]({{< ref howto-secrets.md >}}).
285+
- For a full guide on secrets visit [How-To: Retrieve secrets]({{% ref howto-secrets.md %}}).
286286
- 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
287287

288288
### Actors
@@ -308,7 +308,7 @@ public interface DemoActor {
308308
}
309309
```
310310

311-
- For a full guide on actors visit [How-To: Use virtual actors in Dapr]({{< ref howto-actors.md >}}).
311+
- For a full guide on actors visit [How-To: Use virtual actors in Dapr]({{% ref howto-actors.md %}}).
312312
- 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
313313

314314
### Get & Subscribe to application configurations
@@ -341,7 +341,7 @@ try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient())
341341
}
342342
```
343343

344-
- For a full list of configuration operations visit [How-To: Manage configuration from a store]({{< ref howto-manage-configuration.md >}}).
344+
- For a full list of configuration operations visit [How-To: Manage configuration from a store]({{% ref howto-manage-configuration.md %}}).
345345
- 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.
346346

347347
### Query saved state
@@ -411,7 +411,7 @@ try (DaprClient client = builder.build(); DaprPreviewClient previewClient = buil
411411
}
412412
}
413413
```
414-
- For a full how-to on query state, visit [How-To: Query state]({{< ref howto-state-query-api.md >}}).
414+
- For a full how-to on query state, visit [How-To: Query state]({{% ref howto-state-query-api.md %}}).
415415
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/querystate) for complete code sample.
416416

417417
### Distributed lock
@@ -477,7 +477,7 @@ public class DistributedLockGrpcClient {
477477
}
478478
```
479479

480-
- For a full how-to on distributed lock, visit [How-To: Use a Lock]({{< ref howto-use-distributed-lock.md >}})
480+
- For a full how-to on distributed lock, visit [How-To: Use a Lock]({{% ref howto-use-distributed-lock.md %}})
481481
- Visit [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/lock) for complete code sample.
482482

483483
### Workflow
@@ -598,9 +598,9 @@ public class DemoWorkflowClient {
598598
```
599599

600600
- For a full guide on workflows, visit:
601-
- [How-To: Author workflows]({{< ref howto-author-workflow.md >}}).
602-
- [How-To: Manage workflows]({{< ref howto-manage-workflow.md >}}).
603-
- [Learn more about how to use workflows with the Java SDK]({{< ref java-workflow.md >}}).
601+
- [How-To: Author workflows]({{% ref howto-author-workflow.md %}}).
602+
- [How-To: Manage workflows]({{% ref howto-manage-workflow.md %}}).
603+
- [Learn more about how to use workflows with the Java SDK]({{% ref java-workflow.md %}}).
604604

605605
## Sidecar APIs
606606

@@ -635,4 +635,4 @@ Learn more about the [Dapr Java SDK packages available to add to your Java appli
635635
## Related links
636636
- [Java SDK examples](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples)
637637

638-
For a full list of SDK properties and how to configure them, visit [Properties]({{< ref properties.md >}}).
638+
For a full list of SDK properties and how to configure them, visit [Properties]({{% ref properties.md %}}).

daprdocs/content/en/java-sdk-docs/java-jobs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ type: docs
33
title: "Jobs"
44
linkTitle: "Jobs"
55
weight: 3000
6-
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.
6+
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.
77
---

daprdocs/content/en/java-sdk-docs/java-jobs/java-jobs-howto.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,5 @@ public class DemoJobsClient {
160160
```
161161

162162
## Next steps
163-
- [Learn more about Jobs]({{< ref jobs-overview.md >}})
164-
- [Jobs API reference]({{< ref jobs_api.md >}})
163+
- [Learn more about Jobs]({{% ref jobs-overview.md %}})
164+
- [Jobs API reference]({{% ref jobs_api.md %}})

daprdocs/content/en/java-sdk-docs/java-workflow/java-workflow-howto.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,5 +245,5 @@ Exiting DemoWorkflowClient.
245245
1. The worfklow client is then exited.
246246

247247
## Next steps
248-
- [Learn more about Dapr workflow]({{< ref workflow-overview.md >}})
249-
- [Workflow API reference]({{< ref workflow_api.md >}})
248+
- [Learn more about Dapr workflow]({{% ref workflow-overview.md %}})
249+
- [Workflow API reference]({{% ref workflow_api.md %}})

daprdocs/content/en/java-sdk-docs/spring-boot/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Besides the previous configuration (`DaprTestContainersConfig`) your tests shoul
122122

123123
## Leveraging Spring & Spring Boot programming model with Dapr
124124

125-
The Java SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}).
125+
The Java SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}).
126126
But if you want to leverage the Spring and Spring Boot programming model you can use the `dapr-spring-boot-starter` integration.
127127
This includes implementations of Spring Data (`KeyValueTemplate` and `CrudRepository`) as well as a `DaprMessagingTemplate` for producing and consuming messages
128128
(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.

0 commit comments

Comments
 (0)