From 09db73817b12af4685dc74479faf0b24369b043e Mon Sep 17 00:00:00 2001 From: Guillaume Caya-Letourneau Date: Wed, 12 Jul 2023 13:03:07 -0400 Subject: [PATCH 1/3] Update multi-app-template.md Signed-off-by: Guillaume Caya-Letourneau Signed-off-by: Aaron Crawfis --- .../local-development/multi-app-dapr-run/multi-app-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md b/daprdocs/content/en/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md index 6dad64c9f46..8bca3008036 100644 --- a/daprdocs/content/en/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md +++ b/daprdocs/content/en/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md @@ -83,7 +83,7 @@ apps: appProtocol: http appPort: 8080 appHealthCheckPath: "/healthz" - command: ["python3" "app.py"] + command: ["python3", "app.py"] appLogDestination: file # (optional), can be file, console or fileAndConsole. default is fileAndConsole. daprdLogDestination: file # (optional), can be file, console or fileAndConsole. default is file. - appID: backend # optional From a0721142208efdfa9bd5424f3fd3aa37d2714d10 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 13 Jul 2023 14:59:10 -0700 Subject: [PATCH 2/3] Update docs github metadata page Signed-off-by: Aaron Crawfis --- .../layouts/partials/page-meta-links.html | 77 ++++++++++++------- 1 file changed, 51 insertions(+), 26 deletions(-) diff --git a/daprdocs/layouts/partials/page-meta-links.html b/daprdocs/layouts/partials/page-meta-links.html index 6bf0d95a16a..7e87f5bd216 100644 --- a/daprdocs/layouts/partials/page-meta-links.html +++ b/daprdocs/layouts/partials/page-meta-links.html @@ -1,28 +1,53 @@ -{{ if .Path }} -{{ $pathFormatted := replace .Path "\\" "/" }} -{{ $gh_repo := ($.Param "github_repo") }} -{{ $gh_subdir := ($.Param "github_subdir") }} -{{ $gh_project_repo := ($.Param "github_project_repo") }} -{{ $gh_branch := (default "master" ($.Param "github_branch")) }} -{{ if $gh_repo }} -
-{{ $gh_repo_path := printf "%s/content/%s" $gh_branch $pathFormatted }} -{{ if and ($gh_subdir) (.Site.Language.Lang) }} -{{ $gh_repo_path = printf "%s/%s/content/%s/%s" $gh_branch $gh_subdir ($.Site.Language.Lang) $pathFormatted }} -{{ else if .Site.Language.Lang }} -{{ $gh_repo_path = printf "%s/content/%s/%s" $gh_branch ($.Site.Language.Lang) $pathFormatted }} -{{ else if $gh_subdir }} -{{ $gh_repo_path = printf "%s/%s/content/%s" $gh_branch $gh_subdir $pathFormatted }} -{{ end }} -{{ $editURL := printf "%s/edit/%s" $gh_repo $gh_repo_path }} -{{ $createURL := printf "%s/edit/%s" $gh_repo $gh_repo_path }} -{{ $issuesURL := printf "%s/issues/new/choose" $gh_repo}} -{{ $newPageStub := resources.Get "stubs/new-page-template.md" }} -{{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL }} -{{ $newPageURL := printf "%s/new/%s?%s" $gh_repo $gh_repo_path $newPageQS }} +{{ if .File }} +{{ $pathFormatted := replace .File.Path "\\" "/" -}} +{{ $gh_repo := ($.Param "github_repo") -}} +{{ $gh_url := ($.Param "github_url") -}} +{{ $gh_subdir := ($.Param "github_subdir") -}} +{{ $gh_project_repo := ($.Param "github_project_repo") -}} +{{ $gh_branch := (default "main" ($.Param "github_branch")) -}} +
+{{ if $gh_url -}} + {{ warnf "Warning: use of `github_url` is deprecated. For details see https://www.docsy.dev/docs/adding-content/repository-links/#github_url-optional" -}} + {{ T "post_edit_this" }} +{{ else if $gh_repo -}} + {{ $gh_repo_path := printf "%s/content/%s" $gh_branch $pathFormatted -}} + {{ if and ($gh_subdir) (.Site.Language.Lang) -}} + {{ $gh_repo_path = printf "%s/%s/content/%s/%s" $gh_branch $gh_subdir ($.Site.Language.Lang) $pathFormatted -}} + {{ else if .Site.Language.Lang -}} + {{ $gh_repo_path = printf "%s/content/%s/%s" $gh_branch ($.Site.Language.Lang) $pathFormatted -}} + {{ else if $gh_subdir -}} + {{ $gh_repo_path = printf "%s/%s/content/%s" $gh_branch $gh_subdir $pathFormatted -}} + {{ end -}} - {{ T "post_edit_this" }} - {{ T "post_create_issue" }} -
-{{ end }} + {{/* Adjust $gh_repo_path based on path_base_for_github_subdir */ -}} + {{ $ghs_base := $.Param "path_base_for_github_subdir" -}} + {{ $ghs_rename := "" -}} + {{ if reflect.IsMap $ghs_base -}} + {{ $ghs_rename = $ghs_base.to -}} + {{ $ghs_base = $ghs_base.from -}} + {{ end -}} + {{ with $ghs_base -}} + {{ $gh_repo_path = replaceRE . $ghs_rename $gh_repo_path -}} + {{ end -}} + + {{ $viewURL := printf "%s/tree/%s" $gh_repo $gh_repo_path -}} + {{ $editURL := printf "%s/edit/%s" $gh_repo $gh_repo_path -}} + {{ $issuesURL := printf "%s/issues/new/choose" $gh_repo -}} + {{ $newPageStub := resources.Get "stubs/new-page-template.md" -}} + {{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL -}} + {{ $newPageURL := printf "%s/new/%s?%s" $gh_repo $gh_repo_path $newPageQS -}} + + {{ T "post_edit_this" }} + {{ T "post_create_issue" }} + + {{ with $gh_project_repo -}} + {{ $project_issueURL := printf "%s/issues/new/choose" . -}} + {{ T "post_create_project_issue" }} + {{ end -}} + +{{ end -}} +{{ with .CurrentSection.AlternativeOutputFormats.Get "print" -}} + {{ T "print_entire_section" }} {{ end }} +
+{{ end -}} \ No newline at end of file From 30a02858219853665ebfd3d0af5b713ef5e6c5c8 Mon Sep 17 00:00:00 2001 From: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com> Date: Fri, 14 Jul 2023 12:52:47 -0700 Subject: [PATCH 3/3] Update docs for in-memory components Includes marking the components as stable, since they meet our criteria. Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com> --- .../supported-pubsub/setup-inmemory.md | 7 ++++--- .../supported-state-stores/setup-inmemory.md | 15 ++++++--------- daprdocs/data/components/pubsub/generic.yaml | 2 +- .../data/components/state_stores/generic.yaml | 4 ++-- 4 files changed, 13 insertions(+), 15 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-inmemory.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-inmemory.md index 8a6a8951b0d..e2275a4652c 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-inmemory.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-inmemory.md @@ -1,13 +1,13 @@ --- type: docs -title: "In Memory" -linkTitle: "In Memory" +title: "In-memory" +linkTitle: "In-memory" description: "Detailed documentation on the In Memory pubsub component" aliases: - "/operations/components/setup-pubsub/supported-pubsub/setup-inmemory/" --- -The In Memory pub/sub component is useful for development purposes and works inside of a single machine boundary. +The in-memory pub/sub component operates within a single Dapr sidecar. This is primarily meant for development purposes. State is not replicated across multiple sidecars and is lost when the Dapr sidecar is restarted. ## Component format @@ -25,6 +25,7 @@ spec: > Note: in-memory does not require any specific metadata for the component to work, however spec.metadata is a required field. ## Related links + - [Basic schema for a Dapr component]({{< ref component-schema >}}) in the Related links section - Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components - [Pub/Sub building block]({{< ref pubsub >}}) diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md index d54277d1782..17d8cc4be3e 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md @@ -1,20 +1,16 @@ --- type: docs -title: "In Memory" -linkTitle: "In Memory" -description: "Detailed documentation on the In Memory state component" +title: "In-memory" +linkTitle: "In-memory" +description: "Detailed documentation on the in-memory state component" aliases: - "/operations/components/setup-state-store/supported-state-stores/setup-inmemory/" --- -The In Memory state store component is useful for development purposes and works inside of a single machine boundary. - -{{% alert title="Warning" color="warning" %}} - This component **shouldn't be used for production**. It is developer only and will never be stable. If you come across a scenario and want to use it in production, you can submit an issue and discuss it with the community. - -{{% /alert %}} +The in-memory state store component maintains state in the Dapr sidecar's memory. This is primarily meant for development purposes. State is not replicated across multiple sidecars and is lost when the Dapr sidecar is restarted. ## Component format + To setup in-memory state store, create a component of type `state.in-memory`. See [this guide]({{< ref "howto-get-save-state.md#step-1-setup-a-state-store" >}}) on how to create and apply a state store configuration. ```yaml @@ -31,6 +27,7 @@ spec: > Note: While in-memory does not require any specific metadata for the component to work, `spec.metadata` is a required field. ## Related links + - [Basic schema for a Dapr component]({{< ref component-schema >}}) - Learn [how to create and configure state store components]({{< ref howto-get-save-state.md >}}) - Read more about the [state management building block]({{< ref state-management >}}) diff --git a/daprdocs/data/components/pubsub/generic.yaml b/daprdocs/data/components/pubsub/generic.yaml index 4ceabbfa6f8..38d775c639c 100644 --- a/daprdocs/data/components/pubsub/generic.yaml +++ b/daprdocs/data/components/pubsub/generic.yaml @@ -1,6 +1,6 @@ - component: In-memory link: setup-inmemory - state: Beta + state: Stable version: v1 since: "1.7" features: diff --git a/daprdocs/data/components/state_stores/generic.yaml b/daprdocs/data/components/state_stores/generic.yaml index dd7cacd13ba..a4ffcd52cb2 100644 --- a/daprdocs/data/components/state_stores/generic.yaml +++ b/daprdocs/data/components/state_stores/generic.yaml @@ -77,9 +77,9 @@ query: false - component: In-memory link: setup-inmemory - state: Developer-only + state: Stable version: v1 - since: "1.8" + since: "1.9" features: crud: true transactions: true