Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add -f - example for dapr run #3872

Closed
wants to merge 2 commits into from
Closed

Conversation

stuartleeks
Copy link
Contributor

@stuartleeks stuartleeks commented Nov 17, 2023

Thank you for helping make the Dapr documentation better!

Docs update related to dapr/cli#1364

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Update dapr run docs related to reading run file from stdin (dapr/cli#1364)

Issue reference

@@ -36,7 +36,7 @@ dapr run [flags] [command]
| `--dapr-http-port`, `-H` | `DAPR_HTTP_PORT` | `3500` | The HTTP port for Dapr to listen on |
| `--enable-profiling` | | `false` | Enable "pprof" profiling via an HTTP endpoint |
| `--help`, `-h` | | | Print the help message |
| `--run-file`, `-f` | | Linux/MacOS: `$HOME/.dapr/dapr.yaml` | Run multiple applications at once using a Multi-App Run template file. Currently in [alpha]({{< ref "support-preview-features.md" >}}) and only available in Linux/MacOS |
| `--run-file`, `-f` | | Linux/MacOS: `$HOME/.dapr/dapr.yaml` | Run multiple applications at once using a Multi-App Run template file. Currently in [alpha]({{< ref "support-preview-features.md" >}}) and only available in Linux/MacOS. Pass `-` as the value to read template from stdin. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `--run-file`, `-f` | | Linux/MacOS: `$HOME/.dapr/dapr.yaml` | Run multiple applications at once using a Multi-App Run template file. Currently in [alpha]({{< ref "support-preview-features.md" >}}) and only available in Linux/MacOS. Pass `-` as the value to read template from stdin. |
| `--run-file`, `-f` | | Linux/MacOS: `$HOME/.dapr/dapr.yaml` | Run multiple applications at once using a Multi-App Run template file. Currently in [alpha]({{< ref "support-preview-features.md" >}}) and only available in Linux/MacOS.
Pass `-` as the value to read template from stdin. |

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add an example here to be explicit. Having an example then makes it clear.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stuartleeks - Did you see my comment above ^^

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@msfussell - I've updated to include an example of the full command syntax inline in the table. Is that what you were meaning?

Copy link

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Nov 26, 2023
@msfussell msfussell removed the stale label Nov 27, 2023
@stuartleeks
Copy link
Contributor Author

@msfussell - yes, I saw the comment and hope to add an example this week 😄

Signed-off-by: Stuart Leeks <stuartle@microsoft.com>
Signed-off-by: Stuart Leeks <stuartle@microsoft.com>
Copy link

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Dec 12, 2023
@github-actions github-actions bot closed this Dec 19, 2023
@stuartleeks
Copy link
Contributor Author

@msfussell - since the code change for this has been merged, can you let me know whether the additional changes I made in this PR address your feedback? It would be good to get the docs updated :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants