Update samples documentation (Azure#152)

* Update samples documentation Signed-off-by: MD Ashique <[email protected]> * Update samples documentation Signed-off-by: MD Ashique <[email protected]> * Update samples/dotnet-azurefunction/README.md Co-authored-by: Shubham Sharma <[email protected]> * Update samples documentation Signed-off-by: MD Ashique <[email protected]> --------- Signed-off-by: MD Ashique <[email protected]> Co-authored-by: Shubham Sharma <[email protected]>
ASHIQUEMD · Sep 25, 2023 · f8975dc · f8975dc
1 parent 422382f
commit f8975dc
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 36 deletions.
diff --git a/samples/dotnet-azurefunction/README.md b/samples/dotnet-azurefunction/README.md
@@ -8,12 +8,14 @@ We'll be running a Darp'd function app locally:
 
 ## Prerequisites
 This sample requires you to have the following installed on your machine:
-- [Setup Dapr](https://github.com/dapr/quickstarts/tree/master/hello-world) : Follow [instructions](https://docs.dapr.io/getting-started/install-dapr/) to download and install the Dapr CLI and initialize Dapr.
+- Setup Dapr: Follow instructions to [download and install the Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) and [initialize Dapr](https://docs.dapr.io/getting-started/install-dapr-selfhost/).
 - [Install Azure Functions Core Tool](https://github.com/Azure/azure-functions-core-tools/blob/master/README.md#windows)
-- [Run Kafka Docker Container Locally](https://github.com/dapr/quickstarts/tree/master/bindings). The required Kafka files is located in `sample\dapr-kafka` directory.
-```
-docker-compose -f docker-compose-single-kafka.yml up
-```
+- Run Kafka Docker Container locally with below command.
+
+  ```
+  cd samples\dapr-kafka
+  docker-compose -f docker-compose-single-kafka.yml up -d
+  ```
 
 # Step 1 - Understand the Settings 
 

diff --git a/samples/dotnet-isolated-azurefunction/README.md b/samples/dotnet-isolated-azurefunction/README.md
@@ -8,12 +8,14 @@ We'll be running a Darp'd function app locally:
 
 ## Prerequisites
 This sample requires you to have the following installed on your machine:
-- [Setup Dapr](https://github.com/dapr/quickstarts/tree/master/hello-world) : Follow [instructions](https://docs.dapr.io/getting-started/install-dapr/) to download and install the Dapr CLI and initialize Dapr.
+- Setup Dapr: Follow instructions to [download and install the Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) and [initialize Dapr](https://docs.dapr.io/getting-started/install-dapr-selfhost/).
 - [Install Azure Functions Core Tool](https://github.com/Azure/azure-functions-core-tools/blob/master/README.md#windows)
-- [Run Kafka Docker Container Locally](https://github.com/dapr/quickstarts/tree/master/bindings). The required Kafka files is located in `sample\dapr-kafka` directory.
-```
-docker-compose -f docker-compose-single-kafka.yml up
-```
+- Run Kafka Docker Container locally with below command.
+
+  ```
+  cd samples\dapr-kafka
+  docker-compose -f docker-compose-single-kafka.yml up -d
+  ```
 
 # Step 1 - Understand the Settings 
 

diff --git a/samples/java-azurefunction/README.md b/samples/java-azurefunction/README.md
@@ -8,12 +8,13 @@ We'll be running a Dapr-ized function app locally:
 
 ## Prerequisites
 This sample requires you to have the following installed on your machine:
-- [Setup Dapr](https://github.com/dapr/quickstarts/tree/master/hello-world) : Follow [instructions](https://docs.dapr.io/getting-started/install-dapr/) to download and install the Dapr CLI and initialize Dapr.
+- Setup Dapr : Follow instructions to [download and install the Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) and [initialize Dapr](https://docs.dapr.io/getting-started/install-dapr-selfhost/).
 - [Install Azure Functions Core Tool](https://github.com/Azure/azure-functions-core-tools/blob/master/README.md#windows)
-- [Run Kafka Docker Container Locally](https://github.com/dapr/quickstarts/tree/master/bindings). The required Kafka files is located in `samples\dapr-kafka` directory.
+- Run Kafka Docker Container locally with below command.
 
   ```
-  docker-compose -f docker-compose-single-kafka.yml up
+  cd samples\dapr-kafka
+  docker-compose -f docker-compose-single-kafka.yml up -d
   ```
 - Follow the [Configure your local environment](https://learn.microsoft.com/azure/azure-functions/create-first-function-vs-code-java#configure-your-environment) instructions for Java.
 - Install maven
@@ -56,7 +57,7 @@ The `%` denotes an app setting value, for the following binding as an example:
  In the runtime, the binding will check the `local.settings.json` file and resolve `%StateStoreName%` into `statestore`. The function will then make a call into the state store named as `statestore`.
 
 
-Please make sure the value in `local.settings.json` matches with the name specified in the YAML files in Dapr `/component` folder:
+Please make sure the value in `local.settings.json` matches with the name specified in the YAML files in Dapr `/components` folder:
 
 ```yaml
 ...
@@ -76,12 +77,12 @@ Run function host with Dapr:
 
 Windows
 ```
-dapr run --app-id functionapp --app-port 3001 --dapr-http-port 3501 --components-path ..\components\ -- func -- mvn azure-functions:run
+dapr run --app-id functionapp --app-port 3001 --dapr-http-port 3501 --components-path ..\components\ -- mvn azure-functions:run
 ```
 
 Linux/Mac OS
 ```
-dapr run --app-id functionapp --app-port 3001 --dapr-http-port 3501 --components-path ../components/ -- -- mvn azure-functions:run
+dapr run --app-id functionapp --app-port 3001 --dapr-http-port 3501 --components-path ../components/ -- mvn azure-functions:run
 ```
 
 The command should output the dapr logs that look like the following:

diff --git a/samples/javascript-azurefunction/README.md b/samples/javascript-azurefunction/README.md
@@ -8,13 +8,14 @@ We'll be running a Darp'd function app locally:
 
 ## Prerequisites
 This sample requires you to have the following installed on your machine:
-- [Setup Dapr](https://github.com/dapr/quickstarts/tree/master/hello-world) : Follow [instructions](https://docs.dapr.io/getting-started/install-dapr/) to download and install the Dapr CLI and initialize Dapr.
+- Setup Dapr : Follow instructions to [download and install the Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) and [initialize Dapr](https://docs.dapr.io/getting-started/install-dapr-selfhost/).
 - [Install Azure Functions Core Tool](https://github.com/Azure/azure-functions-core-tools/blob/master/README.md#windows)
-- [Install .NET Core SDK](https://dotnet.microsoft.com/download)
-- [Run Kafka Docker Container Locally](https://github.com/dapr/quickstarts/tree/master/bindings). The required Kafka files is located in `sample\dapr-kafka` directory.
-```
-docker-compose -f docker-compose-single-kafka.yml up
-```
+- Run Kafka Docker Container locally with below command.
+
+  ```
+  cd samples\dapr-kafka
+  docker-compose -f docker-compose-single-kafka.yml up -d
+  ```
 
 # Step 1 - Understand the Settings 
 

diff --git a/samples/powershell-azurefunction/README.md b/samples/powershell-azurefunction/README.md
@@ -8,14 +8,16 @@ We'll be running a Darp'd function app locally:
 
 ## Prerequisites
 This sample requires you to have the following installed on your machine:
-- [Setup Dapr](https://github.com/dapr/quickstarts/tree/master/hello-world) : Follow [instructions](https://docs.dapr.io/getting-started/install-dapr/) to download and install the Dapr CLI and initialize Dapr.
+- Setup Dapr : Follow instructions to [download and install the Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) and [initialize Dapr](https://docs.dapr.io/getting-started/install-dapr-selfhost/).
 - [Install Azure Functions Core Tool](https://github.com/Azure/azure-functions-core-tools/blob/master/README.md#windows)
 - [Install Powershell on your machine](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3)
 - [Install .NET Core SDK](https://dotnet.microsoft.com/download), used for install Dapr Extension for non .NET language
-- [Run Kafka Docker Container Locally](https://github.com/dapr/quickstarts/tree/master/bindings). The required Kafka files is located in `samples\dapr-kafka` directory.
-    ```
-    docker-compose -f docker-compose-single-kafka.yml up
-    ```
+- Run Kafka Docker Container locally with below command.
+
+  ```
+  cd samples\dapr-kafka
+  docker-compose -f docker-compose-single-kafka.yml up -d
+  ```
 
 # Step 1 - Understand the Settings 
 

diff --git a/samples/python-azurefunction/README.md b/samples/python-azurefunction/README.md
@@ -9,16 +9,18 @@ We'll be running a Darp'd function app locally:
 
 ## Prerequisites
 This sample requires you to have the following installed on your machine:
-- [Setup Dapr](https://github.com/dapr/quickstarts/tree/master/hello-world) : Follow [instructions](https://docs.dapr.io/getting-started/install-dapr/) to download and install the Dapr CLI and initialize Dapr.
+- Setup Dapr : Follow instructions to [download and install the Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) and [initialize Dapr](https://docs.dapr.io/getting-started/install-dapr-selfhost/).
 - [Install Azure Functions Core Tool](https://github.com/Azure/azure-functions-core-tools/blob/master/README.md#windows)
 - Install Python on your machine
-    - This sample uses Python 3.7.6. Some nuance or issue is expected if using other version
+    - This sample uses Python 3.8. Some nuance or issue is expected if using other version
 - [Set up Python Environment in Visual Studio Code](https://code.visualstudio.com/docs/python/python-tutorial)
 - [Install .NET Core SDK](https://dotnet.microsoft.com/download), used for install Dapr Extension for non .NET language
-- [Run Kafka Docker Container Locally](https://github.com/dapr/quickstarts/tree/master/bindings). The required Kafka files is located in `samples\dapr-kafka` directory.
-```
-docker-compose -f docker-compose-single-kafka.yml up
-```
+- Run Kafka Docker Container locally with below command.
+
+  ```
+  cd samples\dapr-kafka
+  docker-compose -f docker-compose-single-kafka.yml up -d
+  ```
 
 # Step 1 - Understand the Settings 
 

diff --git a/samples/python-v2-azurefunctions/README.md b/samples/python-v2-azurefunctions/README.md
@@ -8,13 +8,18 @@ We'll be running a Darp'd function app locally:
 
 ## Prerequisites
 This sample requires you to have the following installed on your machine:
-- [Setup Dapr](https://github.com/dapr/quickstarts/tree/master/hello-world) : Follow [instructions](https://docs.dapr.io/getting-started/install-dapr/) to download and install the Dapr CLI and initialize Dapr.
+- Setup Dapr : Follow instructions to [download and install the Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) and [initialize Dapr](https://docs.dapr.io/getting-started/install-dapr-selfhost/).
 - [Install Azure Functions Core Tool](https://github.com/Azure/azure-functions-core-tools/blob/master/README.md#windows)
 - Install Python on your machine
-    - This sample uses Python 3.8.0. Some nuance or issue is expected if using other version
+    - This sample uses Python 3.8. Some nuance or issue is expected if using other version
 - [Set up Python Environment in Visual Studio Code](https://code.visualstudio.com/docs/python/python-tutorial)
 - [Install .NET Core SDK](https://dotnet.microsoft.com/download), used for install Dapr Extension for non .NET language
-- [Run Kafka Docker Container Locally](https://github.com/dapr/quickstarts/tree/master/bindings). The required Kafka files is located in `sample\dapr-kafka` directory.
+- Run Kafka Docker Container locally with below command.
+
+  ```
+  cd samples\dapr-kafka
+  docker-compose -f docker-compose-single-kafka.yml up -d
+  ```
 
 # Step 1 - Understand the Settings