Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
3e0f702
Supported Release Info and Upgrade Path for v1.2 (#1494)
berndverst May 27, 2021
48e28c3
Adding K8s versions table (#1521)
May 28, 2021
6180edf
Fix incorrect postgresql connection string example (#1524)
Jun 3, 2021
8f89523
Update docs on using Codespaces with Dapr repos (#1522)
CodeMonkeyLeet Jun 3, 2021
e6b2771
Fix two typos (#1526)
mthmulders Jun 3, 2021
d2ccd78
Update chinese content (#1527)
newbe36524 Jun 3, 2021
993cf5e
Updated to fix deprecated helm chart location (#1528)
StevenJDH Jun 3, 2021
a573434
nr_consul_typo fixed malformed yaml (#1532)
a-elsheikh Jun 3, 2021
6cb10b7
Fix typo in azure-keyvault-managed-identity.md (#1541)
repne Jun 7, 2021
a941868
Fix custom middleware sample code interface implementation error (#1539)
li1234yun Jun 8, 2021
c73245e
Fix the file name of secrets json (#1546)
greenie-msft Jun 9, 2021
ae5b222
Tech writing touch-ups (#1555)
voipengineer Jun 14, 2021
3513781
Tech writing touch-ups (#1556)
voipengineer Jun 14, 2021
be06bfe
Tech writing touch-ups (#1557)
voipengineer Jun 14, 2021
fff6256
Tech writing touch-ups (#1558)
voipengineer Jun 14, 2021
7706239
Tech writing touch-ups (#1560)
voipengineer Jun 14, 2021
978fa11
Tech writing touch-ups (#1559)
voipengineer Jun 14, 2021
e066976
Ignore intellij link that isn't resolvable (#1564)
AaronCrawfis Jun 15, 2021
e71fa49
Update issue templates (#1563)
AaronCrawfis Jun 15, 2021
5c6c31b
Updating PubSub documentation to remove slave wording (#1565)
esimkowitz Jun 15, 2021
97b0436
Actor Runtime Configuration Docs (#1495)
berndverst Jun 16, 2021
93eb5fa
Fixed GCP Pub/Sub Binding required fields (#1578)
greenie-msft Jun 18, 2021
5bee1da
aacrawfi/middlware (#1567)
AaronCrawfis Jun 18, 2021
1042bc4
Fix incorrect curl syntax in Actors API examples (#1577)
greenie-msft Jun 18, 2021
c9c9d32
Fix link at api-allowlist.md (#1574)
RicardoNiepel Jun 18, 2021
b2b30dd
Add language that only a single state store component can be used for…
greenie-msft Jun 18, 2021
c227603
fix: cron format (#1581)
abhith Jun 21, 2021
231b0e8
Updated name resolution docs (#1576)
AaronCrawfis Jun 23, 2021
ac9d4b5
Fix broken url in docs (#1599)
saintmalik Jun 28, 2021
7e4a651
Dapr roadmap page (#1593)
AaronCrawfis Jun 28, 2021
a8751ae
Add shortcode to embed sections of code files (#1596)
AaronCrawfis Jun 28, 2021
fc677ac
V1.2 python SDKDocs update - client (#1553)
paulyuk Jun 29, 2021
e79ffa3
Remove visible <b> (#1602)
daixiang0 Jun 30, 2021
c28cbcd
Comment out all optional destructive parameters (#1604)
AaronCrawfis Jul 6, 2021
d8f0510
Remove "http" code type from health_api.md (#1610)
qt-luigi Jul 6, 2021
89f0a42
Remove "http" code type from metadata_api.md (#1611)
qt-luigi Jul 6, 2021
d240389
Fix typo of "the" (#1616)
qt-luigi Jul 6, 2021
ec00955
Fix a link to "Next steps" (#1617)
qt-luigi Jul 6, 2021
380fb89
Bump glob-parent from 5.1.1 to 5.1.2 in /daprdocs (#1618)
dependabot[bot] Jul 6, 2021
6903594
Clarify shared access policy (#1621)
AaronCrawfis Jul 8, 2021
73b2efd
Upmerge from v1.2
AaronCrawfis Jul 8, 2021
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
58 changes: 0 additions & 58 deletions daprdocs/assets/scss/_sidebar-toc.scss

This file was deleted.

96 changes: 96 additions & 0 deletions daprdocs/content/en/contributing/contributing-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,102 @@ brew install dapr/tap/dapr-cli

{{< /tabs >}}

### Embedded code snippets

Use the `code-snippet` shortcode to reference code snippets from the `static/code` directory.

```
{{</* code-snippet file="myfile.py" lang="python" */>}}
```

{{% alert title="Warning" color="warning" %}}
All Dapr sample code should be self-contained in separate files, not in markdown. Use the techniques described here to highlight the parts of the sample code users should focus on.
{{% /alert %}}

Use the `lang` (default `txt`) parameter to configure the language used for syntax highlighting.

Use the `marker` parameter to limit the embedded snipped to a portion of the sample file. This is useful when you want to show just a portion of a larger file. The typical way to do this is surround the interesting code with comments, and then pass the comment text into `marker`.

The shortcode below and code sample:

```
{{</* code-snippet file="./contributing-1.py" lang="python" marker="#SAMPLE" */>}}
```

```python
import json
import time

from dapr.clients import DaprClient

#SAMPLE
with DaprClient() as d:
req_data = {
'id': 1,
'message': 'hello world'
}

while True:
# Create a typed message with content type and body
resp = d.invoke_method(
'invoke-receiver',
'my-method',
data=json.dumps(req_data),
)

# Print the response
print(resp.content_type, flush=True)
print(resp.text(), flush=True)

time.sleep(2)
#SAMPLE
```

Will result in the following output:

{{< code-snippet file="contributing-1.py" lang="python" marker="#SAMPLE" >}}

Use the `replace-key-[token]` and `replace-value-[token]` parameters to limit the embedded snipped to a portion of the sample file. This is useful when you want abbreviate a portion of the code sample. Multiple replacements are supported with multiple values of `token`.

The shortcode below and code sample:

```
{{</* code-snippet file="./contributing-2.py" lang="python" replace-key-imports="#IMPORTS" replace-value-imports="# Import statements" */>}}
```

```python
#IMPORTS
import json
import time
#IMPORTS

from dapr.clients import DaprClient

with DaprClient() as d:
req_data = {
'id': 1,
'message': 'hello world'
}

while True:
# Create a typed message with content type and body
resp = d.invoke_method(
'invoke-receiver',
'my-method',
data=json.dumps(req_data),
)

# Print the response
print(resp.content_type, flush=True)
print(resp.text(), flush=True)

time.sleep(2)
```

Will result in the following output:

{{< code-snippet file="./contributing-2.py" lang="python" replace-key-imports="#IMPORTS" replace-value-imports="# Import statements" >}}

### YouTube videos
Hugo can automatically embed YouTube videos using a shortcode:
```
Expand Down
48 changes: 48 additions & 0 deletions daprdocs/content/en/contributing/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
type: docs
title: "Dapr Roadmap"
linkTitle: "Roadmap"
description: "The Dapr Roadmap is a tool to help with visibility into investments across the Dapr project"
weight: 1100
no_list: true
---


Dapr encourages the community to help with prioritization. A GitHub project board is available to view and provide feedback on proposed issues and track them across development.

[<img src="/images/roadmap.png" alt="Screenshot of the Dapr Roadmap board" width=500 >](https://aka.ms/dapr/roadmap)

{{< button text="View the backlog" link="https://aka.ms/dapr/roadmap" color="primary" >}}
<br />

Please vote by adding a 👍 on the GitHub issues for the feature capabilities you would most like to see Dapr support. This will help the Dapr maintainers understand which features will provide the most value.

Contributions from the community is also welcomed. If there are features on the roadmap that you are interested in contributing to, please comment on the GitHub issue and include your solution proposal.

{{% alert title="Note" color="primary" %}}
The Dapr roadmap includes issues only from the v1.2 release and onwards. Issues closed and released prior to v1.2 are not included.
{{% /alert %}}

## Stages

The Dapr Roadmap progresses through the following stages:

{{< cardpane >}}
{{< card title="**[📄 Backlog](https://github.com/orgs/dapr/projects/52#column-14691591)**" >}}
Issues (features) that need 👍 votes from the community to prioritize. Updated by Dapr maintainers.
{{< /card >}}
{{< card title="**[⏳ Planned (Committed)](https://github.com/orgs/dapr/projects/52#column-14561691)**" >}}
Issues with a proposal and/or targeted release milestone. This is where design proposals are discussed and designed.
{{< /card >}}
{{< card title="**[👩‍💻 In Progress (Development)](https://github.com/orgs/dapr/projects/52#column-14561696)**" >}}
Implementation specifics have been agreed upon and the feature is under active development.
{{< /card >}}
{{< /cardpane >}}
{{< cardpane >}}
{{< card title="**[☑ Done](https://github.com/orgs/dapr/projects/52#column-14561700)**" >}}
The feature capability has been completed and is scheduled for an upcoming release.
{{< /card >}}
{{< card title="**[✅ Released](https://github.com/orgs/dapr/projects/52#column-14659973)**" >}}
The feature is released and available for use.
{{< /card >}}
{{< /cardpane >}}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ When message time-to-live has native support in the pub/sub component, Dapr simp

#### Azure Service Bus

Azure Service Bus supports [entity level time-to-live]((https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-expiration)). This means that messages have a default time-to-live but can also be set with a shorter timespan at publishing time. Dapr propagates the time-to-live metadata for the message and lets Azure Service Bus handle the expiration directly.
Azure Service Bus supports [entity level time-to-live](https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-expiration). This means that messages have a default time-to-live but can also be set with a shorter timespan at publishing time. Dapr propagates the time-to-live metadata for the message and lets Azure Service Bus handle the expiration directly.

## Non-Dapr subscribers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Dapr can use any Redis instance - either containerized on your local dev machine
{{< tabs "Self-Hosted" "Kubernetes" "Azure" "AWS" "GCP" >}}

{{% codetab %}}
Redis is automatically installed in self-hosted environments by the Dapr CLI as part of the initialization process. You are all set and can skip to the [next steps](next steps)
Redis is automatically installed in self-hosted environments by the Dapr CLI as part of the initialization process. You are all set and can skip to the [next steps](#next-steps)
{{% /codetab %}}

{{% codetab %}}
Expand Down Expand Up @@ -127,7 +127,7 @@ spec:
key: redis-password
```

This example uses the the kubernetes secret that was created when setting up a cluster with the above instructions.
This example uses the kubernetes secret that was created when setting up a cluster with the above instructions.

{{% alert title="Other stores" color="primary" %}}
If using a state store other than Redis, refer to the [supported state stores]({{< ref supported-state-stores >}}) for information on what options to set.
Expand Down Expand Up @@ -155,7 +155,7 @@ spec:
key: redis-password
```

This example uses the the kubernetes secret that was created when setting up a cluster with the above instructions.
This example uses the kubernetes secret that was created when setting up a cluster with the above instructions.

{{% alert title="Other stores" color="primary" %}}
If using a pub/sub message broker other than Redis, refer to the [supported pub/sub message brokers]({{< ref supported-pubsub >}}) for information on what options to set.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ spec:
dapr.io/enabled: "true"
dapr.io/app-id: "nodesubscriber"
dapr.io/app-port: "3000"
<b>dapr.io/app-max-concurrency: "1"</b>
dapr.io/app-max-concurrency: "1"
...
```

Expand Down
2 changes: 1 addition & 1 deletion daprdocs/content/en/reference/api/health_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Gets the health state for Dapr.

### HTTP Request

```http
```
GET http://localhost:<daprPort>/v1.0/healthz
```

Expand Down
2 changes: 1 addition & 1 deletion daprdocs/content/en/reference/api/metadata_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Gets the Dapr sidecar information provided by the Metadata Endpoint.

### HTTP Request

```http
```
GET http://localhost:<daprPort>/v1.0/metadata
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,38 +22,38 @@ spec:
metadata:
- name: connectionString # Required
value: "Endpoint=sb://{ServiceBusNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={ServiceBus}"
- name: timeoutInSec # Optional
value: 60
- name: handlerTimeoutInSec # Optional
value: 60
- name: disableEntityManagement # Optional
value: "false"
- name: maxDeliveryCount # Optional
value: 3
- name: lockDurationInSec # Optional
value: 60
- name: lockRenewalInSec # Optional
value: 20
- name: maxActiveMessages # Optional
value: 2000
- name: maxActiveMessagesRecoveryInSec # Optional
value: 2
- name: maxConcurrentHandlers # Optional
value: 10
- name: prefetchCount # Optional
value: 5
- name: defaultMessageTimeToLiveInSec # Optional
value: 10
- name: autoDeleteOnIdleInSec # Optional
value: 10
- name: maxReconnectionAttempts # Optional
value: 30
- name: connectionRecoveryInSec # Optional
value: 2
- name: publishMaxRetries # Optional
value: 5
- name: publishInitialRetryInternalInMs # Optional
value: 500
# - name: timeoutInSec # Optional
# value: 60
# - name: handlerTimeoutInSec # Optional
# value: 60
# - name: disableEntityManagement # Optional
# value: "false"
# - name: maxDeliveryCount # Optional
# value: 3
# - name: lockDurationInSec # Optional
# value: 60
# - name: lockRenewalInSec # Optional
# value: 20
# - name: maxActiveMessages # Optional
# value: 2000
# - name: maxActiveMessagesRecoveryInSec # Optional
# value: 2
# - name: maxConcurrentHandlers # Optional
# value: 10
# - name: prefetchCount # Optional
# value: 5
# - name: defaultMessageTimeToLiveInSec # Optional
# value: 10
# - name: autoDeleteOnIdleInSec # Optional
# value: 10
# - name: maxReconnectionAttempts # Optional
# value: 30
# - name: connectionRecoveryInSec # Optional
# value: 2
# - name: publishMaxRetries # Optional
# value: 5
# - name: publishInitialRetryInternalInMs # Optional
# value: 500
```

> __NOTE:__ The above settings are shared across all topics that use this component.
Expand All @@ -66,7 +66,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

| Field | Required | Details | Example |
|--------------------|:--------:|---------|---------|
| connectionString | Y | Connection-string for the Service Bus | "`Endpoint=sb://{ServiceBusNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={ServiceBus}`"
| connectionString | Y | Shared access policy connection-string for the Service Bus | "`Endpoint=sb://{ServiceBusNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={ServiceBus}`"
| timeoutInSec | N | Timeout for sending messages and management operations. Default: `60` |`30`
| handlerTimeoutInSec| N | Timeout for invoking app handler. # Optional. Default: `60` | `30`
| disableEntityManagement | N | When set to true, topics and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"`
Expand Down
Empty file.
4 changes: 2 additions & 2 deletions daprdocs/layouts/partials/toc.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{{ partial "page-meta-links.html" . }}
{{ if not .Params.notoc }}
{{ with .TableOfContents }}
{{ if ge (len .) 200 }}
{{ . }}
<br />
<div class="td-toc">{{ . }}</div>
{{ end }}
{{ end }}
{{ end }}
23 changes: 23 additions & 0 deletions daprdocs/layouts/shortcodes/code-snippet.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{{ $file := .Get "file" }}
{{ $filePath := (path.Join "/static/code/" $file ) }}
{{ $fileContents := $filePath | readFile }}
{{ $lang := .Get "lang" | default "txt" }}
{{ $embed := .Get "embed" | default true }}
{{ if $embed }}
{{ if isset .Params "marker" }}
{{ $marker := .Get "marker" }}
{{ $regex := printf "(?s).*%s%s%s.*" $marker `(\n)?(?P<inner>.*?)(\n\s+)?` $marker }}
{{ $fileContents = replaceRE $regex "$inner" $fileContents}}
{{ end }}
{{ range $key, $value := $.Params }}
{{ if hasPrefix $key "replace-key" }}
{{ $replace := $value }}
{{ $replaceValueParameter := printf "replace-value-%s" (slicestr $key (len "replace-key-")) }}
<p>{{ $replaceValueParameter }}</p>
{{ $replaceWith := index $.Params $replaceValueParameter }}
{{ $regex := printf "(?s)%s%s%s" $replace `(\n)?(?P<inner>.*?)(\n\s+)?` $replace }}
{{ $fileContents = replaceRE $regex $replaceWith $fileContents}}
{{ end }}
{{ end }}
{{ (print "```" $lang "\n" $fileContents "\n```") | markdownify }}
{{ end }}
Loading