Improve README docs #311
Merged
Improve README docs #311
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
… I'm trying to adjust the docs to help others with the struggles I'm having. - point to the latest version - fix typo's - add a note around registering workflows if you're running against the demo cluster Signed-off-by: Andy Czerwonka <[email protected]>
andyczerwonka
commented
Jul 10, 2024
Comment on lines
+66
to
+67
| **Note**: If you're registering against [the local Demo Flyte Cluster](https://docs.flyte.org/en/latest/user_guide/environment_setup.html#create-a-local-demo-flyte-cluster), you'll need to adjust the ports to align with it. | ||
|
|
There was a problem hiding this comment.
andyczerwonka
commented
Jul 10, 2024
| Package and run: | ||
| **Note**: If you're registering against [the local Demo Flyte Cluster](https://docs.flyte.org/en/latest/user_guide/environment_setup.html#create-a-local-demo-flyte-cluster), you'll need to adjust the ports to align with it. | ||
|
|
||
| Package and register: |
There was a problem hiding this comment.
It does not run the workflows, it simply registers them as far as I can tell.
davidmirror-ops
approved these changes
Jul 11, 2024
| - [Flyte homepage](https://flyte.org) | ||
| - [Flyte master repository](https://github.com/lyft/flyte) | ||
| - [Flyte homepage](https://flyte.org) | ||
| - [Flyte master repository](https://github.com/lyft/flyte) |
There was a problem hiding this comment.
I guess the master repo is now: https://github.com/flyteorg/flyte :)
andresgomezfrr
approved these changes
Jul 30, 2024
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.
As I go through trying to register the demo workflows using
jflyte, I'm trying to improve the docs to help others with the struggles I'm having.