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

Improve README docs #311

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Conversation

andyczerwonka
Copy link
Contributor

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.

  • point to the latest version
  • fix typo's
  • add a note around registering workflows if you're running against the demo cluster

… 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]>
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It does not run the workflows, it simply registers them as far as I can tell.

Copy link

@davidmirror-ops davidmirror-ops left a comment

Choose a reason for hiding this comment

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

Thank you!

- [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)

Choose a reason for hiding this comment

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

I guess the master repo is now: https://github.com/flyteorg/flyte :)

@andresgomezfrr andresgomezfrr merged commit 5a95c82 into flyteorg:master Jul 30, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants