Skip to content

Commit b2f2988

Browse files
authored
Update daprdocs files to be compatible with latest Hugo version (#816)
Signed-off-by: Marc Duiker <[email protected]>
1 parent 22ed7b3 commit b2f2988

File tree

9 files changed

+71
-71
lines changed

9 files changed

+71
-71
lines changed

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

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

1313
The `examples` directory contains code samples for users to run to try out specific functionality of the various Python 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 Python 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 Python 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 `python-` to ensure all file/directory names are globally unique across all Dapr documentation.
2424

2525
## Github Dapr Bot Commands

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,34 @@ Dapr offers a variety of subpackages to help with the development of Python appl
1616

1717
## Prerequisites
1818

19-
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
20-
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
19+
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
20+
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
2121
- [Python 3.9+](https://www.python.org/downloads/) installed
2222

2323
## Installation
2424

2525
To get started with the Python SDK, install the main Dapr Python SDK package.
2626

27-
{{< tabs Stable Development>}}
27+
{{< tabpane text=true >}}
2828

29-
{{% codetab %}}
29+
{{% tab header="Stable" %}}
3030
<!--stable-->
3131
```bash
3232
pip install dapr
3333
```
34-
{{% /codetab %}}
34+
{{% /tab %}}
3535

36-
{{% codetab %}}
36+
{{% tab header="Development" %}}
3737
<!--dev-->
3838
> **Note:** The development package will contain features and behavior that will be compatible with the pre-release version of the Dapr runtime. Make sure to uninstall any stable versions of the Python SDK before installing the dapr-dev package.
3939
4040
```bash
4141
pip install dapr-dev
4242
```
4343

44-
{{% /codetab %}}
44+
{{% /tab %}}
4545

46-
{{< /tabs >}}
46+
{{< /tabpane >}}
4747

4848

4949
## Available subpackages
@@ -57,14 +57,14 @@ Python SDK imports are subpackages included with the main SDK install, but need
5757
<div class="card-body">
5858
<h5 class="card-title"><b>Client</b></h5>
5959
<p class="card-text">Write Python applications to interact with a Dapr sidecar and other Dapr applications, including stateful virtual actors in Python</p>
60-
<a href="{{< ref python-client >}}" class="stretched-link"></a>
60+
<a href="{{% ref python-client %}}" class="stretched-link"></a>
6161
</div>
6262
</div>
6363
<div class="card">
6464
<div class="card-body">
6565
<h5 class="card-title"><b>Actors</b></h5>
6666
<p class="card-text">Create and interact with Dapr's Actor framework.</p>
67-
<a href="{{< ref python-actor >}}" class="stretched-link"></a>
67+
<a href="{{% ref python-actor %}}" class="stretched-link"></a>
6868
</div>
6969
</div>
7070
</div>
@@ -80,28 +80,28 @@ SDK extensions mainly work as utilities for receiving pub/sub events, programati
8080
<div class="card-body">
8181
<h5 class="card-title"><b>gRPC</b></h5>
8282
<p class="card-text">Create Dapr services with the gRPC server extension.</p>
83-
<a href="{{< ref python-grpc >}}" class="stretched-link"></a>
83+
<a href="{{% ref python-grpc %}}" class="stretched-link"></a>
8484
</div>
8585
</div>
8686
<div class="card">
8787
<div class="card-body">
8888
<h5 class="card-title"><b>FastAPI</b></h5>
8989
<p class="card-text">Integrate with Dapr Python virtual actors and pub/sub using the Dapr FastAPI extension.</p>
90-
<a href="{{< ref python-fastapi >}}" class="stretched-link"></a>
90+
<a href="{{% ref python-fastapi %}}" class="stretched-link"></a>
9191
</div>
9292
</div>
9393
<div class="card">
9494
<div class="card-body">
9595
<h5 class="card-title"><b>Flask</b></h5>
9696
<p class="card-text">Integrate with Dapr Python virtual actors using the Dapr Flask extension.</p>
97-
<a href="{{< ref python-sdk-extensions >}}" class="stretched-link"></a>
97+
<a href="{{% ref python-sdk-extensions %}}" class="stretched-link"></a>
9898
</div>
9999
</div>
100100
<div class="card">
101101
<div class="card-body">
102102
<h5 class="card-title"><b>Workflow</b></h5>
103103
<p class="card-text">Author workflows that work with other Dapr APIs in Python.</p>
104-
<a href="{{< ref python-workflow >}}" class="stretched-link"></a>
104+
<a href="{{% ref python-workflow %}}" class="stretched-link"></a>
105105
</div>
106106
</div>
107107
</div>
@@ -120,7 +120,7 @@ Walk through the Python quickstarts, tutorials, and examples to see Dapr in acti
120120

121121
| SDK samples | Description |
122122
| ----------- | ----------- |
123-
| [Quickstarts]({{< ref quickstarts >}}) | Experience Dapr's API building blocks in just a few minutes using the Python SDK. |
123+
| [Quickstarts]({{% ref quickstarts %}}) | Experience Dapr's API building blocks in just a few minutes using the Python SDK. |
124124
| [SDK samples](https://github.com/dapr/python-sdk/tree/master/examples) | Clone the SDK repo to try out some examples and get started. |
125125
| [Bindings tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/bindings) | See how Dapr Python SDK works alongside other Dapr SDKs to enable bindings. |
126126
| [Distributed Calculator tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/distributed-calculator/python) | Use the Dapr Python SDK to handle method invocation and state persistent capabilities. |
@@ -137,7 +137,7 @@ Walk through the Python quickstarts, tutorials, and examples to see Dapr in acti
137137
<div class="card-body">
138138
<h5 class="card-title"><b>Serialization</b></h5>
139139
<p class="card-text">Learn more about serialization in Dapr SDKs.</p>
140-
<a href="{{< ref sdk-serialization >}}" class="stretched-link"></a>
140+
<a href="{{% ref sdk-serialization %}}" class="stretched-link"></a>
141141
</div>
142142
</div>
143143
<div class="card">

daprdocs/content/en/python-sdk-docs/python-actor.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ The Dapr actor package allows you to interact with Dapr virtual actors from a Py
1010

1111
## Pre-requisites
1212

13-
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
14-
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
13+
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
14+
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
1515
- [Python 3.9+](https://www.python.org/downloads/) installed
16-
- [Dapr Python package]({{< ref "python#installation" >}}) installed
16+
- [Dapr Python package]({{% ref "python#installation" %}}) installed
1717

1818
## Actor interface
1919

@@ -33,8 +33,8 @@ class DemoActorInterface(ActorInterface):
3333
An actor service hosts the virtual actor. It is implemented a class that derives from the base type `Actor` and implements the interfaces defined in the actor interface.
3434

3535
Actors can be created using one of the Dapr actor extensions:
36-
- [FastAPI actor extension]({{< ref python-fastapi.md >}})
37-
- [Flask actor extension]({{< ref python-flask.md >}})
36+
- [FastAPI actor extension]({{% ref python-fastapi.md %}})
37+
- [Flask actor extension]({{% ref python-flask.md %}})
3838

3939
## Actor client
4040

daprdocs/content/en/python-sdk-docs/python-client.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ description: How to get up and running with the Dapr Python SDK
99
The Dapr client package allows you to interact with other Dapr applications from a Python 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 Python 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 Python SDK with an API building block.
1313

1414
{{% /alert %}}
1515

1616
## Prerequisites
1717

18-
[Install the Dapr Python package]({{< ref "python#installation" >}}) before getting started.
18+
[Install the Dapr Python package]({{% ref "python#installation" %}}) before getting started.
1919

2020
## Import the client package
2121

@@ -140,7 +140,7 @@ except DaprGrpcError as err:
140140

141141
## Building blocks
142142

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

145145
### Invoke a service
146146

@@ -164,7 +164,7 @@ If this variable is not set, the endpoint value is derived from the `DAPR_RUNTIM
164164
The base endpoint for gRPC calls is the one used for the client initialisation ([explained above](#initialising-the-client)).
165165

166166

167-
- For a full guide on service invocation visit [How-To: Invoke a service]({{< ref howto-invoke-discover-services.md >}}).
167+
- For a full guide on service invocation visit [How-To: Invoke a service]({{% ref howto-invoke-discover-services.md %}}).
168168
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/master/examples/invoke-simple) for code samples and instructions to try out service invocation.
169169

170170
### Save & get application state
@@ -183,7 +183,7 @@ with DaprClient() as d:
183183
d.delete_state(store_name="statestore", key="key1")
184184
```
185185

186-
- For a full list of state operations visit [How-To: Get & save state]({{< ref howto-get-save-state.md >}}).
186+
- For a full list of state operations visit [How-To: Get & save state]({{% ref howto-get-save-state.md %}}).
187187
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/master/examples/state_store) for code samples and instructions to try out state management.
188188

189189
### Query application state (Alpha)
@@ -213,7 +213,7 @@ with DaprClient() as d:
213213
)
214214
```
215215

216-
- For a full list of state store query options visit [How-To: Query state]({{< ref howto-state-query-api.md >}}).
216+
- For a full list of state store query options visit [How-To: Query state]({{% ref howto-state-query-api.md %}}).
217217
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/master/examples/state_store_query) for code samples and instructions to try out state store querying.
218218

219219
### Publish & subscribe
@@ -302,7 +302,7 @@ def mytopic_important(event: v1.Event) -> None:
302302
' content_type="{event.content_type}"',flush=True)
303303
```
304304

305-
- For more information about pub/sub, visit [How-To: Publish & subscribe]({{< ref howto-publish-subscribe.md >}}).
305+
- For more information about pub/sub, visit [How-To: Publish & subscribe]({{% ref howto-publish-subscribe.md %}}).
306306
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/master/examples/pubsub-simple) for code samples and instructions to try out pub/sub.
307307

308308
#### Streaming message subscription
@@ -428,7 +428,7 @@ if __name__ == '__main__':
428428
main()
429429
```
430430

431-
- For more information about pub/sub, visit [How-To: Publish & subscribe]({{< ref howto-publish-subscribe.md >}}).
431+
- For more information about pub/sub, visit [How-To: Publish & subscribe]({{% ref howto-publish-subscribe.md %}}).
432432
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/main/examples/pubsub-simple) for code samples and instructions to try out streaming pub/sub.
433433

434434
### Conversation (Alpha)
@@ -437,7 +437,7 @@ if __name__ == '__main__':
437437
The Dapr Conversation API is currently in alpha.
438438
{{% /alert %}}
439439

440-
Since version 1.15 Dapr offers developers the capability to securely and reliably interact with Large Language Models (LLM) through the [Conversation API]({{< ref conversation-overview.md >}}).
440+
Since version 1.15 Dapr offers developers the capability to securely and reliably interact with Large Language Models (LLM) through the [Conversation API]({{% ref conversation-overview.md %}}).
441441

442442
```python
443443
from dapr.clients import DaprClient
@@ -472,7 +472,7 @@ with DaprClient() as d:
472472
resp = d.invoke_binding(binding_name='kafkaBinding', operation='create', data='{"message":"Hello World"}')
473473
```
474474

475-
- For a full guide on output bindings visit [How-To: Use bindings]({{< ref howto-bindings.md >}}).
475+
- For a full guide on output bindings visit [How-To: Use bindings]({{% ref howto-bindings.md %}}).
476476
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/main/examples/invoke-binding) for code samples and instructions to try out output bindings.
477477

478478
### Retrieve secrets
@@ -484,7 +484,7 @@ with DaprClient() as d:
484484
resp = d.get_secret(store_name='localsecretstore', key='secretKey')
485485
```
486486

487-
- For a full guide on secrets visit [How-To: Retrieve secrets]({{< ref howto-secrets.md >}}).
487+
- For a full guide on secrets visit [How-To: Retrieve secrets]({{% ref howto-secrets.md %}}).
488488
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/master/examples/secret_store) for code samples and instructions to try out retrieving secrets
489489

490490
### Configuration
@@ -529,7 +529,7 @@ async def executeConfiguration():
529529
asyncio.run(executeConfiguration())
530530
```
531531

532-
- Learn more about managing configurations via the [How-To: Manage configuration]({{< ref howto-manage-configuration.md >}}) guide.
532+
- Learn more about managing configurations via the [How-To: Manage configuration]({{% ref howto-manage-configuration.md %}}) guide.
533533
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/master/examples/configuration) for code samples and instructions to try out configuration.
534534

535535
### Distributed Lock
@@ -560,7 +560,7 @@ def main():
560560
print('We tried to unlock it anyway and got back [%s]' % unlock_result.status)
561561
```
562562

563-
- Learn more about using a distributed lock: [How-To: Use a lock]({{< ref howto-use-distributed-lock.md >}}).
563+
- Learn more about using a distributed lock: [How-To: Use a lock]({{% ref howto-use-distributed-lock.md %}}).
564564
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/blob/master/examples/distributed_lock) for code samples and instructions to try out distributed lock.
565565

566566
### Cryptography
@@ -594,7 +594,7 @@ def main():
594594
print(decrypt_bytes.decode()) # The secret is "passw0rd"
595595
```
596596

597-
- For a full list of state operations visit [How-To: Use the cryptography APIs]({{< ref howto-cryptography.md >}}).
597+
- For a full list of state operations visit [How-To: Use the cryptography APIs]({{% ref howto-cryptography.md %}}).
598598
- Visit [Python SDK examples](https://github.com/dapr/python-sdk/tree/master/examples/crypto) for code samples and instructions to try out cryptography
599599

600600
## Related links

daprdocs/content/en/python-sdk-docs/python-sdk-extensions/python-fastapi.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ The Dapr Python SDK provides integration with FastAPI using the `dapr-ext-fastap
1212

1313
You can download and install the Dapr FastAPI extension with:
1414

15-
{{< tabs Stable Development>}}
15+
{{< tabpane text=true >}}
1616

17-
{{% codetab %}}
17+
{{% tab header="Stable" %}}
1818
```bash
1919
pip install dapr-ext-fastapi
2020
```
21-
{{% /codetab %}}
21+
{{% /tab %}}
2222

23-
{{% codetab %}}
23+
{{% tab header="Development" %}}
2424
{{% alert title="Note" color="warning" %}}
2525
The development package will contain features and behavior that will be compatible with the pre-release version of the Dapr runtime. Make sure to uninstall any stable versions of the Python SDK extension before installing the `dapr-dev` package.
2626
{{% /alert %}}
2727

2828
```bash
2929
pip install dapr-ext-fastapi-dev
3030
```
31-
{{% /codetab %}}
31+
{{% /tab %}}
3232

33-
{{< /tabs >}}
33+
{{< /tabpane >}}
3434

3535
## Example
3636

@@ -112,4 +112,4 @@ async def startup_event():
112112
@app.get("/GetMyData")
113113
def get_my_data():
114114
return "{'message': 'myData'}"
115-
```
115+
```

daprdocs/content/en/python-sdk-docs/python-sdk-extensions/python-flask.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ The Dapr Python SDK provides integration with Flask using the `flask-dapr` exten
1212

1313
You can download and install the Dapr Flask extension with:
1414

15-
{{< tabs Stable Development>}}
15+
{{< tabpane text=true >}}
1616

17-
{{% codetab %}}
17+
{{% tab header="Stable" %}}
1818
```bash
1919
pip install flask-dapr
2020
```
21-
{{% /codetab %}}
21+
{{% /tab %}}
2222

23-
{{% codetab %}}
23+
{{% tab header="Development" %}}
2424
{{% alert title="Note" color="warning" %}}
2525
The development package will contain features and behavior that will be compatible with the pre-release version of the Dapr runtime. Make sure to uninstall any stable versions of the Python SDK extension before installing the `dapr-dev` package.
2626
{{% /alert %}}
2727

2828
```bash
2929
pip install flask-dapr-dev
3030
```
31-
{{% /codetab %}}
31+
{{% /tab %}}
3232

33-
{{< /tabs >}}
33+
{{< /tabpane >}}
3434

3535
## Example
3636

@@ -57,4 +57,4 @@ def get_my_data():
5757
# Run application
5858
if __name__ == '__main__':
5959
app.run(port=settings.HTTP_APP_PORT)
60-
```
60+
```

daprdocs/content/en/python-sdk-docs/python-sdk-extensions/python-grpc.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ The Dapr Python SDK provides a built in gRPC server extension, `dapr.ext.grpc`,
1212

1313
You can download and install the Dapr gRPC server extension with:
1414

15-
{{< tabs Stable Development>}}
15+
{{< tabpane text=true >}}
1616

17-
{{% codetab %}}
17+
{{% tab header="Stable" %}}
1818
```bash
1919
pip install dapr-ext-grpc
2020
```
21-
{{% /codetab %}}
21+
{{% /tab %}}
2222

23-
{{% codetab %}}
23+
{{% tab header="Development" %}}
2424
{{% alert title="Note" color="warning" %}}
2525
The development package will contain features and behavior that will be compatible with the pre-release version of the Dapr runtime. Make sure to uninstall any stable versions of the Python SDK extension before installing the `dapr-dev` package.
2626
{{% /alert %}}
2727

2828
```bash
2929
pip3 install dapr-ext-grpc-dev
3030
```
31-
{{% /codetab %}}
31+
{{% /tab %}}
3232

33-
{{< /tabs >}}
33+
{{< /tabpane >}}
3434

3535
## Examples
3636

0 commit comments

Comments
 (0)