Skip to content

Commit 26b3527

Browse files
authored
Update daprdocs markdown files to be compatible with latest Hugo (#709)
Signed-off-by: Marc Duiker <[email protected]>
1 parent ac75d61 commit 26b3527

File tree

7 files changed

+31
-31
lines changed

7 files changed

+31
-31
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,12 +119,12 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
119119
120120
The `examples` directory contains code samples for users to run to try out specific functionality of the various JavaScript SDK packages and extensions. When writing new and updated samples keep in mind:
121121
122-
- All examples should be runnable on Windows, Linux, and MacOS. While JavaScript code is consistent among operating systems, any pre/post example commands should provide options through [codetabs]({{< ref "contributing-docs.md#tabbed-content" >}}).
122+
- All examples should be runnable on Windows, Linux, and MacOS. While JavaScript code is consistent among operating systems, any pre/post example commands should provide options through [tabpane]({{% ref "contributing-docs.md#tabbed-content" %}}).
123123
- 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.
124124
125125
## Docs
126126
127127
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:
128128
129-
- All rules in the [docs guide]({{< ref contributing-docs.md >}}) should be followed in addition to these.
129+
- All rules in the [docs guide]({{% ref contributing-docs.md %}}) should be followed in addition to these.
130130
- All files and directories should be prefixed with `js-` to ensure all file/directory names are globally unique across all Dapr documentation.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,21 @@ To help you get started, check out the resources below:
4747
<div class="card-body">
4848
<h5 class="card-title"><b>Client</b></h5>
4949
<p class="card-text">Create a JavaScript client and interact with the Dapr sidecar and other Dapr applications (e.g., publishing events, output binding support, etc.). </p>
50-
<a href="{{< ref js-client >}}" class="stretched-link"></a>
50+
<a href="{{% ref js-client %}}" class="stretched-link"></a>
5151
</div>
5252
</div>
5353
<div class="card">
5454
<div class="card-body">
5555
<h5 class="card-title"><b>Server</b></h5>
5656
<p class="card-text">Create a JavaScript server and let the Dapr sidecar interact with your application (e.g., subscribing to events, input binding support, etc.). </p>
57-
<a href="{{< ref js-server >}}" class="stretched-link"></a>
57+
<a href="{{% ref js-server %}}" class="stretched-link"></a>
5858
</div>
5959
</div>
6060
<div class="card">
6161
<div class="card-body">
6262
<h5 class="card-title"><b>Actors</b></h5>
6363
<p class="card-text">Create virtual actors with state, reminders/timers, and methods.</p>
64-
<a href="{{< ref js-actors >}}" class="stretched-link"></a>
64+
<a href="{{% ref js-actors %}}" class="stretched-link"></a>
6565
</div>
6666
</div>
6767
</div>
@@ -71,14 +71,14 @@ To help you get started, check out the resources below:
7171
<div class="card-body">
7272
<h5 class="card-title"><b>Logging</b></h5>
7373
<p class="card-text">Configure and customize the SDK logging.</p>
74-
<a href="{{< ref js-logger >}}" class="stretched-link"></a>
74+
<a href="{{% ref js-logger %}}" class="stretched-link"></a>
7575
</div>
7676
</div>
7777
<div class="card">
7878
<div class="card-body">
7979
<h5 class="card-title"><b>Examples</b></h5>
8080
<p class="card-text">Clone the JavaScript SDK source code and try out some of the examples to get started quickly.</p>
81-
<a href="{{< ref js-examples >}}" class="stretched-link"></a>
81+
<a href="{{% ref js-examples %}}" class="stretched-link"></a>
8282
</div>
8383
</div>
8484
</div>

daprdocs/content/en/js-sdk-docs/js-actors/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ description: How to get up and running with Actors using the Dapr JavaScript SDK
88

99
The Dapr actors package allows you to interact with Dapr virtual actors from a JavaScript application. The examples below demonstrate how to use the JavaScript SDK for interacting with virtual actors.
1010

11-
For a more in-depth overview of Dapr actors, visit the [actors overview page]({{< ref actors-overview >}}).
11+
For a more in-depth overview of Dapr actors, visit the [actors overview page]({{% ref actors-overview %}}).
1212

1313
## Pre-requisites
1414

15-
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
16-
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
15+
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
16+
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
1717
- [Latest LTS version of Node or greater](https://nodejs.org/en/)
1818
- [JavaScript NPM package installed](https://www.npmjs.com/package/@dapr/dapr)
1919

@@ -195,7 +195,7 @@ The JS SDK supports actors that can schedule periodic work on themselves by regi
195195

196196
This distinction allows users to trade off between light-weight but stateless timers versus more resource-demanding but stateful reminders.
197197

198-
The scheduling interface of timers and reminders is identical. For an more in-depth look at the scheduling configurations see the [actors timers and reminders docs]({{< ref "howto-actors.md#actor-timers-and-reminders" >}}).
198+
The scheduling interface of timers and reminders is identical. For an more in-depth look at the scheduling configurations see the [actors timers and reminders docs]({{% ref "howto-actors.md#actor-timers-and-reminders" %}}).
199199

200200
### Actor Timers
201201

@@ -255,4 +255,4 @@ export default class ParkingSensorImpl extends AbstractActor implements ParkingS
255255
}
256256
```
257257

258-
For a full guide on actors, visit [How-To: Use virtual actors in Dapr]({{< ref howto-actors.md >}}).
258+
For a full guide on actors, visit [How-To: Use virtual actors in Dapr]({{% ref howto-actors.md %}}).

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ The Dapr Client allows you to communicate with the Dapr Sidecar and get access t
1212

1313
## Pre-requisites
1414

15-
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
16-
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
15+
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
16+
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
1717
- [Latest LTS version of Node.js or greater](https://nodejs.org/en/)
1818

1919
## Installing and importing Dapr's JS SDK
@@ -154,7 +154,7 @@ We can now call the methods as defined in our `GreeterClient` interface (which i
154154

155155
## Building blocks
156156

157-
The JavaScript Client SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}) focusing on Client to Sidecar features.
157+
The JavaScript Client SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}) focusing on Client to Sidecar features.
158158

159159
### Invocation API
160160

@@ -194,7 +194,7 @@ start().catch((e) => {
194194
});
195195
```
196196

197-
> For a full guide on service invocation visit [How-To: Invoke a service]({{< ref howto-invoke-discover-services.md >}}).
197+
> For a full guide on service invocation visit [How-To: Invoke a service]({{% ref howto-invoke-discover-services.md %}}).
198198
199199
### State Management API
200200

@@ -267,7 +267,7 @@ start().catch((e) => {
267267
});
268268
```
269269

270-
> For a full list of state operations visit [How-To: Get & save state]({{< ref howto-get-save-state.md >}}).
270+
> For a full list of state operations visit [How-To: Get & save state]({{% ref howto-get-save-state.md %}}).
271271
272272
#### Query State API
273273

@@ -423,7 +423,7 @@ start().catch((e) => {
423423
});
424424
```
425425

426-
> For a full guide on output bindings visit [How-To: Use bindings]({{< ref howto-bindings.md >}}).
426+
> For a full guide on output bindings visit [How-To: Use bindings]({{% ref howto-bindings.md %}}).
427427
428428
### Secret API
429429

@@ -454,7 +454,7 @@ start().catch((e) => {
454454
});
455455
```
456456

457-
> For a full guide on secrets visit [How-To: Retrieve secrets]({{< ref howto-secrets.md >}}).
457+
> For a full guide on secrets visit [How-To: Retrieve secrets]({{% ref howto-secrets.md %}}).
458458
459459
### Configuration API
460460

@@ -622,7 +622,7 @@ start().catch((e) => {
622622
});
623623
```
624624

625-
> For a full guide on cryptography visit [How-To: Cryptography]({{< ref howto-cryptography.md >}}).
625+
> For a full guide on cryptography visit [How-To: Cryptography]({{% ref howto-cryptography.md %}}).
626626
627627
### Distributed Lock API
628628

@@ -671,7 +671,7 @@ start().catch((e) => {
671671
});
672672
```
673673

674-
> For a full guide on distributed locks visit [How-To: Use Distributed Locks]({{< ref howto-use-distributed-lock.md >}}).
674+
> For a full guide on distributed locks visit [How-To: Use Distributed Locks]({{% ref howto-use-distributed-lock.md %}}).
675675
676676
### Workflow API
677677

daprdocs/content/en/js-sdk-docs/js-logger/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const client = new DaprClient({
2828
});
2929
```
3030

31-
> For more details on how to use the Client, see [JavaScript Client]({{< ref js-client >}}).
31+
> For more details on how to use the Client, see [JavaScript Client]({{% ref js-client %}}).
3232
3333
### DaprServer
3434

@@ -47,7 +47,7 @@ const server = new DaprServer({
4747
});
4848
```
4949

50-
> For more details on how to use the Server, see [JavaScript Server]({{< ref js-server >}}).
50+
> For more details on how to use the Server, see [JavaScript Server]({{% ref js-server %}}).
5151
5252
## Custom LoggerService
5353

daprdocs/content/en/js-sdk-docs/js-server/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ The Dapr Server will allow you to receive communication from the Dapr Sidecar an
1212

1313
## Pre-requisites
1414

15-
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
16-
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
15+
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
16+
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
1717
- [Latest LTS version of Node or greater](https://nodejs.org/en/)
1818

1919
## Installing and importing Dapr's JS SDK
@@ -162,7 +162,7 @@ npm run start:dapr-grpc
162162
163163
## Building blocks
164164

165-
The JavaScript Server SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}) focusing on Sidecar to App features.
165+
The JavaScript Server SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}) focusing on Sidecar to App features.
166166

167167
### Invocation API
168168

@@ -206,7 +206,7 @@ start().catch((e) => {
206206
});
207207
```
208208

209-
> For a full guide on service invocation visit [How-To: Invoke a service]({{< ref howto-invoke-discover-services.md >}}).
209+
> For a full guide on service invocation visit [How-To: Invoke a service]({{% ref howto-invoke-discover-services.md %}}).
210210
211211
### PubSub API
212212

@@ -269,7 +269,7 @@ async function start() {
269269
}
270270
```
271271

272-
> For a full list of state operations visit [How-To: Publish & subscribe]({{< ref howto-publish-subscribe.md >}}).
272+
> For a full list of state operations visit [How-To: Publish & subscribe]({{% ref howto-publish-subscribe.md %}}).
273273
274274
#### Subscribe with SUCCESS/RETRY/DROP status
275275

@@ -599,7 +599,7 @@ start().catch((e) => {
599599
});
600600
```
601601

602-
> For a full guide on output bindings visit [How-To: Use bindings]({{< ref howto-bindings.md >}}).
602+
> For a full guide on output bindings visit [How-To: Use bindings]({{% ref howto-bindings.md %}}).
603603
604604
### Configuration API
605605

daprdocs/content/en/js-sdk-docs/js-workflow/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,5 +154,5 @@ INFO[0006] dc040bea-6436-4051-9166-c9294f9d2201: 'sequence' completed with a COM
154154

155155
## Next steps
156156

157-
- [Learn more about Dapr workflow]({{< ref workflow-overview.md >}})
158-
- [Workflow API reference]({{< ref workflow_api.md >}})
157+
- [Learn more about Dapr workflow]({{% ref workflow-overview.md %}})
158+
- [Workflow API reference]({{% ref workflow_api.md %}})

0 commit comments

Comments
 (0)