add temporal cli docs for nexus endpoints #3149
Merged
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
jsundai
reviewed
Oct 11, 2024
jsundai
reviewed
Oct 11, 2024
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
jsundai
reviewed
Oct 16, 2024
jsundai
reviewed
Oct 16, 2024
jsundai
reviewed
Oct 16, 2024
docs/cli/operator.mdx
Outdated
| @@ -846,8 +846,8 @@ Use the following options to change the behavior of this command. | |||
|
|
|||
| Update an existing Nexus Endpoint on the Server. | |||
|
|
|||
| An endpoint name is used in Workflow code to invoke Nexus operations. | |||
| The endpoint target may either be a Worker, in which case `--target-namespace` and | |||
| A Nexus Endpoint name is used in Workflow code to invoke Nexus Operations. The | |||
There was a problem hiding this comment.
Every sentence on one line - it helps when making comments and consistency across the docs repo.
Other than that, looks good to merge.
Signed-off-by: Phil Prasek <[email protected]>
|
Thanks @jsundai, updated per your suggestions. Think we're good to go, pending the final review of temporalio/cli#693! |
jsundai
approved these changes
Oct 16, 2024
josh-berry
pushed a commit
to temporalio/cli
that referenced
this pull request
Oct 16, 2024
## What was changed - Updated `commands.yml` to address feedback on temporalio/documentation#3149 (comment) - Intended for use with the following, but also is fine to merge standalone - #691 - #692 See this branch for [the combined approach](https://github.com/prasek/temporal-cli/tree/cli-docs-gen-all) with all PRs merged in. ## Why? To create CLI docs for Nexus. ## Checklist 1. How was this tested: - `go run ./temporalcli/internal/cmd/gen-docs ` - also tested with [the combined appraoch](https://github.com/prasek/temporal-cli/tree/cli-docs-gen-all) - copied generated docs (or subset) to temporalio/documentation - `yarn start` - verified via http://localhost:3000/ Ran `go test ./...` Tested locally with: ``` go run ./cmd/temporal operator nexus endpoint create --name myendpoint --target-namespace my-target-namespace --target-task-queue my-handler-task-queue --description '## Sales Services Workflow'\''s to support Customer-to-Order generation. ## other stuff ' ``` 2. Any docs updates needed? - overall docs gen needs more alignment with the existing docs, but that is out of scope for these Nexus changes - will update temporalio/documentation#3149 with cherry picked generated content from [the combined approach](https://github.com/prasek/temporal-cli/tree/cli-docs-gen-all). --------- Signed-off-by: Phil Prasek <[email protected]> Signed-off-by: Josh Berry <[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
See related: