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

Update the Getting started docs to use pyflyte init #1801

Merged
merged 5 commits into from
Nov 11, 2021

Conversation

eapolinario
Copy link
Contributor

@eapolinario eapolinario commented Nov 5, 2021

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]

rsts/getting_started.rst Outdated Show resolved Hide resolved

.. prompt:: bash (venv)$

pip3 install flytekit --upgrade
git clone https://github.com/flyteorg/flytekit-python-template.git myflyteapp
pyflyte init myflyteapp
Copy link
Contributor

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?

Copy link
Contributor

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?

Copy link
Contributor Author

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?

Copy link
Contributor Author

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.

@eapolinario eapolinario merged commit 92b4db4 into master Nov 11, 2021
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.

2 participants