add temporal cli docs for nexus endpoints #3149
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bergundy
approved these changes
Oct 11, 2024
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
prasek
force-pushed
the
nexus-operator-cli-docs
branch
from
76a13e0
to
44bdcb0
Compare
jsundai
reviewed
Oct 11, 2024
docs/cli/cmd-options.mdx
Outdated
| @@ -313,7 +317,11 @@ Use `-1` to fetch Child Workflows at any depth. | |||
|
|
|||
| ## description | |||
|
|
|||
| Namespace description. | |||
| Namespace description or Endpoint description in markdown format (encoded using the configured codec server). | |||
There was a problem hiding this comment.
codec server -> Codec Server
jsundai
reviewed
Oct 11, 2024
| @@ -656,6 +672,18 @@ Specify a delay before the workflow starts. | |||
|
|
|||
| Backfill start time. | |||
|
|
|||
| ## target-namespace | |||
|
|
|||
| Namespace in which a handler worker will be polling for Nexus tasks on. | |||
There was a problem hiding this comment.
Great job & looks good to me! Just make sure all the Temporal terms are capitalized like "Worker", "Workflow", "Task Queue" and make sure every sentence is on one line. I did the Operator file as an example.
jsundai
reviewed
Oct 11, 2024
| - [--tls-server-name](/cli/cmd-options#tls-server-name) | ||
|
|
||
| - [--unset-description](/cli/cmd-options#unset-description) | ||
|
|
There was a problem hiding this comment.
@fairlydurable Do you mind giving one quick look when you get back from PTO since the CLI is your realm of expertise? If there's anything major we can all probably hop on a call about it.
Signed-off-by: Phil Prasek <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds temporal cli docs for nexus endpoints
Notes to reviewers
Auto-generated using a fork of the recent docs gen.