-
Notifications
You must be signed in to change notification settings - Fork 674
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
Update the Getting started docs to use pyflyte init
#1801
Conversation
Signed-off-by: Eduardo Apolinario <[email protected]>
|
||
.. prompt:: bash (venv)$ | ||
|
||
pip3 install flytekit --upgrade | ||
git clone https://github.com/flyteorg/flytekit-python-template.git myflyteapp | ||
pyflyte init myflyteapp |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
here is where we can add a comment saying, myflyteapp
or your own app name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we also say, it uses cookie-cutter underneath?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the paragraph right above mentions the choice of myflyteapp
. I'll make it more explicit that it's actually part of the invocation (and that the user is free to pick whatever name they want).
As for letting them know that it's using cookie-cutter, do you really think it's needed? From a beginner user perspective they shouldn't need to know that it uses this or that templating engine. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can trust that the users that want to know what's going on under the covers will find out about cookie-cutter from the cli itself:
❯ pyflyte init --help
...
Usage: pyflyte init [OPTIONS] PROJECT_NAME
Create flyte-ready projects.
Options:
--template TEXT cookiecutter template folder name to be used in the repo -
https://github.com/flyteorg/flytekit-python-template.git
--help Show this message and exit.
…d parameter Signed-off-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
This is the corresponding changes to the Getting Started docs in order to reflect the introduction of cookiecutter templates in flytekit.
This should only be merged after we cut the new
flytekit
release.The Getting started docs now look like: https://flyte--1801.org.readthedocs.build/en/1801/getting_started.html
Signed-off-by: Eduardo Apolinario [email protected]