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.

Sign up for GitHub

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 "Creating a Flyte project" with link to new Dockerfile project template #5215

Merged
merged 2 commits into from
Apr 11, 2024
+6 −5
Merged

Update "Creating a Flyte project" with link to new Dockerfile project template #5215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95e0d72
update with link to dockerfile template
Apr 10, 2024
020a55f
fix 404 error
Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/getting_started_with_workflow_development/creating_a_flyte_project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ conda activate flyte-example

Next, initialize your Flyte project. The [flytekit-python-template GitHub repository](https://github.com/flyteorg/flytekit-python-template) contains Flyte project templates with sample code that you can run as is or modify to suit your needs.

In this example, we will initialize the [basic-example-imagespec project template](https://github.com/flyteorg/flytekit-python-template/tree/main/basic-example-imagespec).
In this example, we will initialize the [basic-template-imagespec project template](https://github.com/flyteorg/flytekit-python-template/tree/main/basic-template-imagespec).

```{prompt} bash $
pyflyte init my_project
```

:::{note}

To initialize a Flyte project with a different template, use the `--template` parameter:
If you need to use a Dockerfile for your project, you can initialize the Dockerfile template:

`pyflyte init --template hello-world hello-world`
`pyflyte init --template basic-template-dockerfile my_project`
:::

### 3. Install additional requirements
Expand Down
5 changes: 3 additions & 2 deletions docs/getting_started_with_workflow_development/flyte_project_components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(flyte_project_components)=
# Flyte project components

A Flyte project is a directory containing task and workflow code, internal Python source code, configuration files, and other artifacts required to package up your code so that it can be run on a Flyte cluster.
Expand Down Expand Up @@ -26,13 +27,13 @@ You can specify pip-installable Python dependencies in your project by adding th
`requirements.txt` file.

```{note}
We recommend using [pip-compile](https://pip-tools.readthedocs.io/en/latest/) to
We recommend using [pip-compile](https://pip-tools.readthedocs.io/en/stable/) to
manage your project's Python requirements.
```

````{dropdown} See requirements.txt
```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/simple-example/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt
```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/basic-template-imagespec/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt
:caption: requirements.txt
```
Expand Down
Loading